blob: 24389939427b88b0ee5e8cbd3218404a23b3a3de [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},
Bram Moolenaarc0c2c262023-01-12 21:08:53 +0000142 {VV_NAME("t_class", VAR_NUMBER), NULL, VV_RO},
143 {VV_NAME("t_object", VAR_NUMBER), NULL, VV_RO},
Bram Moolenaard787e402021-12-24 21:36:12 +0000144 {VV_NAME("termrfgresp", VAR_STRING), NULL, VV_RO},
145 {VV_NAME("termrbgresp", VAR_STRING), NULL, VV_RO},
146 {VV_NAME("termu7resp", VAR_STRING), NULL, VV_RO},
147 {VV_NAME("termstyleresp", VAR_STRING), NULL, VV_RO},
148 {VV_NAME("termblinkresp", VAR_STRING), NULL, VV_RO},
149 {VV_NAME("event", VAR_DICT), NULL, VV_RO},
150 {VV_NAME("versionlong", VAR_NUMBER), NULL, VV_RO},
151 {VV_NAME("echospace", VAR_NUMBER), NULL, VV_RO},
152 {VV_NAME("argv", VAR_LIST), &t_list_string, VV_RO},
153 {VV_NAME("collate", VAR_STRING), NULL, VV_RO},
154 {VV_NAME("exiting", VAR_SPECIAL), NULL, VV_RO},
155 {VV_NAME("colornames", VAR_DICT), &t_dict_string, VV_RO},
156 {VV_NAME("sizeofint", VAR_NUMBER), NULL, VV_RO},
157 {VV_NAME("sizeoflong", VAR_NUMBER), NULL, VV_RO},
158 {VV_NAME("sizeofpointer", VAR_NUMBER), NULL, VV_RO},
naohiro ono56200ee2022-01-01 14:59:44 +0000159 {VV_NAME("maxcol", VAR_NUMBER), NULL, VV_RO},
Yee Cheng Chinc13b3d12023-08-20 21:18:38 +0200160 {VV_NAME("python3_version", VAR_NUMBER), NULL, VV_RO},
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200161};
162
163// shorthand
Bram Moolenaard787e402021-12-24 21:36:12 +0000164#define vv_tv_type vv_di.di_tv.v_type
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200165#define vv_nr vv_di.di_tv.vval.v_number
166#define vv_float vv_di.di_tv.vval.v_float
167#define vv_str vv_di.di_tv.vval.v_string
168#define vv_list vv_di.di_tv.vval.v_list
169#define vv_dict vv_di.di_tv.vval.v_dict
170#define vv_blob vv_di.di_tv.vval.v_blob
171#define vv_tv vv_di.di_tv
172
173static dictitem_T vimvars_var; // variable used for v:
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200174static dict_T vimvardict; // Dictionary with v: variables
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200175#define vimvarht vimvardict.dv_hashtab
176
177// for VIM_VERSION_ defines
178#include "version.h"
179
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200180static void list_glob_vars(int *first);
181static void list_buf_vars(int *first);
182static void list_win_vars(int *first);
183static void list_tab_vars(int *first);
184static char_u *list_arg_vars(exarg_T *eap, char_u *arg, int *first);
Bram Moolenaarf785aa12021-02-11 21:19:34 +0100185static 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 +0200186static int do_unlet_var(lval_T *lp, char_u *name_end, exarg_T *eap, int deep, void *cookie);
187static 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 +0200188static void list_one_var(dictitem_T *v, char *prefix, int *first);
189static void list_one_var_a(char *prefix, char_u *name, int type, char_u *string, int *first);
190
191/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200192 * Initialize global and vim special variables
193 */
194 void
195evalvars_init(void)
196{
197 int i;
198 struct vimvar *p;
199
200 init_var_dict(&globvardict, &globvars_var, VAR_DEF_SCOPE);
201 init_var_dict(&vimvardict, &vimvars_var, VAR_SCOPE);
202 vimvardict.dv_lock = VAR_FIXED;
203 hash_init(&compat_hashtab);
204
205 for (i = 0; i < VV_LEN; ++i)
206 {
207 p = &vimvars[i];
208 if (STRLEN(p->vv_name) > DICTITEM16_KEY_LEN)
209 {
Bram Moolenaar097c5372023-05-24 21:02:24 +0100210 iemsg("Name too long, increase size of dictitem16_T");
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200211 getout(1);
212 }
213 STRCPY(p->vv_di.di_key, p->vv_name);
214 if (p->vv_flags & VV_RO)
215 p->vv_di.di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
216 else if (p->vv_flags & VV_RO_SBX)
217 p->vv_di.di_flags = DI_FLAGS_RO_SBX | DI_FLAGS_FIX;
218 else
219 p->vv_di.di_flags = DI_FLAGS_FIX;
220
221 // add to v: scope dict, unless the value is not always available
Bram Moolenaard787e402021-12-24 21:36:12 +0000222 if (p->vv_tv_type != VAR_UNKNOWN)
Bram Moolenaaref2c3252022-11-25 16:31:51 +0000223 hash_add(&vimvarht, p->vv_di.di_key, "initialization");
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200224 if (p->vv_flags & VV_COMPAT)
225 // add to compat scope dict
Bram Moolenaaref2c3252022-11-25 16:31:51 +0000226 hash_add(&compat_hashtab, p->vv_di.di_key, "initialization");
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200227 }
Bram Moolenaar016faaa2020-10-03 12:57:27 +0200228 set_vim_var_nr(VV_VERSION, VIM_VERSION_100);
229 set_vim_var_nr(VV_VERSIONLONG, VIM_VERSION_100 * 10000 + highest_patch());
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200230
231 set_vim_var_nr(VV_SEARCHFORWARD, 1L);
232 set_vim_var_nr(VV_HLSEARCH, 1L);
Bram Moolenaarf0068c52020-11-30 17:42:10 +0100233 set_vim_var_nr(VV_EXITING, VVAL_NULL);
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200234 set_vim_var_dict(VV_COMPLETED_ITEM, dict_alloc_lock(VAR_FIXED));
235 set_vim_var_list(VV_ERRORS, list_alloc());
236 set_vim_var_dict(VV_EVENT, dict_alloc_lock(VAR_FIXED));
237
238 set_vim_var_nr(VV_FALSE, VVAL_FALSE);
239 set_vim_var_nr(VV_TRUE, VVAL_TRUE);
240 set_vim_var_nr(VV_NONE, VVAL_NONE);
241 set_vim_var_nr(VV_NULL, VVAL_NULL);
Bram Moolenaar57d5a012021-01-21 21:42:31 +0100242 set_vim_var_nr(VV_NUMBERMAX, VARNUM_MAX);
243 set_vim_var_nr(VV_NUMBERMIN, VARNUM_MIN);
Bram Moolenaarf9706e92020-02-22 14:27:04 +0100244 set_vim_var_nr(VV_NUMBERSIZE, sizeof(varnumber_T) * 8);
Bram Moolenaar69b30722021-11-02 21:39:49 +0000245 set_vim_var_nr(VV_SIZEOFINT, sizeof(int));
246 set_vim_var_nr(VV_SIZEOFLONG, sizeof(long));
247 set_vim_var_nr(VV_SIZEOFPOINTER, sizeof(char *));
naohiro ono56200ee2022-01-01 14:59:44 +0000248 set_vim_var_nr(VV_MAXCOL, MAXCOL);
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200249
250 set_vim_var_nr(VV_TYPE_NUMBER, VAR_TYPE_NUMBER);
251 set_vim_var_nr(VV_TYPE_STRING, VAR_TYPE_STRING);
252 set_vim_var_nr(VV_TYPE_FUNC, VAR_TYPE_FUNC);
253 set_vim_var_nr(VV_TYPE_LIST, VAR_TYPE_LIST);
254 set_vim_var_nr(VV_TYPE_DICT, VAR_TYPE_DICT);
255 set_vim_var_nr(VV_TYPE_FLOAT, VAR_TYPE_FLOAT);
256 set_vim_var_nr(VV_TYPE_BOOL, VAR_TYPE_BOOL);
257 set_vim_var_nr(VV_TYPE_NONE, VAR_TYPE_NONE);
258 set_vim_var_nr(VV_TYPE_JOB, VAR_TYPE_JOB);
259 set_vim_var_nr(VV_TYPE_CHANNEL, VAR_TYPE_CHANNEL);
260 set_vim_var_nr(VV_TYPE_BLOB, VAR_TYPE_BLOB);
Bram Moolenaarc0c2c262023-01-12 21:08:53 +0000261 set_vim_var_nr(VV_TYPE_CLASS, VAR_TYPE_CLASS);
262 set_vim_var_nr(VV_TYPE_OBJECT, VAR_TYPE_OBJECT);
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200263
264 set_vim_var_nr(VV_ECHOSPACE, sc_col - 1);
265
Drew Vogele30d1022021-10-24 20:35:07 +0100266 set_vim_var_dict(VV_COLORNAMES, dict_alloc());
267
Yee Cheng Chinc13b3d12023-08-20 21:18:38 +0200268#ifdef FEAT_PYTHON3
269 set_vim_var_nr(VV_PYTHON3_VERSION, python3_version());
270#endif
271
Bram Moolenaar439c0362020-06-06 15:58:03 +0200272 // Default for v:register is not 0 but '"'. This is adjusted once the
273 // clipboard has been setup by calling reset_reg_var().
274 set_reg_var(0);
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200275}
276
277#if defined(EXITFREE) || defined(PROTO)
278/*
279 * Free all vim variables information on exit
280 */
281 void
282evalvars_clear(void)
283{
284 int i;
285 struct vimvar *p;
286
287 for (i = 0; i < VV_LEN; ++i)
288 {
289 p = &vimvars[i];
290 if (p->vv_di.di_tv.v_type == VAR_STRING)
291 VIM_CLEAR(p->vv_str);
292 else if (p->vv_di.di_tv.v_type == VAR_LIST)
293 {
294 list_unref(p->vv_list);
295 p->vv_list = NULL;
296 }
297 }
298 hash_clear(&vimvarht);
299 hash_init(&vimvarht); // garbage_collect() will access it
300 hash_clear(&compat_hashtab);
301
302 // global variables
303 vars_clear(&globvarht);
304
Bram Moolenaar7ebcba62020-01-12 17:42:55 +0100305 // Script-local variables. Clear all the variables here.
306 // The scriptvar_T is cleared later in free_scriptnames(), because a
307 // variable in one script might hold a reference to the whole scope of
308 // another script.
309 for (i = 1; i <= script_items.ga_len; ++i)
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200310 vars_clear(&SCRIPT_VARS(i));
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200311}
312#endif
313
314 int
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200315garbage_collect_globvars(int copyID)
316{
317 return set_ref_in_ht(&globvarht, copyID, NULL);
318}
319
320 int
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200321garbage_collect_vimvars(int copyID)
322{
323 return set_ref_in_ht(&vimvarht, copyID, NULL);
324}
325
326 int
327garbage_collect_scriptvars(int copyID)
328{
Bram Moolenaared234f22020-10-15 20:42:20 +0200329 int i;
330 int idx;
331 int abort = FALSE;
332 scriptitem_T *si;
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200333
Bram Moolenaar7ebcba62020-01-12 17:42:55 +0100334 for (i = 1; i <= script_items.ga_len; ++i)
Bram Moolenaared234f22020-10-15 20:42:20 +0200335 {
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200336 abort = abort || set_ref_in_ht(&SCRIPT_VARS(i), copyID, NULL);
337
Bram Moolenaared234f22020-10-15 20:42:20 +0200338 si = SCRIPT_ITEM(i);
339 for (idx = 0; idx < si->sn_var_vals.ga_len; ++idx)
340 {
341 svar_T *sv = ((svar_T *)si->sn_var_vals.ga_data) + idx;
342
Bram Moolenaard00a7fb2021-03-08 20:47:14 +0100343 if (sv->sv_name != NULL)
344 abort = abort || set_ref_in_item(sv->sv_tv, copyID, NULL, NULL);
Bram Moolenaared234f22020-10-15 20:42:20 +0200345 }
346 }
347
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200348 return abort;
349}
350
351/*
352 * Set an internal variable to a string value. Creates the variable if it does
353 * not already exist.
354 */
355 void
356set_internal_string_var(char_u *name, char_u *value)
357{
358 char_u *val;
359 typval_T *tvp;
360
361 val = vim_strsave(value);
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +0000362 if (val == NULL)
363 return;
364
365 tvp = alloc_string_tv(val);
366 if (tvp == NULL)
367 return;
368
369 set_var(name, tvp, FALSE);
370 free_tv(tvp);
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200371}
372
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200373 int
374eval_charconvert(
375 char_u *enc_from,
376 char_u *enc_to,
377 char_u *fname_from,
378 char_u *fname_to)
379{
380 int err = FALSE;
Bram Moolenaarf4e88f22022-01-23 14:17:28 +0000381 sctx_T saved_sctx = current_sctx;
382 sctx_T *ctx;
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200383
384 set_vim_var_string(VV_CC_FROM, enc_from, -1);
385 set_vim_var_string(VV_CC_TO, enc_to, -1);
386 set_vim_var_string(VV_FNAME_IN, fname_from, -1);
387 set_vim_var_string(VV_FNAME_OUT, fname_to, -1);
Bram Moolenaarf4e88f22022-01-23 14:17:28 +0000388 ctx = get_option_sctx("charconvert");
389 if (ctx != NULL)
390 current_sctx = *ctx;
391
Bram Moolenaara4e0b972022-10-01 19:43:52 +0100392 if (eval_to_bool(p_ccv, &err, NULL, FALSE, TRUE))
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200393 err = TRUE;
Bram Moolenaarf4e88f22022-01-23 14:17:28 +0000394
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200395 set_vim_var_string(VV_CC_FROM, NULL, -1);
396 set_vim_var_string(VV_CC_TO, NULL, -1);
397 set_vim_var_string(VV_FNAME_IN, NULL, -1);
398 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
Bram Moolenaarf4e88f22022-01-23 14:17:28 +0000399 current_sctx = saved_sctx;
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200400
401 if (err)
402 return FAIL;
403 return OK;
404}
405
406# if defined(FEAT_POSTSCRIPT) || defined(PROTO)
407 int
408eval_printexpr(char_u *fname, char_u *args)
409{
410 int err = FALSE;
Bram Moolenaar7ef4a2f2022-01-23 13:44:35 +0000411 sctx_T saved_sctx = current_sctx;
412 sctx_T *ctx;
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200413
414 set_vim_var_string(VV_FNAME_IN, fname, -1);
415 set_vim_var_string(VV_CMDARG, args, -1);
Bram Moolenaar7ef4a2f2022-01-23 13:44:35 +0000416 ctx = get_option_sctx("printexpr");
417 if (ctx != NULL)
418 current_sctx = *ctx;
419
Bram Moolenaara4e0b972022-10-01 19:43:52 +0100420 if (eval_to_bool(p_pexpr, &err, NULL, FALSE, TRUE))
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200421 err = TRUE;
Bram Moolenaar7ef4a2f2022-01-23 13:44:35 +0000422
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200423 set_vim_var_string(VV_FNAME_IN, NULL, -1);
424 set_vim_var_string(VV_CMDARG, NULL, -1);
Bram Moolenaar7ef4a2f2022-01-23 13:44:35 +0000425 current_sctx = saved_sctx;
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200426
427 if (err)
428 {
429 mch_remove(fname);
430 return FAIL;
431 }
432 return OK;
433}
434# endif
435
436# if defined(FEAT_DIFF) || defined(PROTO)
437 void
438eval_diff(
439 char_u *origfile,
440 char_u *newfile,
441 char_u *outfile)
442{
Bram Moolenaar7b29f6a2022-01-22 17:58:13 +0000443 sctx_T saved_sctx = current_sctx;
444 sctx_T *ctx;
445 typval_T *tv;
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200446
447 set_vim_var_string(VV_FNAME_IN, origfile, -1);
448 set_vim_var_string(VV_FNAME_NEW, newfile, -1);
449 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
Bram Moolenaar7b29f6a2022-01-22 17:58:13 +0000450
451 ctx = get_option_sctx("diffexpr");
452 if (ctx != NULL)
453 current_sctx = *ctx;
454
455 // errors are ignored
Bram Moolenaara4e0b972022-10-01 19:43:52 +0100456 tv = eval_expr_ext(p_dex, NULL, TRUE);
Bram Moolenaar39b89442022-01-22 18:21:36 +0000457 free_tv(tv);
Bram Moolenaar7b29f6a2022-01-22 17:58:13 +0000458
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200459 set_vim_var_string(VV_FNAME_IN, NULL, -1);
460 set_vim_var_string(VV_FNAME_NEW, NULL, -1);
461 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
Bram Moolenaar7b29f6a2022-01-22 17:58:13 +0000462 current_sctx = saved_sctx;
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200463}
464
465 void
466eval_patch(
467 char_u *origfile,
468 char_u *difffile,
469 char_u *outfile)
470{
Bram Moolenaar36c2add2022-01-22 20:55:30 +0000471 sctx_T saved_sctx = current_sctx;
472 sctx_T *ctx;
473 typval_T *tv;
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200474
475 set_vim_var_string(VV_FNAME_IN, origfile, -1);
476 set_vim_var_string(VV_FNAME_DIFF, difffile, -1);
477 set_vim_var_string(VV_FNAME_OUT, outfile, -1);
Bram Moolenaar36c2add2022-01-22 20:55:30 +0000478
479 ctx = get_option_sctx("patchexpr");
480 if (ctx != NULL)
481 current_sctx = *ctx;
482
483 // errors are ignored
Bram Moolenaara4e0b972022-10-01 19:43:52 +0100484 tv = eval_expr_ext(p_pex, NULL, TRUE);
Bram Moolenaar36c2add2022-01-22 20:55:30 +0000485 free_tv(tv);
486
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200487 set_vim_var_string(VV_FNAME_IN, NULL, -1);
488 set_vim_var_string(VV_FNAME_DIFF, NULL, -1);
489 set_vim_var_string(VV_FNAME_OUT, NULL, -1);
Bram Moolenaar36c2add2022-01-22 20:55:30 +0000490 current_sctx = saved_sctx;
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200491}
492# endif
493
494#if defined(FEAT_SPELL) || defined(PROTO)
495/*
496 * Evaluate an expression to a list with suggestions.
497 * For the "expr:" part of 'spellsuggest'.
498 * Returns NULL when there is an error.
499 */
500 list_T *
501eval_spell_expr(char_u *badword, char_u *expr)
502{
503 typval_T save_val;
504 typval_T rettv;
505 list_T *list = NULL;
506 char_u *p = skipwhite(expr);
Bram Moolenaar2a7aa832022-01-23 17:59:06 +0000507 sctx_T saved_sctx = current_sctx;
508 sctx_T *ctx;
Bram Moolenaara4e0b972022-10-01 19:43:52 +0100509 int r;
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200510
511 // Set "v:val" to the bad word.
512 prepare_vimvar(VV_VAL, &save_val);
513 set_vim_var_string(VV_VAL, badword, -1);
514 if (p_verbose == 0)
515 ++emsg_off;
Bram Moolenaar2a7aa832022-01-23 17:59:06 +0000516 ctx = get_option_sctx("spellsuggest");
517 if (ctx != NULL)
518 current_sctx = *ctx;
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200519
Bram Moolenaara4e0b972022-10-01 19:43:52 +0100520 r = may_call_simple_func(p, &rettv);
521 if (r == NOTDONE)
522 r = eval1(&p, &rettv, &EVALARG_EVALUATE);
523 if (r == OK)
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200524 {
525 if (rettv.v_type != VAR_LIST)
526 clear_tv(&rettv);
527 else
528 list = rettv.vval.v_list;
529 }
530
531 if (p_verbose == 0)
532 --emsg_off;
533 clear_tv(get_vim_var_tv(VV_VAL));
534 restore_vimvar(VV_VAL, &save_val);
Bram Moolenaar2a7aa832022-01-23 17:59:06 +0000535 current_sctx = saved_sctx;
Bram Moolenaarda6c0332019-09-01 16:01:30 +0200536
537 return list;
538}
539
540/*
541 * "list" is supposed to contain two items: a word and a number. Return the
542 * word in "pp" and the number as the return value.
543 * Return -1 if anything isn't right.
544 * Used to get the good word and score from the eval_spell_expr() result.
545 */
546 int
547get_spellword(list_T *list, char_u **pp)
548{
549 listitem_T *li;
550
551 li = list->lv_first;
552 if (li == NULL)
553 return -1;
554 *pp = tv_get_string(&li->li_tv);
555
556 li = li->li_next;
557 if (li == NULL)
558 return -1;
559 return (int)tv_get_number(&li->li_tv);
560}
561#endif
562
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200563/*
564 * Prepare v: variable "idx" to be used.
Bram Moolenaar27da7de2019-09-03 17:13:37 +0200565 * Save the current typeval in "save_tv" and clear it.
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200566 * When not used yet add the variable to the v: hashtable.
567 */
568 void
569prepare_vimvar(int idx, typval_T *save_tv)
570{
571 *save_tv = vimvars[idx].vv_tv;
Bram Moolenaar27da7de2019-09-03 17:13:37 +0200572 vimvars[idx].vv_str = NULL; // don't free it now
Bram Moolenaard787e402021-12-24 21:36:12 +0000573 if (vimvars[idx].vv_tv_type == VAR_UNKNOWN)
Bram Moolenaaref2c3252022-11-25 16:31:51 +0000574 hash_add(&vimvarht, vimvars[idx].vv_di.di_key, "prepare vimvar");
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200575}
576
577/*
578 * Restore v: variable "idx" to typeval "save_tv".
Bram Moolenaar27da7de2019-09-03 17:13:37 +0200579 * Note that the v: variable must have been cleared already.
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200580 * When no longer defined, remove the variable from the v: hashtable.
581 */
582 void
583restore_vimvar(int idx, typval_T *save_tv)
584{
585 hashitem_T *hi;
586
587 vimvars[idx].vv_tv = *save_tv;
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +0000588 if (vimvars[idx].vv_tv_type != VAR_UNKNOWN)
589 return;
590
591 hi = hash_find(&vimvarht, vimvars[idx].vv_di.di_key);
592 if (HASHITEM_EMPTY(hi))
593 internal_error("restore_vimvar()");
594 else
595 hash_remove(&vimvarht, hi, "restore vimvar");
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200596}
597
598/*
599 * List Vim variables.
600 */
601 static void
602list_vim_vars(int *first)
603{
604 list_hashtable_vars(&vimvarht, "v:", FALSE, first);
605}
606
607/*
608 * List script-local variables, if there is a script.
609 */
610 static void
611list_script_vars(int *first)
612{
Bram Moolenaare3d46852020-08-29 13:39:17 +0200613 if (SCRIPT_ID_VALID(current_sctx.sc_sid))
Bram Moolenaare5cdf152019-08-29 22:09:46 +0200614 list_hashtable_vars(&SCRIPT_VARS(current_sctx.sc_sid),
615 "s:", FALSE, first);
616}
617
618/*
Bram Moolenaar9510d222022-09-11 15:14:05 +0100619 * Return TRUE if "name" starts with "g:", "w:", "t:" or "b:".
620 * But only when an identifier character follows.
621 */
622 int
623is_scoped_variable(char_u *name)
624{
625 return vim_strchr((char_u *)"gwbt", name[0]) != NULL
626 && name[1] == ':'
627 && eval_isnamec(name[2]);
628}
629
630/*
Bram Moolenaar0abc2872022-05-10 13:24:30 +0100631 * Evaluate one Vim expression {expr} in string "p" and append the
632 * resulting string to "gap". "p" points to the opening "{".
Bram Moolenaar70c41242022-05-10 18:11:43 +0100633 * When "evaluate" is FALSE only skip over the expression.
Bram Moolenaar0abc2872022-05-10 13:24:30 +0100634 * Return a pointer to the character after "}", NULL for an error.
635 */
636 char_u *
Bram Moolenaar70c41242022-05-10 18:11:43 +0100637eval_one_expr_in_str(char_u *p, garray_T *gap, int evaluate)
Bram Moolenaar0abc2872022-05-10 13:24:30 +0100638{
639 char_u *block_start = skipwhite(p + 1); // skip the opening {
640 char_u *block_end = block_start;
641 char_u *expr_val;
642
643 if (*block_start == NUL)
644 {
645 semsg(_(e_missing_close_curly_str), p);
646 return NULL;
647 }
648 if (skip_expr(&block_end, NULL) == FAIL)
649 return NULL;
650 block_end = skipwhite(block_end);
651 if (*block_end != '}')
652 {
653 semsg(_(e_missing_close_curly_str), p);
654 return NULL;
655 }
Bram Moolenaar70c41242022-05-10 18:11:43 +0100656 if (evaluate)
657 {
658 *block_end = NUL;
Bram Moolenaara4e0b972022-10-01 19:43:52 +0100659 expr_val = eval_to_string(block_start, TRUE, FALSE);
Bram Moolenaar70c41242022-05-10 18:11:43 +0100660 *block_end = '}';
661 if (expr_val == NULL)
662 return NULL;
663 ga_concat(gap, expr_val);
664 vim_free(expr_val);
665 }
Bram Moolenaar0abc2872022-05-10 13:24:30 +0100666
667 return block_end + 1;
668}
669
670/*
671 * Evaluate all the Vim expressions {expr} in "str" and return the resulting
672 * string in allocated memory. "{{" is reduced to "{" and "}}" to "}".
673 * Used for a heredoc assignment.
674 * Returns NULL for an error.
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100675 */
Yegappan Lakshmananee47eac2022-06-29 12:55:36 +0100676 static char_u *
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100677eval_all_expr_in_str(char_u *str)
678{
679 garray_T ga;
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100680 char_u *p;
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100681
682 ga_init2(&ga, 1, 80);
683 p = str;
684
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100685 while (*p != NUL)
686 {
LemonBoy2eaef102022-05-06 13:14:50 +0100687 char_u *lit_start;
LemonBoy2eaef102022-05-06 13:14:50 +0100688 int escaped_brace = FALSE;
689
690 // Look for a block start.
691 lit_start = p;
692 while (*p != '{' && *p != '}' && *p != NUL)
693 ++p;
694
695 if (*p != NUL && *p == p[1])
696 {
697 // Escaped brace, unescape and continue.
698 // Include the brace in the literal string.
699 ++p;
700 escaped_brace = TRUE;
701 }
702 else if (*p == '}')
703 {
704 semsg(_(e_stray_closing_curly_str), str);
705 ga_clear(&ga);
706 return NULL;
707 }
708
709 // Append the literal part.
710 ga_concat_len(&ga, lit_start, (size_t)(p - lit_start));
711
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100712 if (*p == NUL)
LemonBoy2eaef102022-05-06 13:14:50 +0100713 break;
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100714
LemonBoy2eaef102022-05-06 13:14:50 +0100715 if (escaped_brace)
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100716 {
LemonBoy2eaef102022-05-06 13:14:50 +0100717 // Skip the second brace.
718 ++p;
719 continue;
720 }
721
Bram Moolenaar0abc2872022-05-10 13:24:30 +0100722 // Evaluate the expression and append the result.
Bram Moolenaar70c41242022-05-10 18:11:43 +0100723 p = eval_one_expr_in_str(p, &ga, TRUE);
Bram Moolenaar0abc2872022-05-10 13:24:30 +0100724 if (p == NULL)
LemonBoy2eaef102022-05-06 13:14:50 +0100725 {
726 ga_clear(&ga);
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100727 return NULL;
728 }
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100729 }
730 ga_append(&ga, NUL);
731
732 return ga.ga_data;
733}
734
735/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200736 * Get a list of lines from a HERE document. The here document is a list of
737 * lines surrounded by a marker.
738 * cmd << {marker}
739 * {line1}
740 * {line2}
741 * ....
742 * {marker}
743 *
744 * The {marker} is a string. If the optional 'trim' word is supplied before the
745 * marker, then the leading indentation before the lines (matching the
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +0100746 * indentation in the "cmd" line) is stripped.
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +0200747 *
748 * When getting lines for an embedded script (e.g. python, lua, perl, ruby,
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +0100749 * tcl, mzscheme), "script_get" is set to TRUE. In this case, if the marker is
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +0200750 * missing, then '.' is accepted as a marker.
751 *
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +0100752 * When compiling a heredoc assignment to a variable in a Vim9 def function,
753 * "vim9compile" is set to TRUE. In this case, instead of generating a list of
754 * string values from the heredoc, vim9 instructions are generated. On success
755 * the returned list will be empty.
756 *
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100757 * Returns a List with {lines} or NULL on failure.
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200758 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100759 list_T *
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +0100760heredoc_get(exarg_T *eap, char_u *cmd, int script_get, int vim9compile)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200761{
Bram Moolenaar42ccb8d2022-04-18 15:45:23 +0100762 char_u *theline = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200763 char_u *marker;
764 list_T *l;
765 char_u *p;
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100766 char_u *str;
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200767 int marker_indent_len = 0;
768 int text_indent_len = 0;
769 char_u *text_indent = NULL;
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +0200770 char_u dot[] = ".";
Bram Moolenaarc0e29012020-09-27 14:22:48 +0200771 int comment_char = in_vim9script() ? '#' : '"';
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100772 int evalstr = FALSE;
773 int eval_failed = FALSE;
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +0100774 cctx_T *cctx = vim9compile ? eap->cookie : NULL;
775 int count = 0;
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200776
777 if (eap->getline == NULL)
778 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +0000779 emsg(_(e_cannot_use_heredoc_here));
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200780 return NULL;
781 }
782
783 // Check for the optional 'trim' word before the marker
784 cmd = skipwhite(cmd);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200785
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100786 while (TRUE)
787 {
788 if (STRNCMP(cmd, "trim", 4) == 0
789 && (cmd[4] == NUL || VIM_ISWHITE(cmd[4])))
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200790 {
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100791 cmd = skipwhite(cmd + 4);
792
793 // Trim the indentation from all the lines in the here document.
794 // The amount of indentation trimmed is the same as the indentation
795 // of the first line after the :let command line. To find the end
796 // marker the indent of the :let command line is trimmed.
797 p = *eap->cmdlinep;
798 while (VIM_ISWHITE(*p))
799 {
800 p++;
801 marker_indent_len++;
802 }
803 text_indent_len = -1;
804
805 continue;
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200806 }
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100807 if (STRNCMP(cmd, "eval", 4) == 0
808 && (cmd[4] == NUL || VIM_ISWHITE(cmd[4])))
809 {
810 cmd = skipwhite(cmd + 4);
811 evalstr = TRUE;
812 continue;
813 }
814 break;
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200815 }
816
817 // The marker is the next word.
Bram Moolenaarc0e29012020-09-27 14:22:48 +0200818 if (*cmd != NUL && *cmd != comment_char)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200819 {
820 marker = skipwhite(cmd);
821 p = skiptowhite(marker);
Bram Moolenaarc0e29012020-09-27 14:22:48 +0200822 if (*skipwhite(p) != NUL && *skipwhite(p) != comment_char)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200823 {
Bram Moolenaar74409f62022-01-01 15:58:22 +0000824 semsg(_(e_trailing_characters_str), p);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200825 return NULL;
826 }
827 *p = NUL;
Bram Moolenaar6ab09532020-05-01 14:10:13 +0200828 if (!script_get && vim_islower(*marker))
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200829 {
Bram Moolenaar6d057012021-12-31 18:49:43 +0000830 emsg(_(e_marker_cannot_start_with_lower_case_letter));
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200831 return NULL;
832 }
833 }
834 else
835 {
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +0200836 // When getting lines for an embedded script, if the marker is missing,
837 // accept '.' as the marker.
838 if (script_get)
839 marker = dot;
840 else
841 {
Bram Moolenaar1a992222021-12-31 17:25:48 +0000842 emsg(_(e_missing_marker));
Bram Moolenaar6c2b7b82020-04-14 20:15:49 +0200843 return NULL;
844 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200845 }
846
847 l = list_alloc();
848 if (l == NULL)
849 return NULL;
850
851 for (;;)
852 {
853 int mi = 0;
854 int ti = 0;
855
Bram Moolenaar42ccb8d2022-04-18 15:45:23 +0100856 vim_free(theline);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200857 theline = eap->getline(NUL, eap->cookie, 0, FALSE);
858 if (theline == NULL)
859 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +0000860 semsg(_(e_missing_end_marker_str), marker);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200861 break;
862 }
863
864 // with "trim": skip the indent matching the :let line to find the
865 // marker
866 if (marker_indent_len > 0
867 && STRNCMP(theline, *eap->cmdlinep, marker_indent_len) == 0)
868 mi = marker_indent_len;
869 if (STRCMP(marker, theline + mi) == 0)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200870 break;
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200871
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100872 // If expression evaluation failed in the heredoc, then skip till the
873 // end marker.
874 if (eval_failed)
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100875 continue;
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100876
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200877 if (text_indent_len == -1 && *theline != NUL)
878 {
879 // set the text indent from the first line.
880 p = theline;
881 text_indent_len = 0;
882 while (VIM_ISWHITE(*p))
883 {
884 p++;
885 text_indent_len++;
886 }
887 text_indent = vim_strnsave(theline, text_indent_len);
888 }
889 // with "trim": skip the indent matching the first line
890 if (text_indent != NULL)
891 for (ti = 0; ti < text_indent_len; ++ti)
892 if (theline[ti] != text_indent[ti])
893 break;
894
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100895 str = theline + ti;
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +0100896 if (vim9compile)
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100897 {
LemonBoy2eaef102022-05-06 13:14:50 +0100898 if (compile_all_expr_in_str(str, evalstr, cctx) == FAIL)
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100899 {
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +0100900 vim_free(theline);
901 vim_free(text_indent);
902 return FAIL;
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100903 }
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +0100904 count++;
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100905 }
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +0100906 else
907 {
Bram Moolenaar05c7f5d2022-04-28 16:51:41 +0100908 if (evalstr && !eap->skip)
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +0100909 {
910 str = eval_all_expr_in_str(str);
911 if (str == NULL)
912 {
913 // expression evaluation failed
914 eval_failed = TRUE;
915 continue;
916 }
917 vim_free(theline);
918 theline = str;
919 }
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100920
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +0100921 if (list_append_string(l, str, -1) == FAIL)
922 break;
923 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200924 }
Bram Moolenaar42ccb8d2022-04-18 15:45:23 +0100925 vim_free(theline);
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200926 vim_free(text_indent);
927
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +0100928 if (vim9compile && cctx->ctx_skip != SKIP_YES && !eval_failed)
929 generate_NEWLIST(cctx, count, FALSE);
930
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +0100931 if (eval_failed)
932 {
933 // expression evaluation in the heredoc failed
934 list_free(l);
935 return NULL;
936 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200937 return l;
938}
939
940/*
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200941 * Vim9 variable declaration:
942 * ":var name"
943 * ":var name: type"
944 * ":var name = expr"
945 * ":var name: type = expr"
946 * etc.
947 */
948 void
949ex_var(exarg_T *eap)
950{
Bram Moolenaar330a3882022-03-05 11:05:57 +0000951 char_u *p = eap->cmd;
Bram Moolenaare1d12112022-03-05 11:37:48 +0000952 int has_var;
Bram Moolenaar330a3882022-03-05 11:05:57 +0000953
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200954 if (!in_vim9script())
955 {
956 semsg(_(e_str_cannot_be_used_in_legacy_vim_script), ":var");
957 return;
958 }
Bram Moolenaare1d12112022-03-05 11:37:48 +0000959 has_var = checkforcmd_noparen(&p, "var", 3);
960 if (current_sctx.sc_sid == 0 && has_var)
Bram Moolenaar0e1574c2022-03-03 17:05:35 +0000961 {
962 emsg(_(e_cannot_declare_variable_on_command_line));
963 return;
964 }
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200965 ex_let(eap);
966}
967
968/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200969 * ":let" list all variable values
970 * ":let var1 var2" list variable values
971 * ":let var = expr" assignment command.
972 * ":let var += expr" assignment command.
973 * ":let var -= expr" assignment command.
974 * ":let var *= expr" assignment command.
975 * ":let var /= expr" assignment command.
976 * ":let var %= expr" assignment command.
977 * ":let var .= expr" assignment command.
978 * ":let var ..= expr" assignment command.
979 * ":let [var1, var2] = expr" unpack list.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100980 * ":let var =<< ..." heredoc
Bram Moolenaard672dde2020-02-26 13:43:51 +0100981 * ":let var: string" Vim9 declaration
Bram Moolenaar2eec3792020-05-25 20:33:55 +0200982 *
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200983 * ":final var = expr" assignment command.
984 * ":final [var1, var2] = expr" unpack list.
985 *
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200986 * ":const" list all variable values
987 * ":const var1 var2" list variable values
988 * ":const var = expr" assignment command.
989 * ":const [var1, var2] = expr" unpack list.
990 */
991 void
Bram Moolenaar2eec3792020-05-25 20:33:55 +0200992ex_let(exarg_T *eap)
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200993{
994 char_u *arg = eap->arg;
995 char_u *expr = NULL;
996 typval_T rettv;
Bram Moolenaar0522ba02019-08-27 22:48:30 +0200997 int var_count = 0;
998 int semicolon = 0;
Bram Moolenaar63be3d42020-07-23 13:11:37 +0200999 char_u op[4];
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001000 char_u *argend;
1001 int first = TRUE;
1002 int concat;
Bram Moolenaar32e35112020-05-14 22:41:15 +02001003 int has_assign;
Bram Moolenaar89b474d2020-12-22 21:19:39 +01001004 int flags = 0;
Bram Moolenaar63be3d42020-07-23 13:11:37 +02001005 int vim9script = in_vim9script();
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001006
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001007 if (eap->cmdidx == CMD_final && !vim9script)
1008 {
Bram Moolenaar89b474d2020-12-22 21:19:39 +01001009 // In legacy Vim script ":final" is short for ":finally".
1010 ex_finally(eap);
1011 return;
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001012 }
Bram Moolenaarc58f5452020-10-21 20:58:52 +02001013 if (eap->cmdidx == CMD_let && vim9script)
Bram Moolenaarcfcd0112020-09-27 15:19:27 +02001014 {
1015 emsg(_(e_cannot_use_let_in_vim9_script));
1016 return;
1017 }
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001018
Bram Moolenaar89b474d2020-12-22 21:19:39 +01001019 if (eap->cmdidx == CMD_const)
1020 flags |= ASSIGN_CONST;
1021 else if (eap->cmdidx == CMD_final)
1022 flags |= ASSIGN_FINAL;
1023
1024 // Vim9 assignment without ":let", ":const" or ":final"
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001025 if (eap->arg == eap->cmd)
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001026 flags |= ASSIGN_NO_DECL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001027
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001028 argend = skip_var_list(arg, TRUE, &var_count, &semicolon, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001029 if (argend == NULL)
1030 return;
1031 if (argend > arg && argend[-1] == '.') // for var.='str'
1032 --argend;
1033 expr = skipwhite(argend);
1034 concat = expr[0] == '.'
Bram Moolenaardd9de502021-08-15 13:49:42 +02001035 && ((expr[1] == '=' && in_old_script(2))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001036 || (expr[1] == '.' && expr[2] == '='));
Bram Moolenaar32e35112020-05-14 22:41:15 +02001037 has_assign = *expr == '=' || (vim_strchr((char_u *)"+-*/%", *expr) != NULL
1038 && expr[1] == '=');
Bram Moolenaar822ba242020-05-24 23:00:18 +02001039 if (!has_assign && !concat)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001040 {
1041 // ":let" without "=": list variables
1042 if (*arg == '[')
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001043 emsg(_(e_invalid_argument));
Bram Moolenaar63be3d42020-07-23 13:11:37 +02001044 else if (expr[0] == '.' && expr[1] == '=')
Bram Moolenaard82a47d2022-01-05 20:24:39 +00001045 emsg(_(e_dot_equal_not_supported_with_script_version_two));
Bram Moolenaarfaac4102020-04-20 17:46:14 +02001046 else if (!ends_excmd2(eap->cmd, arg))
Bram Moolenaarc82a5b52020-06-13 18:09:19 +02001047 {
Bram Moolenaar63be3d42020-07-23 13:11:37 +02001048 if (vim9script)
Bram Moolenaarc82a5b52020-06-13 18:09:19 +02001049 {
Bram Moolenaarccc25aa2021-03-26 21:27:52 +01001050 if (!ends_excmd2(eap->cmd, skipwhite(argend)))
Bram Moolenaar74409f62022-01-01 15:58:22 +00001051 semsg(_(e_trailing_characters_str), argend);
Bram Moolenaarccc25aa2021-03-26 21:27:52 +01001052 else
1053 // Vim9 declaration ":var name: type"
1054 arg = vim9_declare_scriptvar(eap, arg);
Bram Moolenaarc82a5b52020-06-13 18:09:19 +02001055 }
1056 else
1057 {
1058 // ":let var1 var2" - list values
1059 arg = list_arg_vars(eap, arg, &first);
1060 }
1061 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001062 else if (!eap->skip)
1063 {
1064 // ":let"
1065 list_glob_vars(&first);
1066 list_buf_vars(&first);
1067 list_win_vars(&first);
1068 list_tab_vars(&first);
1069 list_script_vars(&first);
1070 list_func_vars(&first);
1071 list_vim_vars(&first);
1072 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02001073 set_nextcmd(eap, arg);
zeertzjq474891b2023-04-12 21:36:03 +01001074 return;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001075 }
zeertzjq474891b2023-04-12 21:36:03 +01001076
1077 if (expr[0] == '=' && expr[1] == '<' && expr[2] == '<')
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001078 {
Bram Moolenaard9876422022-10-12 12:58:54 +01001079 list_T *l = NULL;
Bram Moolenaar81530e32021-07-28 21:25:49 +02001080 long cur_lnum = SOURCING_LNUM;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001081
Bram Moolenaard9876422022-10-12 12:58:54 +01001082 // :let text =<< [trim] [eval] END
1083 // :var text =<< [trim] [eval] END
1084 if (vim9script && !eap->skip && (!VIM_ISWHITE(expr[-1])
1085 || !IS_WHITE_OR_NUL(expr[3])))
1086 semsg(_(e_white_space_required_before_and_after_str_at_str),
1087 "=<<", expr);
1088 else
1089 l = heredoc_get(eap, expr + 3, FALSE, FALSE);
1090
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001091 if (l != NULL)
1092 {
1093 rettv_list_set(&rettv, l);
Bram Moolenaarb1ba9ab2019-10-16 23:34:42 +02001094 if (!eap->skip)
1095 {
Bram Moolenaar81530e32021-07-28 21:25:49 +02001096 // errors are for the assignment, not the end marker
1097 SOURCING_LNUM = cur_lnum;
Bram Moolenaarb1ba9ab2019-10-16 23:34:42 +02001098 op[0] = '=';
1099 op[1] = NUL;
1100 (void)ex_let_vars(eap->arg, &rettv, FALSE, semicolon, var_count,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001101 flags, op);
Bram Moolenaarb1ba9ab2019-10-16 23:34:42 +02001102 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001103 clear_tv(&rettv);
1104 }
zeertzjq474891b2023-04-12 21:36:03 +01001105 return;
1106 }
1107
1108 evalarg_T evalarg;
1109 int len = 1;
1110
1111 CLEAR_FIELD(rettv);
1112
1113 int cur_lnum;
1114
1115 op[0] = '=';
1116 op[1] = NUL;
1117 if (*expr != '=')
1118 {
1119 if (vim9script && (flags & ASSIGN_NO_DECL) == 0)
1120 {
1121 // +=, /=, etc. require an existing variable
1122 semsg(_(e_cannot_use_operator_on_new_variable_str), eap->arg);
1123 }
1124 else if (vim_strchr((char_u *)"+-*/%.", *expr) != NULL)
1125 {
1126 op[0] = *expr; // +=, -=, *=, /=, %= or .=
1127 ++len;
1128 if (expr[0] == '.' && expr[1] == '.') // ..=
1129 {
1130 ++expr;
1131 ++len;
1132 }
1133 }
1134 expr += 2;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001135 }
1136 else
zeertzjq474891b2023-04-12 21:36:03 +01001137 ++expr;
1138
1139 if (vim9script && !eap->skip && (!VIM_ISWHITE(*argend)
1140 || !IS_WHITE_OR_NUL(*expr)))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001141 {
zeertzjq474891b2023-04-12 21:36:03 +01001142 vim_strncpy(op, expr - len, len);
1143 semsg(_(e_white_space_required_before_and_after_str_at_str),
1144 op, argend);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001145 }
zeertzjq474891b2023-04-12 21:36:03 +01001146
1147 if (eap->skip)
1148 ++emsg_skip;
1149 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
1150 expr = skipwhite_and_linebreak(expr, &evalarg);
1151 cur_lnum = SOURCING_LNUM;
1152 int eval_res = eval0(expr, &rettv, eap, &evalarg);
1153 if (eap->skip)
1154 --emsg_skip;
1155 clear_evalarg(&evalarg, eap);
1156
1157 // Restore the line number so that any type error is given for the
1158 // declaration, not the expression.
1159 SOURCING_LNUM = cur_lnum;
1160
1161 if (!eap->skip && eval_res != FAIL)
1162 (void)ex_let_vars(eap->arg, &rettv, FALSE, semicolon, var_count,
1163 flags, op);
1164 if (eval_res != FAIL)
1165 clear_tv(&rettv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001166}
1167
1168/*
Bram Moolenaar6c3843c2021-03-04 12:38:21 +01001169 * Assign the typeval "tv" to the variable or variables at "arg_start".
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001170 * Handles both "var" with any type and "[var, var; var]" with a list type.
1171 * When "op" is not NULL it points to a string with characters that
1172 * must appear after the variable(s). Use "+", "-" or "." for add, subtract
1173 * or concatenate.
1174 * Returns OK or FAIL;
1175 */
1176 int
1177ex_let_vars(
1178 char_u *arg_start,
1179 typval_T *tv,
1180 int copy, // copy values from "tv", don't move
1181 int semicolon, // from skip_var_list()
1182 int var_count, // from skip_var_list()
Bram Moolenaar3862ea32021-01-01 21:05:55 +01001183 int flags, // ASSIGN_FINAL, ASSIGN_CONST, etc.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001184 char_u *op)
1185{
1186 char_u *arg = arg_start;
1187 list_T *l;
1188 int i;
Bram Moolenaarf785aa12021-02-11 21:19:34 +01001189 int var_idx = 0;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001190 listitem_T *item;
1191 typval_T ltv;
1192
Bram Moolenaar8acb9cc2022-03-08 13:18:55 +00001193 if (tv->v_type == VAR_VOID)
1194 {
1195 emsg(_(e_cannot_use_void_value));
1196 return FAIL;
1197 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001198 if (*arg != '[')
1199 {
1200 // ":let var = expr" or ":for var in list"
Bram Moolenaarf785aa12021-02-11 21:19:34 +01001201 if (ex_let_one(arg, tv, copy, flags, op, op, var_idx) == NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001202 return FAIL;
1203 return OK;
1204 }
1205
1206 // ":let [v1, v2] = list" or ":for [v1, v2] in listlist"
1207 if (tv->v_type != VAR_LIST || (l = tv->vval.v_list) == NULL)
1208 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00001209 emsg(_(e_list_required));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001210 return FAIL;
1211 }
1212
1213 i = list_len(l);
1214 if (semicolon == 0 && var_count < i)
1215 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00001216 emsg(_(e_less_targets_than_list_items));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001217 return FAIL;
1218 }
1219 if (var_count - semicolon > i)
1220 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00001221 emsg(_(e_more_targets_than_list_items));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001222 return FAIL;
1223 }
1224
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02001225 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001226 item = l->lv_first;
1227 while (*arg != ']')
1228 {
1229 arg = skipwhite(arg + 1);
Bram Moolenaarf785aa12021-02-11 21:19:34 +01001230 ++var_idx;
Bram Moolenaarf93bbd02021-04-10 22:35:43 +02001231 arg = ex_let_one(arg, &item->li_tv, TRUE,
1232 flags | ASSIGN_UNPACK, (char_u *)",;]", op, var_idx);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001233 item = item->li_next;
1234 if (arg == NULL)
1235 return FAIL;
1236
1237 arg = skipwhite(arg);
1238 if (*arg == ';')
1239 {
1240 // Put the rest of the list (may be empty) in the var after ';'.
1241 // Create a new list for this.
1242 l = list_alloc();
1243 if (l == NULL)
1244 return FAIL;
1245 while (item != NULL)
1246 {
1247 list_append_tv(l, &item->li_tv);
1248 item = item->li_next;
1249 }
1250
1251 ltv.v_type = VAR_LIST;
1252 ltv.v_lock = 0;
1253 ltv.vval.v_list = l;
1254 l->lv_refcount = 1;
Bram Moolenaarf785aa12021-02-11 21:19:34 +01001255 ++var_idx;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001256
Bram Moolenaarf93bbd02021-04-10 22:35:43 +02001257 arg = ex_let_one(skipwhite(arg + 1), &ltv, FALSE,
1258 flags | ASSIGN_UNPACK, (char_u *)"]", op, var_idx);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001259 clear_tv(&ltv);
1260 if (arg == NULL)
1261 return FAIL;
1262 break;
1263 }
1264 else if (*arg != ',' && *arg != ']')
1265 {
1266 internal_error("ex_let_vars()");
1267 return FAIL;
1268 }
1269 }
1270
1271 return OK;
1272}
1273
1274/*
1275 * Skip over assignable variable "var" or list of variables "[var, var]".
1276 * Used for ":let varvar = expr" and ":for varvar in expr".
1277 * For "[var, var]" increment "*var_count" for each variable.
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001278 * for "[var, var; var]" set "semicolon" to 1.
1279 * If "silent" is TRUE do not give an "invalid argument" error message.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001280 * Return NULL for an error.
1281 */
1282 char_u *
1283skip_var_list(
1284 char_u *arg,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001285 int include_type,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001286 int *var_count,
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001287 int *semicolon,
1288 int silent)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001289{
1290 char_u *p, *s;
1291
1292 if (*arg == '[')
1293 {
1294 // "[var, var]": find the matching ']'.
1295 p = arg;
1296 for (;;)
1297 {
1298 p = skipwhite(p + 1); // skip whites after '[', ';' or ','
Bram Moolenaar036d0712021-01-17 20:23:38 +01001299 s = skip_var_one(p, include_type);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001300 if (s == p)
1301 {
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001302 if (!silent)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001303 semsg(_(e_invalid_argument_str), p);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001304 return NULL;
1305 }
1306 ++*var_count;
1307
1308 p = skipwhite(s);
1309 if (*p == ']')
1310 break;
1311 else if (*p == ';')
1312 {
1313 if (*semicolon == 1)
1314 {
Bram Moolenaar8b716f52022-02-15 21:17:56 +00001315 if (!silent)
1316 emsg(_(e_double_semicolon_in_list_of_variables));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001317 return NULL;
1318 }
1319 *semicolon = 1;
1320 }
1321 else if (*p != ',')
1322 {
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001323 if (!silent)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001324 semsg(_(e_invalid_argument_str), p);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001325 return NULL;
1326 }
1327 }
1328 return p + 1;
1329 }
Bram Moolenaar6c4d4a62022-10-13 17:47:42 +01001330
Bram Moolenaare8e369a2022-09-21 18:59:14 +01001331 return skip_var_one(arg, include_type);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001332}
1333
1334/*
1335 * Skip one (assignable) variable name, including @r, $VAR, &option, d.key,
1336 * l[idx].
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001337 * In Vim9 script also skip over ": type" if "include_type" is TRUE.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001338 */
Bram Moolenaar47a519a2020-06-14 23:05:10 +02001339 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001340skip_var_one(char_u *arg, int include_type)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001341{
Bram Moolenaar585587d2021-01-17 20:52:13 +01001342 char_u *end;
1343 int vim9 = in_vim9script();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001344
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001345 if (*arg == '@' && arg[1] != NUL)
1346 return arg + 2;
Bram Moolenaar1573e732022-11-16 20:33:21 +00001347
1348 // termcap option name may have non-alpha characters
1349 if (STRNCMP(arg, "&t_", 3) == 0 && arg[3] != NUL && arg[4] != NUL)
1350 return arg + 5;
1351
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001352 end = find_name_end(*arg == '$' || *arg == '&' ? arg + 1 : arg,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001353 NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
Bram Moolenaar036d0712021-01-17 20:23:38 +01001354
1355 // "a: type" is declaring variable "a" with a type, not "a:".
1356 // Same for "s: type".
Bram Moolenaar585587d2021-01-17 20:52:13 +01001357 if (vim9 && end == arg + 2 && end[-1] == ':')
Bram Moolenaar036d0712021-01-17 20:23:38 +01001358 --end;
1359
Bram Moolenaar585587d2021-01-17 20:52:13 +01001360 if (include_type && vim9)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001361 {
Bram Moolenaarce93d162023-01-30 21:12:34 +00001362 if (*skipwhite(end) == ':')
1363 end = skip_type(skipwhite(skipwhite(end) + 1), FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001364 }
1365 return end;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001366}
1367
1368/*
1369 * List variables for hashtab "ht" with prefix "prefix".
1370 * If "empty" is TRUE also list NULL strings as empty strings.
1371 */
1372 void
1373list_hashtable_vars(
1374 hashtab_T *ht,
1375 char *prefix,
1376 int empty,
1377 int *first)
1378{
1379 hashitem_T *hi;
1380 dictitem_T *di;
1381 int todo;
1382 char_u buf[IOSIZE];
1383
Bram Moolenaaref2c3252022-11-25 16:31:51 +00001384 int save_ht_flags = ht->ht_flags;
1385 ht->ht_flags |= HTFLAGS_FROZEN;
1386
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001387 todo = (int)ht->ht_used;
1388 for (hi = ht->ht_array; todo > 0 && !got_int; ++hi)
1389 {
1390 if (!HASHITEM_EMPTY(hi))
1391 {
1392 --todo;
1393 di = HI2DI(hi);
1394
1395 // apply :filter /pat/ to variable name
1396 vim_strncpy((char_u *)buf, (char_u *)prefix, IOSIZE - 1);
1397 vim_strcat((char_u *)buf, di->di_key, IOSIZE);
1398 if (message_filtered(buf))
1399 continue;
1400
1401 if (empty || di->di_tv.v_type != VAR_STRING
1402 || di->di_tv.vval.v_string != NULL)
1403 list_one_var(di, prefix, first);
1404 }
1405 }
Bram Moolenaaref2c3252022-11-25 16:31:51 +00001406
1407 ht->ht_flags = save_ht_flags;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001408}
1409
1410/*
1411 * List global variables.
1412 */
1413 static void
1414list_glob_vars(int *first)
1415{
1416 list_hashtable_vars(&globvarht, "", TRUE, first);
1417}
1418
1419/*
1420 * List buffer variables.
1421 */
1422 static void
1423list_buf_vars(int *first)
1424{
1425 list_hashtable_vars(&curbuf->b_vars->dv_hashtab, "b:", TRUE, first);
1426}
1427
1428/*
1429 * List window variables.
1430 */
1431 static void
1432list_win_vars(int *first)
1433{
1434 list_hashtable_vars(&curwin->w_vars->dv_hashtab, "w:", TRUE, first);
1435}
1436
1437/*
1438 * List tab page variables.
1439 */
1440 static void
1441list_tab_vars(int *first)
1442{
1443 list_hashtable_vars(&curtab->tp_vars->dv_hashtab, "t:", TRUE, first);
1444}
1445
1446/*
1447 * List variables in "arg".
1448 */
1449 static char_u *
1450list_arg_vars(exarg_T *eap, char_u *arg, int *first)
1451{
1452 int error = FALSE;
1453 int len;
1454 char_u *name;
1455 char_u *name_start;
1456 char_u *arg_subsc;
1457 char_u *tofree;
1458 typval_T tv;
1459
Bram Moolenaarfaac4102020-04-20 17:46:14 +02001460 while (!ends_excmd2(eap->cmd, arg) && !got_int)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001461 {
1462 if (error || eap->skip)
1463 {
1464 arg = find_name_end(arg, NULL, NULL, FNE_INCL_BR | FNE_CHECK_START);
1465 if (!VIM_ISWHITE(*arg) && !ends_excmd(*arg))
1466 {
1467 emsg_severe = TRUE;
Bram Moolenaar4830c212021-08-14 14:59:27 +02001468 if (!did_emsg)
Bram Moolenaar74409f62022-01-01 15:58:22 +00001469 semsg(_(e_trailing_characters_str), arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001470 break;
1471 }
1472 }
1473 else
1474 {
1475 // get_name_len() takes care of expanding curly braces
1476 name_start = name = arg;
1477 len = get_name_len(&arg, &tofree, TRUE, TRUE);
1478 if (len <= 0)
1479 {
1480 // This is mainly to keep test 49 working: when expanding
1481 // curly braces fails overrule the exception error message.
1482 if (len < 0 && !aborting())
1483 {
1484 emsg_severe = TRUE;
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001485 semsg(_(e_invalid_argument_str), arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001486 break;
1487 }
1488 error = TRUE;
1489 }
1490 else
1491 {
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02001492 arg = skipwhite(arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001493 if (tofree != NULL)
1494 name = tofree;
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001495 if (eval_variable(name, len, 0, &tv, NULL,
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01001496 EVAL_VAR_VERBOSE) == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001497 error = TRUE;
1498 else
1499 {
1500 // handle d.key, l[idx], f(expr)
1501 arg_subsc = arg;
Bram Moolenaar32884ad2022-01-07 12:45:29 +00001502 if (handle_subscript(&arg, name_start, &tv,
1503 &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001504 error = TRUE;
1505 else
1506 {
1507 if (arg == arg_subsc && len == 2 && name[1] == ':')
1508 {
1509 switch (*name)
1510 {
1511 case 'g': list_glob_vars(first); break;
1512 case 'b': list_buf_vars(first); break;
1513 case 'w': list_win_vars(first); break;
1514 case 't': list_tab_vars(first); break;
1515 case 'v': list_vim_vars(first); break;
1516 case 's': list_script_vars(first); break;
1517 case 'l': list_func_vars(first); break;
1518 default:
Bram Moolenaara6f79292022-01-04 21:30:47 +00001519 semsg(_(e_cant_list_variables_for_str), name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001520 }
1521 }
1522 else
1523 {
1524 char_u numbuf[NUMBUFLEN];
1525 char_u *tf;
1526 int c;
1527 char_u *s;
1528
1529 s = echo_string(&tv, &tf, numbuf, 0);
1530 c = *arg;
1531 *arg = NUL;
1532 list_one_var_a("",
1533 arg == arg_subsc ? name : name_start,
1534 tv.v_type,
1535 s == NULL ? (char_u *)"" : s,
1536 first);
1537 *arg = c;
1538 vim_free(tf);
1539 }
1540 clear_tv(&tv);
1541 }
1542 }
1543 }
1544
1545 vim_free(tofree);
1546 }
1547
1548 arg = skipwhite(arg);
1549 }
1550
1551 return arg;
1552}
1553
1554/*
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001555 * Set an environment variable, part of ex_let_one().
1556 */
1557 static char_u *
1558ex_let_env(
1559 char_u *arg,
1560 typval_T *tv,
1561 int flags,
1562 char_u *endchars,
1563 char_u *op)
1564{
1565 char_u *arg_end = NULL;
1566 char_u *name;
1567 int len;
1568
1569 if ((flags & (ASSIGN_CONST | ASSIGN_FINAL))
1570 && (flags & ASSIGN_FOR_LOOP) == 0)
1571 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00001572 emsg(_(e_cannot_lock_environment_variable));
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001573 return NULL;
1574 }
1575
1576 // Find the end of the name.
1577 ++arg;
1578 name = arg;
1579 len = get_env_len(&arg);
1580 if (len == 0)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001581 semsg(_(e_invalid_argument_str), name - 1);
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001582 else
1583 {
1584 if (op != NULL && vim_strchr((char_u *)"+-*/%", *op) != NULL)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00001585 semsg(_(e_wrong_variable_type_for_str_equal), op);
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001586 else if (endchars != NULL
1587 && vim_strchr(endchars, *skipwhite(arg)) == NULL)
1588 emsg(_(e_unexpected_characters_in_let));
1589 else if (!check_secure())
1590 {
1591 char_u *tofree = NULL;
1592 int c1 = name[len];
1593 char_u *p;
1594
1595 name[len] = NUL;
1596 p = tv_get_string_chk(tv);
1597 if (p != NULL && op != NULL && *op == '.')
1598 {
1599 int mustfree = FALSE;
1600 char_u *s = vim_getenv(name, &mustfree);
1601
1602 if (s != NULL)
1603 {
1604 p = tofree = concat_str(s, p);
1605 if (mustfree)
1606 vim_free(s);
1607 }
1608 }
1609 if (p != NULL)
1610 {
1611 vim_setenv_ext(name, p);
1612 arg_end = arg;
1613 }
1614 name[len] = c1;
1615 vim_free(tofree);
1616 }
1617 }
1618 return arg_end;
1619}
1620
1621/*
1622 * Set an option, part of ex_let_one().
1623 */
1624 static char_u *
1625ex_let_option(
1626 char_u *arg,
1627 typval_T *tv,
1628 int flags,
1629 char_u *endchars,
1630 char_u *op)
1631{
1632 char_u *p;
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001633 int scope;
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001634 char_u *arg_end = NULL;
1635
1636 if ((flags & (ASSIGN_CONST | ASSIGN_FINAL))
1637 && (flags & ASSIGN_FOR_LOOP) == 0)
1638 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00001639 emsg(_(e_cannot_lock_option));
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001640 return NULL;
1641 }
1642
1643 // Find the end of the name.
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001644 p = find_option_end(&arg, &scope);
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001645 if (p == NULL || (endchars != NULL
1646 && vim_strchr(endchars, *skipwhite(p)) == NULL))
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001647 {
zeertzjq4c7cb372023-06-14 16:39:54 +01001648 emsg(_(e_unexpected_characters_in_let));
1649 return NULL;
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001650 }
zeertzjq4c7cb372023-06-14 16:39:54 +01001651
1652 int c1;
1653 long n = 0;
1654 getoption_T opt_type;
1655 long numval;
1656 char_u *stringval = NULL;
1657 char_u *s = NULL;
1658 int failed = FALSE;
1659 int opt_p_flags;
1660 char_u *tofree = NULL;
1661 char_u numbuf[NUMBUFLEN];
1662
1663 c1 = *p;
1664 *p = NUL;
1665
1666 opt_type = get_option_value(arg, &numval, &stringval, &opt_p_flags, scope);
1667 if (opt_type == gov_unknown && arg[0] != 't' && arg[1] != '_')
1668 {
1669 semsg(_(e_unknown_option_str_2), arg);
1670 goto theend;
1671 }
1672 if (op != NULL && *op != '='
1673 && (((opt_type == gov_bool || opt_type == gov_number) && *op == '.')
1674 || (opt_type == gov_string && *op != '.')))
1675 {
1676 semsg(_(e_wrong_variable_type_for_str_equal), op);
1677 goto theend;
1678 }
1679
1680 if ((opt_type == gov_bool
1681 || opt_type == gov_number
1682 || opt_type == gov_hidden_bool
1683 || opt_type == gov_hidden_number)
1684 && (tv->v_type != VAR_STRING || !in_vim9script()))
1685 {
1686 if (opt_type == gov_bool || opt_type == gov_hidden_bool)
1687 // bool, possibly hidden
1688 n = (long)tv_get_bool_chk(tv, &failed);
1689 else
1690 // number, possibly hidden
1691 n = (long)tv_get_number_chk(tv, &failed);
1692 if (failed)
1693 goto theend;
1694 }
1695
1696 if ((opt_p_flags & P_FUNC) && (tv->v_type == VAR_PARTIAL
1697 || tv->v_type == VAR_FUNC))
1698 {
1699 // If the option can be set to a function reference or a lambda
1700 // and the passed value is a function reference, then convert it to
1701 // the name (string) of the function reference.
1702 s = tv2string(tv, &tofree, numbuf, 0);
1703 if (s == NULL)
1704 goto theend;
1705 }
1706 // Avoid setting a string option to the text "v:false" or similar.
1707 // In Vim9 script also don't convert a number to string.
1708 else if (tv->v_type != VAR_BOOL && tv->v_type != VAR_SPECIAL
1709 && (!in_vim9script() || tv->v_type != VAR_NUMBER))
1710 {
1711 s = tv_get_string_chk(tv);
1712 if (s == NULL)
1713 goto theend;
1714 }
1715 else if (opt_type == gov_string || opt_type == gov_hidden_string)
1716 {
1717 emsg(_(e_string_required));
1718 goto theend;
1719 }
1720
1721 if (op != NULL && *op != '=')
1722 {
1723 // number, in legacy script also bool
1724 if (opt_type == gov_number
1725 || (opt_type == gov_bool && !in_vim9script()))
1726 {
1727 switch (*op)
1728 {
1729 case '+': n = numval + n; break;
1730 case '-': n = numval - n; break;
1731 case '*': n = numval * n; break;
1732 case '/': n = (long)num_divide(numval, n, &failed); break;
1733 case '%': n = (long)num_modulus(numval, n, &failed); break;
1734 }
1735 s = NULL;
1736 if (failed)
1737 goto theend;
1738 }
1739 else if (opt_type == gov_string && stringval != NULL && s != NULL)
1740 {
1741 // string
1742 s = concat_str(stringval, s);
1743 vim_free(stringval);
1744 stringval = s;
1745 }
1746 }
1747
1748 char *err = set_option_value(arg, n, s, scope);
1749 arg_end = p;
1750 if (err != NULL)
1751 emsg(_(err));
1752
1753theend:
1754 *p = c1;
1755 vim_free(stringval);
1756 vim_free(tofree);
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001757 return arg_end;
1758}
1759
1760/*
1761 * Set a register, part of ex_let_one().
1762 */
1763 static char_u *
1764ex_let_register(
1765 char_u *arg,
1766 typval_T *tv,
1767 int flags,
1768 char_u *endchars,
1769 char_u *op)
1770{
1771 char_u *arg_end = NULL;
1772
1773 if ((flags & (ASSIGN_CONST | ASSIGN_FINAL))
1774 && (flags & ASSIGN_FOR_LOOP) == 0)
1775 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00001776 emsg(_(e_cannot_lock_register));
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001777 return NULL;
1778 }
1779 ++arg;
1780 if (op != NULL && vim_strchr((char_u *)"+-*/%", *op) != NULL)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00001781 semsg(_(e_wrong_variable_type_for_str_equal), op);
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001782 else if (endchars != NULL
1783 && vim_strchr(endchars, *skipwhite(arg + 1)) == NULL)
1784 emsg(_(e_unexpected_characters_in_let));
1785 else
1786 {
1787 char_u *ptofree = NULL;
1788 char_u *p;
1789
1790 p = tv_get_string_chk(tv);
1791 if (p != NULL && op != NULL && *op == '.')
1792 {
1793 char_u *s = get_reg_contents(*arg == '@'
1794 ? '"' : *arg, GREG_EXPR_SRC);
1795
1796 if (s != NULL)
1797 {
1798 p = ptofree = concat_str(s, p);
1799 vim_free(s);
1800 }
1801 }
1802 if (p != NULL)
1803 {
1804 write_reg_contents(*arg == '@' ? '"' : *arg, p, -1, FALSE);
1805 arg_end = arg + 1;
1806 }
1807 vim_free(ptofree);
1808 }
1809 return arg_end;
1810}
1811
1812/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001813 * Set one item of ":let var = expr" or ":let [v1, v2] = list" to its value.
1814 * Returns a pointer to the char just after the var name.
1815 * Returns NULL if there is an error.
1816 */
1817 static char_u *
1818ex_let_one(
1819 char_u *arg, // points to variable name
1820 typval_T *tv, // value to assign to variable
1821 int copy, // copy value from "tv"
Bram Moolenaar3862ea32021-01-01 21:05:55 +01001822 int flags, // ASSIGN_CONST, ASSIGN_FINAL, etc.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001823 char_u *endchars, // valid chars after variable name or NULL
Bram Moolenaarf785aa12021-02-11 21:19:34 +01001824 char_u *op, // "+", "-", "." or NULL
1825 int var_idx) // variable index for "let [a, b] = list"
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001826{
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001827 char_u *arg_end = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001828
Bram Moolenaar3862ea32021-01-01 21:05:55 +01001829 if (in_vim9script() && (flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0
Bram Moolenaar89b474d2020-12-22 21:19:39 +01001830 && (flags & (ASSIGN_CONST | ASSIGN_FINAL)) == 0
Bram Moolenaarc2ee44c2020-08-02 16:59:00 +02001831 && vim_strchr((char_u *)"$@&", *arg) != NULL)
1832 {
1833 vim9_declare_error(arg);
1834 return NULL;
1835 }
1836
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001837 if (*arg == '$')
1838 {
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001839 // ":let $VAR = expr": Set environment variable.
1840 return ex_let_env(arg, tv, flags, endchars, op);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001841 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001842 else if (*arg == '&')
1843 {
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001844 // ":let &option = expr": Set option value.
1845 // ":let &l:option = expr": Set local option value.
1846 // ":let &g:option = expr": Set global option value.
1847 // ":for &ts in range(8)": Set option value for for loop
1848 return ex_let_option(arg, tv, flags, endchars, op);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001849 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001850 else if (*arg == '@')
1851 {
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001852 // ":let @r = expr": Set register contents.
1853 return ex_let_register(arg, tv, flags, endchars, op);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001854 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001855 else if (eval_isnamec1(*arg) || *arg == '{')
1856 {
1857 lval_T lv;
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001858 char_u *p;
Bram Moolenaar22ebd172022-04-01 15:26:58 +01001859 int lval_flags = (flags & (ASSIGN_NO_DECL | ASSIGN_DECL))
1860 ? GLV_NO_DECL : 0;
1861 if (op != NULL && *op != '=')
1862 lval_flags |= GLV_ASSIGN_WITH_OP;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001863
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001864 // ":let var = expr": Set internal variable.
1865 // ":let var: type = expr": Set internal variable with type.
1866 // ":let {expr} = expr": Idem, name made with curly braces
Bram Moolenaar22ebd172022-04-01 15:26:58 +01001867 p = get_lval(arg, tv, &lv, FALSE, FALSE, lval_flags, FNE_CHECK_START);
Bram Moolenaar822ba242020-05-24 23:00:18 +02001868 if (p != NULL && lv.ll_name != NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001869 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001870 if (endchars != NULL && vim_strchr(endchars,
1871 *skipwhite(lv.ll_name_end)) == NULL)
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001872 {
Bram Moolenaar108010a2021-06-27 22:03:33 +02001873 emsg(_(e_unexpected_characters_in_let));
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001874 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001875 else
1876 {
Bram Moolenaarf785aa12021-02-11 21:19:34 +01001877 set_var_lval(&lv, p, tv, copy, flags, op, var_idx);
Bram Moolenaara3589a02021-04-14 13:30:46 +02001878 arg_end = lv.ll_name_end;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001879 }
1880 }
1881 clear_lval(&lv);
1882 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001883 else
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001884 semsg(_(e_invalid_argument_str), arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001885
1886 return arg_end;
1887}
1888
1889/*
1890 * ":unlet[!] var1 ... " command.
1891 */
1892 void
1893ex_unlet(exarg_T *eap)
1894{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001895 ex_unletlock(eap, eap->arg, 0, 0, do_unlet_var, NULL);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001896}
1897
1898/*
1899 * ":lockvar" and ":unlockvar" commands
1900 */
1901 void
1902ex_lockvar(exarg_T *eap)
1903{
1904 char_u *arg = eap->arg;
1905 int deep = 2;
1906
1907 if (eap->forceit)
1908 deep = -1;
1909 else if (vim_isdigit(*arg))
1910 {
1911 deep = getdigits(&arg);
1912 arg = skipwhite(arg);
1913 }
1914
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001915 ex_unletlock(eap, arg, deep, 0, do_lock_var, NULL);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001916}
1917
1918/*
1919 * ":unlet", ":lockvar" and ":unlockvar" are quite similar.
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001920 * Also used for Vim9 script. "callback" is invoked as:
1921 * callback(&lv, name_end, eap, deep, cookie)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001922 */
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001923 void
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001924ex_unletlock(
1925 exarg_T *eap,
1926 char_u *argstart,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001927 int deep,
1928 int glv_flags,
1929 int (*callback)(lval_T *, char_u *, exarg_T *, int, void *),
1930 void *cookie)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001931{
1932 char_u *arg = argstart;
1933 char_u *name_end;
1934 int error = FALSE;
1935 lval_T lv;
1936
1937 do
1938 {
1939 if (*arg == '$')
1940 {
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001941 lv.ll_name = arg;
1942 lv.ll_tv = NULL;
1943 ++arg;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001944 if (get_env_len(&arg) == 0)
1945 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001946 semsg(_(e_invalid_argument_str), arg - 1);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001947 return;
1948 }
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001949 if (!error && !eap->skip
1950 && callback(&lv, arg, eap, deep, cookie) == FAIL)
1951 error = TRUE;
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001952 name_end = arg;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001953 }
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001954 else
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001955 {
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001956 // Parse the name and find the end.
1957 name_end = get_lval(arg, NULL, &lv, TRUE, eap->skip || error,
Bram Moolenaarc3689572021-01-01 19:40:02 +01001958 glv_flags | GLV_NO_DECL, FNE_CHECK_START);
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001959 if (lv.ll_name == NULL)
1960 error = TRUE; // error but continue parsing
1961 if (name_end == NULL || (!VIM_ISWHITE(*name_end)
1962 && !ends_excmd(*name_end)))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001963 {
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001964 if (name_end != NULL)
1965 {
1966 emsg_severe = TRUE;
Bram Moolenaar74409f62022-01-01 15:58:22 +00001967 semsg(_(e_trailing_characters_str), name_end);
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001968 }
1969 if (!(eap->skip || error))
1970 clear_lval(&lv);
1971 break;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001972 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001973
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001974 if (!error && !eap->skip
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001975 && callback(&lv, name_end, eap, deep, cookie) == FAIL)
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001976 error = TRUE;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001977
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001978 if (!eap->skip)
1979 clear_lval(&lv);
1980 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001981
1982 arg = skipwhite(name_end);
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001983 } while (!ends_excmd2(name_end, arg));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001984
Bram Moolenaar63b91732021-08-05 20:40:03 +02001985 set_nextcmd(eap, arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001986}
1987
1988 static int
1989do_unlet_var(
1990 lval_T *lp,
1991 char_u *name_end,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001992 exarg_T *eap,
1993 int deep UNUSED,
1994 void *cookie UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001995{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001996 int forceit = eap->forceit;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001997 int ret = OK;
1998 int cc;
1999
2000 if (lp->ll_tv == NULL)
2001 {
2002 cc = *name_end;
2003 *name_end = NUL;
2004
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002005 // Environment variable, normal name or expanded name.
2006 if (*lp->ll_name == '$')
LemonBoy77142312022-04-15 20:50:46 +01002007 vim_unsetenv_ext(lp->ll_name + 1);
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002008 else if (do_unlet(lp->ll_name, forceit) == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002009 ret = FAIL;
2010 *name_end = cc;
2011 }
2012 else if ((lp->ll_list != NULL
Bram Moolenaara187c432020-09-16 21:08:28 +02002013 && value_check_lock(lp->ll_list->lv_lock, lp->ll_name, FALSE))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002014 || (lp->ll_dict != NULL
Bram Moolenaara187c432020-09-16 21:08:28 +02002015 && value_check_lock(lp->ll_dict->dv_lock, lp->ll_name, FALSE)))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002016 return FAIL;
2017 else if (lp->ll_range)
Bram Moolenaar6b8c7ba2022-03-20 17:46:06 +00002018 list_unlet_range(lp->ll_list, lp->ll_li, lp->ll_n1,
2019 !lp->ll_empty2, lp->ll_n2);
2020 else if (lp->ll_list != NULL)
2021 // unlet a List item.
2022 listitem_remove(lp->ll_list, lp->ll_li);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002023 else
Bram Moolenaar6b8c7ba2022-03-20 17:46:06 +00002024 // unlet a Dictionary item.
Bram Moolenaaref2c3252022-11-25 16:31:51 +00002025 dictitem_remove(lp->ll_dict, lp->ll_di, "unlet");
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002026
2027 return ret;
2028}
2029
2030/*
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002031 * Unlet one item or a range of items from a list.
2032 * Return OK or FAIL.
2033 */
Bram Moolenaar6b8c7ba2022-03-20 17:46:06 +00002034 void
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002035list_unlet_range(
2036 list_T *l,
2037 listitem_T *li_first,
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002038 long n1_arg,
2039 int has_n2,
2040 long n2)
2041{
2042 listitem_T *li = li_first;
2043 int n1 = n1_arg;
2044
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002045 // Delete a range of List items.
2046 li = li_first;
2047 n1 = n1_arg;
2048 while (li != NULL && (!has_n2 || n2 >= n1))
2049 {
2050 listitem_T *next = li->li_next;
2051
2052 listitem_remove(l, li);
2053 li = next;
2054 ++n1;
2055 }
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002056}
2057/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002058 * "unlet" a variable. Return OK if it existed, FAIL if not.
2059 * When "forceit" is TRUE don't complain if the variable doesn't exist.
2060 */
2061 int
2062do_unlet(char_u *name, int forceit)
2063{
2064 hashtab_T *ht;
2065 hashitem_T *hi;
mityu8be36ee2022-05-25 17:29:46 +01002066 char_u *varname = NULL; // init to shut up gcc
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002067 dict_T *d;
2068 dictitem_T *di;
2069
Bram Moolenaar9aed7292020-12-18 15:38:00 +01002070 // can't :unlet a script variable in Vim9 script
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002071 if (in_vim9script() && check_vim9_unlet(name) == FAIL)
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02002072 return FAIL;
2073
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002074 ht = find_var_ht(name, &varname);
Bram Moolenaar9aed7292020-12-18 15:38:00 +01002075
2076 // can't :unlet a script variable in Vim9 script from a function
2077 if (ht == get_script_local_ht()
2078 && SCRIPT_ID_VALID(current_sctx.sc_sid)
2079 && SCRIPT_ITEM(current_sctx.sc_sid)->sn_version
2080 == SCRIPT_VERSION_VIM9
2081 && check_vim9_unlet(name) == FAIL)
2082 return FAIL;
2083
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002084 if (ht != NULL && *varname != NUL)
2085 {
2086 d = get_current_funccal_dict(ht);
2087 if (d == NULL)
2088 {
2089 if (ht == &globvarht)
2090 d = &globvardict;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002091 else if (ht == &compat_hashtab)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002092 d = &vimvardict;
2093 else
2094 {
2095 di = find_var_in_ht(ht, *name, (char_u *)"", FALSE);
2096 d = di == NULL ? NULL : di->di_tv.vval.v_dict;
2097 }
2098 if (d == NULL)
2099 {
2100 internal_error("do_unlet()");
2101 return FAIL;
2102 }
2103 }
2104 hi = hash_find(ht, varname);
2105 if (HASHITEM_EMPTY(hi))
2106 hi = find_hi_in_scoped_ht(name, &ht);
2107 if (hi != NULL && !HASHITEM_EMPTY(hi))
2108 {
2109 di = HI2DI(hi);
2110 if (var_check_fixed(di->di_flags, name, FALSE)
2111 || var_check_ro(di->di_flags, name, FALSE)
Bram Moolenaaref2c3252022-11-25 16:31:51 +00002112 || value_check_lock(d->dv_lock, name, FALSE)
2113 || check_hashtab_frozen(ht, "unlet"))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002114 return FAIL;
2115
2116 delete_var(ht, hi);
2117 return OK;
2118 }
2119 }
2120 if (forceit)
2121 return OK;
Bram Moolenaare1242042021-12-16 20:56:57 +00002122 semsg(_(e_no_such_variable_str), name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002123 return FAIL;
2124}
2125
2126/*
2127 * Lock or unlock variable indicated by "lp".
2128 * "deep" is the levels to go (-1 for unlimited);
2129 * "lock" is TRUE for ":lockvar", FALSE for ":unlockvar".
2130 */
2131 static int
2132do_lock_var(
2133 lval_T *lp,
2134 char_u *name_end,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02002135 exarg_T *eap,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002136 int deep,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02002137 void *cookie UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002138{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02002139 int lock = eap->cmdidx == CMD_lockvar;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002140 int ret = OK;
2141 int cc;
2142 dictitem_T *di;
2143
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002144 if (lp->ll_tv == NULL)
2145 {
2146 cc = *name_end;
2147 *name_end = NUL;
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002148 if (*lp->ll_name == '$')
2149 {
Bram Moolenaar3a846e62022-01-01 16:21:00 +00002150 semsg(_(e_cannot_lock_or_unlock_variable_str), lp->ll_name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002151 ret = FAIL;
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002152 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002153 else
2154 {
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002155 // Normal name or expanded name.
2156 di = find_var(lp->ll_name, NULL, TRUE);
2157 if (di == NULL)
Bram Moolenaar04b568b2021-11-22 21:58:41 +00002158 {
2159 if (in_vim9script())
2160 semsg(_(e_cannot_find_variable_to_unlock_str),
2161 lp->ll_name);
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002162 ret = FAIL;
Bram Moolenaar04b568b2021-11-22 21:58:41 +00002163 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002164 else
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002165 {
Bram Moolenaar7a411a32022-04-04 14:58:06 +01002166 if ((di->di_flags & DI_FLAGS_FIX)
2167 && di->di_tv.v_type != VAR_DICT
2168 && di->di_tv.v_type != VAR_LIST)
2169 {
2170 // For historic reasons this error is not given for a list
2171 // or dict. E.g., the b: dict could be locked/unlocked.
2172 semsg(_(e_cannot_lock_or_unlock_variable_str), lp->ll_name);
2173 ret = FAIL;
2174 }
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002175 else
Bram Moolenaar7a411a32022-04-04 14:58:06 +01002176 {
2177 if (in_vim9script())
2178 {
2179 svar_T *sv = find_typval_in_script(&di->di_tv,
2180 0, FALSE);
2181
2182 if (sv != NULL && sv->sv_const != 0)
2183 {
2184 semsg(_(e_cannot_change_readonly_variable_str),
2185 lp->ll_name);
2186 ret = FAIL;
2187 }
2188 }
2189
2190 if (ret == OK)
2191 {
2192 if (lock)
2193 di->di_flags |= DI_FLAGS_LOCK;
2194 else
2195 di->di_flags &= ~DI_FLAGS_LOCK;
2196 if (deep != 0)
2197 item_lock(&di->di_tv, deep, lock, FALSE);
2198 }
2199 }
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002200 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002201 }
2202 *name_end = cc;
2203 }
Bram Moolenaara187c432020-09-16 21:08:28 +02002204 else if (deep == 0)
2205 {
2206 // nothing to do
2207 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002208 else if (lp->ll_range)
2209 {
2210 listitem_T *li = lp->ll_li;
2211
2212 // (un)lock a range of List items.
2213 while (li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
2214 {
Bram Moolenaar021bda52020-08-17 21:07:22 +02002215 item_lock(&li->li_tv, deep, lock, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002216 li = li->li_next;
2217 ++lp->ll_n1;
2218 }
2219 }
2220 else if (lp->ll_list != NULL)
2221 // (un)lock a List item.
Bram Moolenaar021bda52020-08-17 21:07:22 +02002222 item_lock(&lp->ll_li->li_tv, deep, lock, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002223 else
2224 // (un)lock a Dictionary item.
Bram Moolenaar021bda52020-08-17 21:07:22 +02002225 item_lock(&lp->ll_di->di_tv, deep, lock, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002226
2227 return ret;
2228}
2229
2230/*
2231 * Lock or unlock an item. "deep" is nr of levels to go.
Bram Moolenaar021bda52020-08-17 21:07:22 +02002232 * When "check_refcount" is TRUE do not lock a list or dict with a reference
2233 * count larger than 1.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002234 */
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +02002235 void
Bram Moolenaar021bda52020-08-17 21:07:22 +02002236item_lock(typval_T *tv, int deep, int lock, int check_refcount)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002237{
2238 static int recurse = 0;
2239 list_T *l;
2240 listitem_T *li;
2241 dict_T *d;
2242 blob_T *b;
2243 hashitem_T *hi;
2244 int todo;
2245
2246 if (recurse >= DICT_MAXNEST)
2247 {
Bram Moolenaar677658a2022-01-05 16:09:06 +00002248 emsg(_(e_variable_nested_too_deep_for_unlock));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002249 return;
2250 }
2251 if (deep == 0)
2252 return;
2253 ++recurse;
2254
2255 // lock/unlock the item itself
2256 if (lock)
2257 tv->v_lock |= VAR_LOCKED;
2258 else
2259 tv->v_lock &= ~VAR_LOCKED;
2260
2261 switch (tv->v_type)
2262 {
2263 case VAR_UNKNOWN:
Bram Moolenaar4c683752020-04-05 21:38:23 +02002264 case VAR_ANY:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002265 case VAR_VOID:
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002266 case VAR_NUMBER:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002267 case VAR_BOOL:
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002268 case VAR_STRING:
2269 case VAR_FUNC:
2270 case VAR_PARTIAL:
2271 case VAR_FLOAT:
2272 case VAR_SPECIAL:
2273 case VAR_JOB:
2274 case VAR_CHANNEL:
Bram Moolenaarf18332f2021-05-07 17:55:55 +02002275 case VAR_INSTR:
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002276 case VAR_CLASS:
2277 case VAR_OBJECT:
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002278 break;
2279
2280 case VAR_BLOB:
Bram Moolenaar021bda52020-08-17 21:07:22 +02002281 if ((b = tv->vval.v_blob) != NULL
2282 && !(check_refcount && b->bv_refcount > 1))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002283 {
2284 if (lock)
2285 b->bv_lock |= VAR_LOCKED;
2286 else
2287 b->bv_lock &= ~VAR_LOCKED;
2288 }
2289 break;
2290 case VAR_LIST:
Bram Moolenaar021bda52020-08-17 21:07:22 +02002291 if ((l = tv->vval.v_list) != NULL
2292 && !(check_refcount && l->lv_refcount > 1))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002293 {
2294 if (lock)
2295 l->lv_lock |= VAR_LOCKED;
2296 else
2297 l->lv_lock &= ~VAR_LOCKED;
Bram Moolenaar70c43d82022-01-26 21:01:15 +00002298 if (deep < 0 || deep > 1)
2299 {
2300 if (l->lv_first == &range_list_item)
2301 l->lv_lock |= VAR_ITEMS_LOCKED;
2302 else
2303 {
2304 // recursive: lock/unlock the items the List contains
2305 CHECK_LIST_MATERIALIZE(l);
2306 FOR_ALL_LIST_ITEMS(l, li) item_lock(&li->li_tv,
2307 deep - 1, lock, check_refcount);
2308 }
2309 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002310 }
2311 break;
2312 case VAR_DICT:
Bram Moolenaar021bda52020-08-17 21:07:22 +02002313 if ((d = tv->vval.v_dict) != NULL
2314 && !(check_refcount && d->dv_refcount > 1))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002315 {
2316 if (lock)
2317 d->dv_lock |= VAR_LOCKED;
2318 else
2319 d->dv_lock &= ~VAR_LOCKED;
2320 if (deep < 0 || deep > 1)
2321 {
2322 // recursive: lock/unlock the items the List contains
2323 todo = (int)d->dv_hashtab.ht_used;
Yegappan Lakshmanan14113fd2023-03-07 17:13:51 +00002324 FOR_ALL_HASHTAB_ITEMS(&d->dv_hashtab, hi, todo)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002325 {
2326 if (!HASHITEM_EMPTY(hi))
2327 {
2328 --todo;
Bram Moolenaar021bda52020-08-17 21:07:22 +02002329 item_lock(&HI2DI(hi)->di_tv, deep - 1, lock,
2330 check_refcount);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002331 }
2332 }
2333 }
2334 }
2335 }
2336 --recurse;
2337}
2338
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002339#if (defined(FEAT_MENU) && defined(FEAT_MULTI_LANG)) || defined(PROTO)
2340/*
2341 * Delete all "menutrans_" variables.
2342 */
2343 void
2344del_menutrans_vars(void)
2345{
2346 hashitem_T *hi;
2347 int todo;
2348
2349 hash_lock(&globvarht);
2350 todo = (int)globvarht.ht_used;
2351 for (hi = globvarht.ht_array; todo > 0 && !got_int; ++hi)
2352 {
2353 if (!HASHITEM_EMPTY(hi))
2354 {
2355 --todo;
2356 if (STRNCMP(HI2DI(hi)->di_key, "menutrans_", 10) == 0)
2357 delete_var(&globvarht, hi);
2358 }
2359 }
2360 hash_unlock(&globvarht);
2361}
2362#endif
2363
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002364/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002365 * Local string buffer for the next two functions to store a variable name
2366 * with its prefix. Allocated in cat_prefix_varname(), freed later in
2367 * get_user_var_name().
2368 */
2369
2370static char_u *varnamebuf = NULL;
2371static int varnamebuflen = 0;
2372
2373/*
2374 * Function to concatenate a prefix and a variable name.
2375 */
Bram Moolenaar1bb4de52021-01-13 19:48:46 +01002376 char_u *
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002377cat_prefix_varname(int prefix, char_u *name)
2378{
2379 int len;
2380
2381 len = (int)STRLEN(name) + 3;
2382 if (len > varnamebuflen)
2383 {
2384 vim_free(varnamebuf);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02002385 len += 10; // some additional space
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002386 varnamebuf = alloc(len);
2387 if (varnamebuf == NULL)
2388 {
2389 varnamebuflen = 0;
2390 return NULL;
2391 }
2392 varnamebuflen = len;
2393 }
2394 *varnamebuf = prefix;
2395 varnamebuf[1] = ':';
2396 STRCPY(varnamebuf + 2, name);
2397 return varnamebuf;
2398}
2399
2400/*
2401 * Function given to ExpandGeneric() to obtain the list of user defined
2402 * (global/buffer/window/built-in) variable names.
2403 */
2404 char_u *
2405get_user_var_name(expand_T *xp, int idx)
2406{
2407 static long_u gdone;
2408 static long_u bdone;
2409 static long_u wdone;
2410 static long_u tdone;
2411 static int vidx;
2412 static hashitem_T *hi;
2413 hashtab_T *ht;
2414
2415 if (idx == 0)
2416 {
2417 gdone = bdone = wdone = vidx = 0;
2418 tdone = 0;
2419 }
2420
2421 // Global variables
2422 if (gdone < globvarht.ht_used)
2423 {
2424 if (gdone++ == 0)
2425 hi = globvarht.ht_array;
2426 else
2427 ++hi;
2428 while (HASHITEM_EMPTY(hi))
2429 ++hi;
2430 if (STRNCMP("g:", xp->xp_pattern, 2) == 0)
2431 return cat_prefix_varname('g', hi->hi_key);
2432 return hi->hi_key;
2433 }
2434
2435 // b: variables
Bram Moolenaar0f6e28f2022-02-20 20:49:35 +00002436 ht = &prevwin_curwin()->w_buffer->b_vars->dv_hashtab;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002437 if (bdone < ht->ht_used)
2438 {
2439 if (bdone++ == 0)
2440 hi = ht->ht_array;
2441 else
2442 ++hi;
2443 while (HASHITEM_EMPTY(hi))
2444 ++hi;
2445 return cat_prefix_varname('b', hi->hi_key);
2446 }
2447
2448 // w: variables
Bram Moolenaar0f6e28f2022-02-20 20:49:35 +00002449 ht = &prevwin_curwin()->w_vars->dv_hashtab;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002450 if (wdone < ht->ht_used)
2451 {
2452 if (wdone++ == 0)
2453 hi = ht->ht_array;
2454 else
2455 ++hi;
2456 while (HASHITEM_EMPTY(hi))
2457 ++hi;
2458 return cat_prefix_varname('w', hi->hi_key);
2459 }
2460
2461 // t: variables
2462 ht = &curtab->tp_vars->dv_hashtab;
2463 if (tdone < ht->ht_used)
2464 {
2465 if (tdone++ == 0)
2466 hi = ht->ht_array;
2467 else
2468 ++hi;
2469 while (HASHITEM_EMPTY(hi))
2470 ++hi;
2471 return cat_prefix_varname('t', hi->hi_key);
2472 }
2473
2474 // v: variables
2475 if (vidx < VV_LEN)
2476 return cat_prefix_varname('v', (char_u *)vimvars[vidx++].vv_name);
2477
2478 VIM_CLEAR(varnamebuf);
2479 varnamebuflen = 0;
2480 return NULL;
2481}
2482
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002483 char *
2484get_var_special_name(int nr)
2485{
2486 switch (nr)
2487 {
Bram Moolenaara8b8af12021-01-01 15:11:04 +01002488 case VVAL_FALSE: return in_vim9script() ? "false" : "v:false";
2489 case VVAL_TRUE: return in_vim9script() ? "true" : "v:true";
Bram Moolenaar67977822021-01-03 21:53:53 +01002490 case VVAL_NULL: return in_vim9script() ? "null" : "v:null";
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002491 case VVAL_NONE: return "v:none";
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002492 }
2493 internal_error("get_var_special_name()");
2494 return "42";
2495}
2496
2497/*
2498 * Returns the global variable dictionary
2499 */
2500 dict_T *
2501get_globvar_dict(void)
2502{
2503 return &globvardict;
2504}
2505
2506/*
2507 * Returns the global variable hash table
2508 */
2509 hashtab_T *
2510get_globvar_ht(void)
2511{
2512 return &globvarht;
2513}
2514
2515/*
2516 * Returns the v: variable dictionary
2517 */
2518 dict_T *
2519get_vimvar_dict(void)
2520{
2521 return &vimvardict;
2522}
2523
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002524/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002525 * Returns the index of a v:variable. Negative if not found.
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002526 * Returns DI_ flags in "di_flags".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002527 */
2528 int
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002529find_vim_var(char_u *name, int *di_flags)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002530{
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002531 dictitem_T *di = find_var_in_ht(&vimvarht, 0, name, TRUE);
2532 struct vimvar *vv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002533
2534 if (di == NULL)
2535 return -1;
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002536 *di_flags = di->di_flags;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002537 vv = (struct vimvar *)((char *)di - offsetof(vimvar_T, vv_di));
2538 return (int)(vv - vimvars);
2539}
2540
2541
2542/*
Bram Moolenaar34ed68d2019-08-29 22:48:24 +02002543 * Set type of v: variable to "type".
2544 */
2545 void
2546set_vim_var_type(int idx, vartype_T type)
2547{
Bram Moolenaard787e402021-12-24 21:36:12 +00002548 vimvars[idx].vv_tv_type = type;
Bram Moolenaar34ed68d2019-08-29 22:48:24 +02002549}
2550
2551/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002552 * Set number v: variable to "val".
Bram Moolenaar8d71b542019-08-30 15:46:30 +02002553 * Note that this does not set the type, use set_vim_var_type() for that.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002554 */
2555 void
2556set_vim_var_nr(int idx, varnumber_T val)
2557{
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002558 vimvars[idx].vv_nr = val;
2559}
2560
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002561 char *
2562get_vim_var_name(int idx)
2563{
2564 return vimvars[idx].vv_name;
2565}
2566
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002567/*
2568 * Get typval_T v: variable value.
2569 */
2570 typval_T *
2571get_vim_var_tv(int idx)
2572{
2573 return &vimvars[idx].vv_tv;
2574}
2575
Bram Moolenaard787e402021-12-24 21:36:12 +00002576 type_T *
2577get_vim_var_type(int idx, garray_T *type_list)
2578{
2579 if (vimvars[idx].vv_type != NULL)
2580 return vimvars[idx].vv_type;
2581 return typval2type_vimvar(&vimvars[idx].vv_tv, type_list);
2582}
2583
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002584/*
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002585 * Set v: variable to "tv". Only accepts the same type.
2586 * Takes over the value of "tv".
2587 */
2588 int
2589set_vim_var_tv(int idx, typval_T *tv)
2590{
Bram Moolenaard787e402021-12-24 21:36:12 +00002591 if (vimvars[idx].vv_tv_type != tv->v_type)
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002592 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02002593 emsg(_(e_type_mismatch_for_v_variable));
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002594 clear_tv(tv);
2595 return FAIL;
2596 }
Bram Moolenaarcab27672020-04-09 20:10:55 +02002597 // VV_RO is also checked when compiling, but let's check here as well.
2598 if (vimvars[idx].vv_flags & VV_RO)
2599 {
Bram Moolenaard8e44472021-07-21 22:20:33 +02002600 semsg(_(e_cannot_change_readonly_variable_str), vimvars[idx].vv_name);
Bram Moolenaarcab27672020-04-09 20:10:55 +02002601 return FAIL;
2602 }
2603 if (sandbox && (vimvars[idx].vv_flags & VV_RO_SBX))
2604 {
Bram Moolenaar71b76852021-12-17 20:15:38 +00002605 semsg(_(e_cannot_set_variable_in_sandbox_str), vimvars[idx].vv_name);
Bram Moolenaarcab27672020-04-09 20:10:55 +02002606 return FAIL;
2607 }
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002608 clear_tv(&vimvars[idx].vv_di.di_tv);
2609 vimvars[idx].vv_di.di_tv = *tv;
2610 return OK;
2611}
2612
2613/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002614 * Get number v: variable value.
2615 */
2616 varnumber_T
2617get_vim_var_nr(int idx)
2618{
2619 return vimvars[idx].vv_nr;
2620}
2621
2622/*
2623 * Get string v: variable value. Uses a static buffer, can only be used once.
2624 * If the String variable has never been set, return an empty string.
2625 * Never returns NULL;
2626 */
2627 char_u *
2628get_vim_var_str(int idx)
2629{
2630 return tv_get_string(&vimvars[idx].vv_tv);
2631}
2632
2633/*
2634 * Get List v: variable value. Caller must take care of reference count when
2635 * needed.
2636 */
2637 list_T *
2638get_vim_var_list(int idx)
2639{
2640 return vimvars[idx].vv_list;
2641}
2642
2643/*
2644 * Get Dict v: variable value. Caller must take care of reference count when
2645 * needed.
2646 */
2647 dict_T *
2648get_vim_var_dict(int idx)
2649{
2650 return vimvars[idx].vv_dict;
2651}
2652
2653/*
2654 * Set v:char to character "c".
2655 */
2656 void
2657set_vim_var_char(int c)
2658{
2659 char_u buf[MB_MAXBYTES + 1];
2660
2661 if (has_mbyte)
2662 buf[(*mb_char2bytes)(c, buf)] = NUL;
2663 else
2664 {
2665 buf[0] = c;
2666 buf[1] = NUL;
2667 }
2668 set_vim_var_string(VV_CHAR, buf, -1);
2669}
2670
2671/*
2672 * Set v:count to "count" and v:count1 to "count1".
2673 * When "set_prevcount" is TRUE first set v:prevcount from v:count.
2674 */
2675 void
2676set_vcount(
2677 long count,
2678 long count1,
2679 int set_prevcount)
2680{
2681 if (set_prevcount)
2682 vimvars[VV_PREVCOUNT].vv_nr = vimvars[VV_COUNT].vv_nr;
2683 vimvars[VV_COUNT].vv_nr = count;
2684 vimvars[VV_COUNT1].vv_nr = count1;
2685}
2686
2687/*
2688 * Save variables that might be changed as a side effect. Used when executing
2689 * a timer callback.
2690 */
2691 void
2692save_vimvars(vimvars_save_T *vvsave)
2693{
2694 vvsave->vv_prevcount = vimvars[VV_PREVCOUNT].vv_nr;
2695 vvsave->vv_count = vimvars[VV_COUNT].vv_nr;
2696 vvsave->vv_count1 = vimvars[VV_COUNT1].vv_nr;
2697}
2698
2699/*
2700 * Restore variables saved by save_vimvars().
2701 */
2702 void
2703restore_vimvars(vimvars_save_T *vvsave)
2704{
2705 vimvars[VV_PREVCOUNT].vv_nr = vvsave->vv_prevcount;
2706 vimvars[VV_COUNT].vv_nr = vvsave->vv_count;
2707 vimvars[VV_COUNT1].vv_nr = vvsave->vv_count1;
2708}
2709
2710/*
2711 * Set string v: variable to a copy of "val". If 'copy' is FALSE, then set the
2712 * value.
2713 */
2714 void
2715set_vim_var_string(
2716 int idx,
2717 char_u *val,
2718 int len) // length of "val" to use or -1 (whole string)
2719{
2720 clear_tv(&vimvars[idx].vv_di.di_tv);
Bram Moolenaard787e402021-12-24 21:36:12 +00002721 vimvars[idx].vv_tv_type = VAR_STRING;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002722 if (val == NULL)
2723 vimvars[idx].vv_str = NULL;
2724 else if (len == -1)
2725 vimvars[idx].vv_str = vim_strsave(val);
2726 else
2727 vimvars[idx].vv_str = vim_strnsave(val, len);
2728}
2729
2730/*
2731 * Set List v: variable to "val".
2732 */
2733 void
2734set_vim_var_list(int idx, list_T *val)
2735{
2736 clear_tv(&vimvars[idx].vv_di.di_tv);
Bram Moolenaard787e402021-12-24 21:36:12 +00002737 vimvars[idx].vv_tv_type = VAR_LIST;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002738 vimvars[idx].vv_list = val;
2739 if (val != NULL)
2740 ++val->lv_refcount;
2741}
2742
2743/*
2744 * Set Dictionary v: variable to "val".
2745 */
2746 void
2747set_vim_var_dict(int idx, dict_T *val)
2748{
2749 clear_tv(&vimvars[idx].vv_di.di_tv);
Bram Moolenaard787e402021-12-24 21:36:12 +00002750 vimvars[idx].vv_tv_type = VAR_DICT;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002751 vimvars[idx].vv_dict = val;
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00002752 if (val == NULL)
2753 return;
2754
2755 ++val->dv_refcount;
2756 dict_set_items_ro(val);
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002757}
2758
2759/*
Bram Moolenaar69bf6342019-10-29 04:16:57 +01002760 * Set the v:argv list.
2761 */
2762 void
2763set_argv_var(char **argv, int argc)
2764{
2765 list_T *l = list_alloc();
2766 int i;
2767
2768 if (l == NULL)
2769 getout(1);
2770 l->lv_lock = VAR_FIXED;
2771 for (i = 0; i < argc; ++i)
2772 {
2773 if (list_append_string(l, (char_u *)argv[i], -1) == FAIL)
2774 getout(1);
Bram Moolenaar0ff6aad2020-01-29 21:27:21 +01002775 l->lv_u.mat.lv_last->li_tv.v_lock = VAR_FIXED;
Bram Moolenaar69bf6342019-10-29 04:16:57 +01002776 }
2777 set_vim_var_list(VV_ARGV, l);
2778}
2779
2780/*
Bram Moolenaar439c0362020-06-06 15:58:03 +02002781 * Reset v:register, taking the 'clipboard' setting into account.
2782 */
2783 void
2784reset_reg_var(void)
2785{
2786 int regname = 0;
2787
2788 // Adjust the register according to 'clipboard', so that when
2789 // "unnamed" is present it becomes '*' or '+' instead of '"'.
2790#ifdef FEAT_CLIPBOARD
2791 adjust_clip_reg(&regname);
2792#endif
2793 set_reg_var(regname);
2794}
2795
2796/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002797 * Set v:register if needed.
2798 */
2799 void
2800set_reg_var(int c)
2801{
2802 char_u regname;
2803
2804 if (c == 0 || c == ' ')
2805 regname = '"';
2806 else
2807 regname = c;
2808 // Avoid free/alloc when the value is already right.
2809 if (vimvars[VV_REG].vv_str == NULL || vimvars[VV_REG].vv_str[0] != c)
2810 set_vim_var_string(VV_REG, &regname, 1);
2811}
2812
2813/*
2814 * Get or set v:exception. If "oldval" == NULL, return the current value.
2815 * Otherwise, restore the value to "oldval" and return NULL.
2816 * Must always be called in pairs to save and restore v:exception! Does not
2817 * take care of memory allocations.
2818 */
2819 char_u *
2820v_exception(char_u *oldval)
2821{
2822 if (oldval == NULL)
2823 return vimvars[VV_EXCEPTION].vv_str;
2824
2825 vimvars[VV_EXCEPTION].vv_str = oldval;
2826 return NULL;
2827}
2828
2829/*
2830 * Get or set v:throwpoint. If "oldval" == NULL, return the current value.
2831 * Otherwise, restore the value to "oldval" and return NULL.
2832 * Must always be called in pairs to save and restore v:throwpoint! Does not
2833 * take care of memory allocations.
2834 */
2835 char_u *
2836v_throwpoint(char_u *oldval)
2837{
2838 if (oldval == NULL)
2839 return vimvars[VV_THROWPOINT].vv_str;
2840
2841 vimvars[VV_THROWPOINT].vv_str = oldval;
2842 return NULL;
2843}
2844
2845/*
2846 * Set v:cmdarg.
2847 * If "eap" != NULL, use "eap" to generate the value and return the old value.
2848 * If "oldarg" != NULL, restore the value to "oldarg" and return NULL.
2849 * Must always be called in pairs!
2850 */
2851 char_u *
2852set_cmdarg(exarg_T *eap, char_u *oldarg)
2853{
2854 char_u *oldval;
2855 char_u *newval;
2856 unsigned len;
2857
2858 oldval = vimvars[VV_CMDARG].vv_str;
2859 if (eap == NULL)
2860 {
2861 vim_free(oldval);
2862 vimvars[VV_CMDARG].vv_str = oldarg;
2863 return NULL;
2864 }
2865
2866 if (eap->force_bin == FORCE_BIN)
2867 len = 6;
2868 else if (eap->force_bin == FORCE_NOBIN)
2869 len = 8;
2870 else
2871 len = 0;
2872
2873 if (eap->read_edit)
2874 len += 7;
2875
2876 if (eap->force_ff != 0)
2877 len += 10; // " ++ff=unix"
2878 if (eap->force_enc != 0)
2879 len += (unsigned)STRLEN(eap->cmd + eap->force_enc) + 7;
2880 if (eap->bad_char != 0)
2881 len += 7 + 4; // " ++bad=" + "keep" or "drop"
2882
2883 newval = alloc(len + 1);
2884 if (newval == NULL)
2885 return NULL;
2886
2887 if (eap->force_bin == FORCE_BIN)
2888 sprintf((char *)newval, " ++bin");
2889 else if (eap->force_bin == FORCE_NOBIN)
2890 sprintf((char *)newval, " ++nobin");
2891 else
2892 *newval = NUL;
2893
2894 if (eap->read_edit)
2895 STRCAT(newval, " ++edit");
2896
2897 if (eap->force_ff != 0)
2898 sprintf((char *)newval + STRLEN(newval), " ++ff=%s",
2899 eap->force_ff == 'u' ? "unix"
2900 : eap->force_ff == 'd' ? "dos"
2901 : "mac");
2902 if (eap->force_enc != 0)
2903 sprintf((char *)newval + STRLEN(newval), " ++enc=%s",
2904 eap->cmd + eap->force_enc);
2905 if (eap->bad_char == BAD_KEEP)
2906 STRCPY(newval + STRLEN(newval), " ++bad=keep");
2907 else if (eap->bad_char == BAD_DROP)
2908 STRCPY(newval + STRLEN(newval), " ++bad=drop");
2909 else if (eap->bad_char != 0)
2910 sprintf((char *)newval + STRLEN(newval), " ++bad=%c", eap->bad_char);
2911 vimvars[VV_CMDARG].vv_str = newval;
2912 return oldval;
2913}
2914
2915/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002916 * Get the value of internal variable "name".
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002917 * If "flags" has EVAL_VAR_IMPORT may return a VAR_ANY with v_number set to the
2918 * imported script ID.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002919 * Return OK or FAIL. If OK is returned "rettv" must be cleared.
2920 */
2921 int
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02002922eval_variable(
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002923 char_u *name,
Bram Moolenaar94674f22023-01-06 18:42:20 +00002924 int len, // length of "name" or zero
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002925 scid_T sid, // script ID for imported item or zero
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002926 typval_T *rettv, // NULL when only checking existence
2927 dictitem_T **dip, // non-NULL when typval's dict item is needed
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002928 int flags) // EVAL_VAR_ flags
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002929{
2930 int ret = OK;
2931 typval_T *tv = NULL;
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002932 int found = FALSE;
Bram Moolenaarf055d452021-07-08 20:57:24 +02002933 hashtab_T *ht = NULL;
Bram Moolenaar94674f22023-01-06 18:42:20 +00002934 int cc = 0;
Bram Moolenaarc967d572021-07-08 21:38:50 +02002935 type_T *type = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002936
Bram Moolenaar94674f22023-01-06 18:42:20 +00002937 if (len > 0)
2938 {
2939 // truncate the name, so that we can use strcmp()
2940 cc = name[len];
2941 name[len] = NUL;
2942 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002943
Bram Moolenaar1b0a9dd2021-06-14 21:32:21 +02002944 // Check for local variable when debugging.
2945 if ((tv = lookup_debug_var(name)) == NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002946 {
Bram Moolenaar1b0a9dd2021-06-14 21:32:21 +02002947 // Check for user-defined variables.
Bram Moolenaarc967d572021-07-08 21:38:50 +02002948 dictitem_T *v = find_var(name, &ht, flags & EVAL_VAR_NOAUTOLOAD);
2949
Bram Moolenaar1b0a9dd2021-06-14 21:32:21 +02002950 if (v != NULL)
2951 {
2952 tv = &v->di_tv;
2953 if (dip != NULL)
2954 *dip = v;
2955 }
Bram Moolenaarc967d572021-07-08 21:38:50 +02002956 else
2957 ht = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002958 }
2959
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002960 if (tv == NULL && (in_vim9script() || STRNCMP(name, "s:", 2) == 0))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002961 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002962 imported_T *import = NULL;
Bram Moolenaar9721fb42020-06-11 23:10:46 +02002963 char_u *p = STRNCMP(name, "s:", 2) == 0 ? name + 2 : name;
2964
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002965 if (sid == 0)
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00002966 import = find_imported(p, 0, TRUE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002967
2968 // imported variable from another script
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002969 if (import != NULL || sid != 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002970 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002971 if ((flags & EVAL_VAR_IMPORT) == 0)
Bram Moolenaarc620c052020-07-08 15:16:19 +02002972 {
Bram Moolenaar71f21932022-01-07 18:20:55 +00002973 if (SCRIPT_ID_VALID(sid))
Bram Moolenaarc620c052020-07-08 15:16:19 +02002974 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002975 ht = &SCRIPT_VARS(sid);
2976 if (ht != NULL)
2977 {
2978 dictitem_T *v = find_var_in_ht(ht, 0, name,
2979 flags & EVAL_VAR_NOAUTOLOAD);
2980
2981 if (v != NULL)
2982 {
2983 tv = &v->di_tv;
2984 if (dip != NULL)
2985 *dip = v;
2986 }
2987 else
2988 ht = NULL;
2989 }
Bram Moolenaarc620c052020-07-08 15:16:19 +02002990 }
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002991 else
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002992 {
2993 if (flags & EVAL_VAR_VERBOSE)
Bram Moolenaardd5893b2022-01-20 21:32:54 +00002994 semsg(_(e_expected_dot_after_name_str), name);
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002995 ret = FAIL;
2996 }
Bram Moolenaarf6a44f72020-09-27 13:51:14 +02002997 }
Bram Moolenaarc620c052020-07-08 15:16:19 +02002998 else
2999 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003000 if (rettv != NULL)
3001 {
Bram Moolenaar753885b2022-08-24 16:30:36 +01003002 // special value that is used in handle_subscript()
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003003 rettv->v_type = VAR_ANY;
3004 rettv->vval.v_number = sid != 0 ? sid : import->imp_sid;
3005 }
3006 found = TRUE;
Bram Moolenaarc620c052020-07-08 15:16:19 +02003007 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003008 }
Bram Moolenaar052ff292021-12-11 13:54:46 +00003009 else if (in_vim9script() && (flags & EVAL_VAR_NO_FUNC) == 0)
Bram Moolenaar601e76a2020-08-27 21:33:10 +02003010 {
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003011 int has_g_prefix = STRNCMP(name, "g:", 2) == 0;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003012 ufunc_T *ufunc = find_func(name, FALSE);
Bram Moolenaar601e76a2020-08-27 21:33:10 +02003013
Bram Moolenaarb033ee22021-08-15 16:08:36 +02003014 // In Vim9 script we can get a function reference by using the
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003015 // function name. For a global non-autoload function "g:" is
3016 // required.
3017 if (ufunc != NULL && (has_g_prefix
3018 || !func_requires_g_prefix(ufunc)))
Bram Moolenaar601e76a2020-08-27 21:33:10 +02003019 {
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01003020 found = TRUE;
Bram Moolenaar601e76a2020-08-27 21:33:10 +02003021 if (rettv != NULL)
3022 {
3023 rettv->v_type = VAR_FUNC;
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003024 if (has_g_prefix)
Bram Moolenaaref082e12021-12-12 21:02:03 +00003025 // Keep the "g:", otherwise script-local may be
3026 // assumed.
3027 rettv->vval.v_string = vim_strsave(name);
3028 else
3029 rettv->vval.v_string = vim_strsave(ufunc->uf_name);
Bram Moolenaarb033ee22021-08-15 16:08:36 +02003030 if (rettv->vval.v_string != NULL)
3031 func_ref(ufunc->uf_name);
Bram Moolenaar601e76a2020-08-27 21:33:10 +02003032 }
3033 }
3034 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003035 }
3036
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01003037 if (!found)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003038 {
Bram Moolenaarc620c052020-07-08 15:16:19 +02003039 if (tv == NULL)
3040 {
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01003041 if (rettv != NULL && (flags & EVAL_VAR_VERBOSE))
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003042 semsg(_(e_undefined_variable_str), name);
Bram Moolenaarc620c052020-07-08 15:16:19 +02003043 ret = FAIL;
3044 }
3045 else if (rettv != NULL)
Bram Moolenaar348be7e2020-11-04 11:36:35 +01003046 {
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003047 svar_T *sv = NULL;
3048 int was_assigned = FALSE;
3049
Bram Moolenaar11005b02021-07-11 20:59:00 +02003050 if (ht != NULL && ht == get_script_local_ht()
3051 && tv != &SCRIPT_SV(current_sctx.sc_sid)->sv_var.di_tv)
Bram Moolenaarf055d452021-07-08 20:57:24 +02003052 {
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003053 sv = find_typval_in_script(tv, 0, TRUE);
Bram Moolenaarf055d452021-07-08 20:57:24 +02003054 if (sv != NULL)
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003055 {
Bram Moolenaarf055d452021-07-08 20:57:24 +02003056 type = sv->sv_type;
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003057 was_assigned = sv->sv_flags & SVFLAG_ASSIGNED;
3058 }
Bram Moolenaarf055d452021-07-08 20:57:24 +02003059 }
3060
Bram Moolenaarec15b1c2022-03-27 16:29:53 +01003061 // If a list or dict variable wasn't initialized and has meaningful
3062 // type, do it now. Not for global variables, they are not
3063 // declared.
Bram Moolenaar7a222242022-03-01 19:23:24 +00003064 if (ht != &globvarht)
Bram Moolenaar348be7e2020-11-04 11:36:35 +01003065 {
Bram Moolenaarec15b1c2022-03-27 16:29:53 +01003066 if (tv->v_type == VAR_DICT && tv->vval.v_dict == NULL
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003067 && ((type != NULL && !was_assigned)
Bram Moolenaar859cc212022-03-28 15:22:35 +01003068 || !in_vim9script()))
Bram Moolenaarf055d452021-07-08 20:57:24 +02003069 {
Bram Moolenaar7a222242022-03-01 19:23:24 +00003070 tv->vval.v_dict = dict_alloc();
3071 if (tv->vval.v_dict != NULL)
3072 {
3073 ++tv->vval.v_dict->dv_refcount;
3074 tv->vval.v_dict->dv_type = alloc_type(type);
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003075 if (sv != NULL)
3076 sv->sv_flags |= SVFLAG_ASSIGNED;
Bram Moolenaar7a222242022-03-01 19:23:24 +00003077 }
Bram Moolenaarf055d452021-07-08 20:57:24 +02003078 }
Bram Moolenaarec15b1c2022-03-27 16:29:53 +01003079 else if (tv->v_type == VAR_LIST && tv->vval.v_list == NULL
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003080 && ((type != NULL && !was_assigned)
Bram Moolenaar501f9782022-03-27 16:51:04 +01003081 || !in_vim9script()))
Bram Moolenaarf055d452021-07-08 20:57:24 +02003082 {
Bram Moolenaar7a222242022-03-01 19:23:24 +00003083 tv->vval.v_list = list_alloc();
3084 if (tv->vval.v_list != NULL)
3085 {
3086 ++tv->vval.v_list->lv_refcount;
3087 tv->vval.v_list->lv_type = alloc_type(type);
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003088 if (sv != NULL)
3089 sv->sv_flags |= SVFLAG_ASSIGNED;
Bram Moolenaar7a222242022-03-01 19:23:24 +00003090 }
Bram Moolenaarf055d452021-07-08 20:57:24 +02003091 }
Bram Moolenaar859cc212022-03-28 15:22:35 +01003092 else if (tv->v_type == VAR_BLOB && tv->vval.v_blob == NULL
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003093 && ((type != NULL && !was_assigned)
Bram Moolenaar859cc212022-03-28 15:22:35 +01003094 || !in_vim9script()))
3095 {
3096 tv->vval.v_blob = blob_alloc();
3097 if (tv->vval.v_blob != NULL)
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003098 {
Bram Moolenaar859cc212022-03-28 15:22:35 +01003099 ++tv->vval.v_blob->bv_refcount;
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003100 if (sv != NULL)
3101 sv->sv_flags |= SVFLAG_ASSIGNED;
3102 }
Bram Moolenaar859cc212022-03-28 15:22:35 +01003103 }
Bram Moolenaarb7c21af2021-04-18 14:12:31 +02003104 }
Bram Moolenaarc620c052020-07-08 15:16:19 +02003105 copy_tv(tv, rettv);
Bram Moolenaar348be7e2020-11-04 11:36:35 +01003106 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003107 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003108
Bram Moolenaar94674f22023-01-06 18:42:20 +00003109 if (len > 0)
3110 name[len] = cc;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003111
3112 return ret;
3113}
3114
3115/*
Bram Moolenaara86655a2023-01-12 17:06:27 +00003116 * Get the value of internal variable "name", also handling "import.name".
3117 * Return OK or FAIL. If OK is returned "rettv" must be cleared.
3118 */
3119 int
3120eval_variable_import(
3121 char_u *name,
3122 typval_T *rettv)
3123{
3124 char_u *s = name;
3125 while (ASCII_ISALNUM(*s) || *s == '_')
3126 ++s;
3127 int len = (int)(s - name);
3128
3129 if (eval_variable(name, len, 0, rettv, NULL, EVAL_VAR_IMPORT) == FAIL)
3130 return FAIL;
3131 if (rettv->v_type == VAR_ANY && *s == '.')
3132 {
Bram Moolenaar40594002023-01-12 20:04:51 +00003133 char_u *ns = s + 1;
3134 s = ns;
3135 while (ASCII_ISALNUM(*s) || *s == '_')
3136 ++s;
Bram Moolenaara86655a2023-01-12 17:06:27 +00003137 int sid = rettv->vval.v_number;
Bram Moolenaar40594002023-01-12 20:04:51 +00003138 return eval_variable(ns, (int)(s - ns), sid, rettv, NULL, 0);
Bram Moolenaara86655a2023-01-12 17:06:27 +00003139 }
3140 return OK;
3141}
3142
3143
3144/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003145 * Check if variable "name[len]" is a local variable or an argument.
3146 * If so, "*eval_lavars_used" is set to TRUE.
3147 */
3148 void
3149check_vars(char_u *name, int len)
3150{
3151 int cc;
3152 char_u *varname;
3153 hashtab_T *ht;
3154
3155 if (eval_lavars_used == NULL)
3156 return;
3157
3158 // truncate the name, so that we can use strcmp()
3159 cc = name[len];
3160 name[len] = NUL;
3161
3162 ht = find_var_ht(name, &varname);
3163 if (ht == get_funccal_local_ht() || ht == get_funccal_args_ht())
3164 {
3165 if (find_var(name, NULL, TRUE) != NULL)
3166 *eval_lavars_used = TRUE;
3167 }
3168
3169 name[len] = cc;
3170}
3171
3172/*
3173 * Find variable "name" in the list of variables.
3174 * Return a pointer to it if found, NULL if not found.
3175 * Careful: "a:0" variables don't have a name.
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003176 * When "htp" is not NULL set "htp" to the hashtab_T used.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003177 */
3178 dictitem_T *
3179find_var(char_u *name, hashtab_T **htp, int no_autoload)
3180{
3181 char_u *varname;
3182 hashtab_T *ht;
3183 dictitem_T *ret = NULL;
3184
3185 ht = find_var_ht(name, &varname);
3186 if (htp != NULL)
3187 *htp = ht;
3188 if (ht == NULL)
3189 return NULL;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003190 ret = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003191 if (ret != NULL)
3192 return ret;
3193
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003194 // Search in parent scope for lambda
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003195 ret = find_var_in_scoped_ht(name, no_autoload);
Bram Moolenaar2ea95b62020-11-19 21:47:56 +01003196 if (ret != NULL)
3197 return ret;
3198
3199 // in Vim9 script items without a scope can be script-local
3200 if (in_vim9script() && name[0] != NUL && name[1] != ':')
3201 {
3202 ht = get_script_local_ht();
3203 if (ht != NULL)
3204 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003205 ret = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar2ea95b62020-11-19 21:47:56 +01003206 if (ret != NULL)
3207 {
3208 if (htp != NULL)
3209 *htp = ht;
3210 return ret;
3211 }
3212 }
3213 }
3214
Bram Moolenaar0e3e7ba2022-01-13 20:18:56 +00003215 // When using "vim9script autoload" script-local items are prefixed but can
3216 // be used with s:name.
3217 if (SCRIPT_ID_VALID(current_sctx.sc_sid)
Bram Moolenaar6c4d4a62022-10-13 17:47:42 +01003218 && (in_vim9script() || (name[0] == 's' && name[1] == ':')))
Bram Moolenaar0e3e7ba2022-01-13 20:18:56 +00003219 {
3220 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
3221
3222 if (si->sn_autoload_prefix != NULL)
3223 {
Bram Moolenaar6c4d4a62022-10-13 17:47:42 +01003224 char_u *base_name = (name[0] == 's' && name[1] == ':')
3225 ? name + 2 : name;
3226 char_u *auto_name = concat_str(si->sn_autoload_prefix, base_name);
Bram Moolenaar0e3e7ba2022-01-13 20:18:56 +00003227
3228 if (auto_name != NULL)
3229 {
3230 ht = &globvarht;
Bram Moolenaar6c4d4a62022-10-13 17:47:42 +01003231 ret = find_var_in_ht(ht, 'g', auto_name, TRUE);
Bram Moolenaar130f65d2022-01-13 20:39:41 +00003232 vim_free(auto_name);
Bram Moolenaar0e3e7ba2022-01-13 20:18:56 +00003233 if (ret != NULL)
3234 {
3235 if (htp != NULL)
3236 *htp = ht;
3237 return ret;
3238 }
3239 }
Bram Moolenaar0e3e7ba2022-01-13 20:18:56 +00003240 }
3241 }
3242
Bram Moolenaar2ea95b62020-11-19 21:47:56 +01003243 return NULL;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003244}
3245
3246/*
Bram Moolenaar71f21932022-01-07 18:20:55 +00003247 * Like find_var() but if the name starts with <SNR>99_ then look in the
3248 * referenced script (used for a funcref).
3249 */
3250 dictitem_T *
3251find_var_also_in_script(char_u *name, hashtab_T **htp, int no_autoload)
3252{
3253 if (STRNCMP(name, "<SNR>", 5) == 0 && isdigit(name[5]))
3254 {
3255 char_u *p = name + 5;
3256 int sid = getdigits(&p);
3257
3258 if (SCRIPT_ID_VALID(sid) && *p == '_')
3259 {
3260 hashtab_T *ht = &SCRIPT_VARS(sid);
3261
3262 if (ht != NULL)
3263 {
3264 dictitem_T *di = find_var_in_ht(ht, 0, p + 1, no_autoload);
3265
3266 if (di != NULL)
Bram Moolenaaraa9b3ca2022-01-08 15:44:22 +00003267 {
3268 if (htp != NULL)
3269 *htp = ht;
Bram Moolenaar71f21932022-01-07 18:20:55 +00003270 return di;
Bram Moolenaaraa9b3ca2022-01-08 15:44:22 +00003271 }
Bram Moolenaar71f21932022-01-07 18:20:55 +00003272 }
3273 }
3274 }
3275
3276 return find_var(name, htp, no_autoload);
3277}
3278
3279/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003280 * Find variable "varname" in hashtab "ht" with name "htname".
Bram Moolenaar52592752020-04-03 18:43:35 +02003281 * When "varname" is empty returns curwin/curtab/etc vars dictionary.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003282 * Returns NULL if not found.
3283 */
3284 dictitem_T *
3285find_var_in_ht(
3286 hashtab_T *ht,
3287 int htname,
3288 char_u *varname,
3289 int no_autoload)
3290{
3291 hashitem_T *hi;
3292
3293 if (*varname == NUL)
3294 {
3295 // Must be something like "s:", otherwise "ht" would be NULL.
3296 switch (htname)
3297 {
3298 case 's': return &SCRIPT_SV(current_sctx.sc_sid)->sv_var;
3299 case 'g': return &globvars_var;
3300 case 'v': return &vimvars_var;
3301 case 'b': return &curbuf->b_bufvar;
3302 case 'w': return &curwin->w_winvar;
3303 case 't': return &curtab->tp_winvar;
3304 case 'l': return get_funccal_local_var();
3305 case 'a': return get_funccal_args_var();
3306 }
3307 return NULL;
3308 }
3309
3310 hi = hash_find(ht, varname);
3311 if (HASHITEM_EMPTY(hi))
3312 {
3313 // For global variables we may try auto-loading the script. If it
3314 // worked find the variable again. Don't auto-load a script if it was
3315 // loaded already, otherwise it would be loaded every time when
3316 // checking if a function name is a Funcref variable.
3317 if (ht == &globvarht && !no_autoload)
3318 {
3319 // Note: script_autoload() may make "hi" invalid. It must either
3320 // be obtained again or not used.
3321 if (!script_autoload(varname, FALSE) || aborting())
3322 return NULL;
3323 hi = hash_find(ht, varname);
3324 }
3325 if (HASHITEM_EMPTY(hi))
3326 return NULL;
3327 }
3328 return HI2DI(hi);
3329}
3330
3331/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003332 * Get the script-local hashtab. NULL if not in a script context.
3333 */
Bram Moolenaar922acbd2020-10-08 21:30:40 +02003334 hashtab_T *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003335get_script_local_ht(void)
3336{
3337 scid_T sid = current_sctx.sc_sid;
3338
Bram Moolenaare3d46852020-08-29 13:39:17 +02003339 if (SCRIPT_ID_VALID(sid))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003340 return &SCRIPT_VARS(sid);
3341 return NULL;
3342}
3343
3344/*
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003345 * Look for "name[len]" in script-local variables and functions.
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003346 * When "cmd" is TRUE it must look like a command, a function must be followed
3347 * by "(" or "->".
Bram Moolenaar709664c2020-12-12 14:33:41 +01003348 * Return OK when found, FAIL when not found.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003349 */
Bram Moolenaar709664c2020-12-12 14:33:41 +01003350 int
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003351lookup_scriptitem(
Bram Moolenaar709664c2020-12-12 14:33:41 +01003352 char_u *name,
3353 size_t len,
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003354 int cmd,
Bram Moolenaar709664c2020-12-12 14:33:41 +01003355 cctx_T *dummy UNUSED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003356{
3357 hashtab_T *ht = get_script_local_ht();
3358 char_u buffer[30];
3359 char_u *p;
Bram Moolenaar709664c2020-12-12 14:33:41 +01003360 int res;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003361 hashitem_T *hi;
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003362 int is_global = FALSE;
3363 char_u *fname = name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003364
3365 if (ht == NULL)
Bram Moolenaar709664c2020-12-12 14:33:41 +01003366 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003367 if (len < sizeof(buffer) - 1)
3368 {
Bram Moolenaar7d3664d2020-05-09 13:06:24 +02003369 // avoid an alloc/free for short names
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003370 vim_strncpy(buffer, name, len);
3371 p = buffer;
3372 }
3373 else
3374 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003375 p = vim_strnsave(name, len);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003376 if (p == NULL)
Bram Moolenaar709664c2020-12-12 14:33:41 +01003377 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003378 }
3379
3380 hi = hash_find(ht, p);
Bram Moolenaar709664c2020-12-12 14:33:41 +01003381 res = HASHITEM_EMPTY(hi) ? FAIL : OK;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003382
3383 // if not script-local, then perhaps imported
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00003384 if (res == FAIL && find_imported(p, 0, FALSE) != NULL)
Bram Moolenaar709664c2020-12-12 14:33:41 +01003385 res = OK;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003386 if (p != buffer)
3387 vim_free(p);
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003388
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003389 // Find a function, so that a following "->" works.
3390 // When used as a command require "(" or "->" to follow, "Cmd" is a user
3391 // command while "Cmd()" is a function call.
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003392 if (res != OK)
3393 {
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003394 p = skipwhite(name + len);
3395
3396 if (!cmd || name[len] == '(' || (p[0] == '-' && p[1] == '>'))
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003397 {
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003398 // Do not check for an internal function, since it might also be a
3399 // valid command, such as ":split" versus "split()".
3400 // Skip "g:" before a function name.
3401 if (name[0] == 'g' && name[1] == ':')
3402 {
3403 is_global = TRUE;
3404 fname = name + 2;
3405 }
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003406 if (find_func(fname, is_global) != NULL)
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003407 res = OK;
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003408 }
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003409 }
3410
Bram Moolenaar709664c2020-12-12 14:33:41 +01003411 return res;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003412}
3413
3414/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003415 * Find the hashtab used for a variable name.
3416 * Return NULL if the name is not valid.
3417 * Set "varname" to the start of name without ':'.
3418 */
3419 hashtab_T *
3420find_var_ht(char_u *name, char_u **varname)
3421{
3422 hashitem_T *hi;
3423 hashtab_T *ht;
3424
3425 if (name[0] == NUL)
3426 return NULL;
3427 if (name[1] != ':')
3428 {
3429 // The name must not start with a colon or #.
3430 if (name[0] == ':' || name[0] == AUTOLOAD_CHAR)
3431 return NULL;
3432 *varname = name;
3433
3434 // "version" is "v:version" in all scopes if scriptversion < 3.
3435 // Same for a few other variables marked with VV_COMPAT.
Bram Moolenaardd9de502021-08-15 13:49:42 +02003436 if (in_old_script(3))
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003437 {
3438 hi = hash_find(&compat_hashtab, name);
3439 if (!HASHITEM_EMPTY(hi))
3440 return &compat_hashtab;
3441 }
3442
3443 ht = get_funccal_local_ht();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003444 if (ht != NULL)
3445 return ht; // local variable
3446
Bram Moolenaarf0a40692021-06-11 22:05:47 +02003447 // In Vim9 script items at the script level are script-local, except
3448 // for autoload names.
3449 if (in_vim9script() && vim_strchr(name, AUTOLOAD_CHAR) == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003450 {
3451 ht = get_script_local_ht();
3452 if (ht != NULL)
3453 return ht;
3454 }
3455
3456 return &globvarht; // global variable
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003457 }
3458 *varname = name + 2;
3459 if (*name == 'g') // global variable
3460 return &globvarht;
3461 // There must be no ':' or '#' in the rest of the name, unless g: is used
3462 if (vim_strchr(name + 2, ':') != NULL
3463 || vim_strchr(name + 2, AUTOLOAD_CHAR) != NULL)
3464 return NULL;
3465 if (*name == 'b') // buffer variable
3466 return &curbuf->b_vars->dv_hashtab;
3467 if (*name == 'w') // window variable
3468 return &curwin->w_vars->dv_hashtab;
3469 if (*name == 't') // tab page variable
3470 return &curtab->tp_vars->dv_hashtab;
3471 if (*name == 'v') // v: variable
3472 return &vimvarht;
Bram Moolenaarb35efa52020-02-26 20:15:18 +01003473 if (get_current_funccal() != NULL
Bram Moolenaarca16c602022-09-06 18:57:08 +01003474 && get_current_funccal()->fc_func->uf_def_status
3475 == UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003476 {
Bram Moolenaarb35efa52020-02-26 20:15:18 +01003477 // a: and l: are only used in functions defined with ":function"
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003478 if (*name == 'a') // a: function argument
3479 return get_funccal_args_ht();
3480 if (*name == 'l') // l: local function variable
3481 return get_funccal_local_ht();
3482 }
3483 if (*name == 's') // script variable
3484 {
3485 ht = get_script_local_ht();
3486 if (ht != NULL)
3487 return ht;
3488 }
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003489 return NULL;
3490}
3491
3492/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003493 * Get the string value of a (global/local) variable.
3494 * Note: see tv_get_string() for how long the pointer remains valid.
3495 * Returns NULL when it doesn't exist.
3496 */
3497 char_u *
3498get_var_value(char_u *name)
3499{
3500 dictitem_T *v;
3501
3502 v = find_var(name, NULL, FALSE);
3503 if (v == NULL)
3504 return NULL;
3505 return tv_get_string(&v->di_tv);
3506}
3507
3508/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003509 * Allocate a new hashtab for a sourced script. It will be used while
3510 * sourcing this script and when executing functions defined in the script.
3511 */
3512 void
3513new_script_vars(scid_T id)
3514{
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003515 scriptvar_T *sv;
3516
Bram Moolenaar7ebcba62020-01-12 17:42:55 +01003517 sv = ALLOC_CLEAR_ONE(scriptvar_T);
3518 if (sv == NULL)
3519 return;
3520 init_var_dict(&sv->sv_dict, &sv->sv_var, VAR_SCOPE);
Bram Moolenaar21b9e972020-01-26 19:26:46 +01003521 SCRIPT_ITEM(id)->sn_vars = sv;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003522}
3523
3524/*
3525 * Initialize dictionary "dict" as a scope and set variable "dict_var" to
3526 * point to it.
3527 */
3528 void
3529init_var_dict(dict_T *dict, dictitem_T *dict_var, int scope)
3530{
3531 hash_init(&dict->dv_hashtab);
3532 dict->dv_lock = 0;
3533 dict->dv_scope = scope;
3534 dict->dv_refcount = DO_NOT_FREE_CNT;
3535 dict->dv_copyID = 0;
3536 dict_var->di_tv.vval.v_dict = dict;
3537 dict_var->di_tv.v_type = VAR_DICT;
3538 dict_var->di_tv.v_lock = VAR_FIXED;
3539 dict_var->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
3540 dict_var->di_key[0] = NUL;
3541}
3542
3543/*
3544 * Unreference a dictionary initialized by init_var_dict().
3545 */
3546 void
3547unref_var_dict(dict_T *dict)
3548{
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003549 // Now the dict needs to be freed if no one else is using it, go back to
3550 // normal reference counting.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003551 dict->dv_refcount -= DO_NOT_FREE_CNT - 1;
3552 dict_unref(dict);
3553}
3554
3555/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003556 * Clean up a list of internal variables.
3557 * Frees all allocated variables and the value they contain.
3558 * Clears hashtab "ht", does not free it.
3559 */
3560 void
3561vars_clear(hashtab_T *ht)
3562{
3563 vars_clear_ext(ht, TRUE);
3564}
3565
3566/*
3567 * Like vars_clear(), but only free the value if "free_val" is TRUE.
3568 */
3569 void
3570vars_clear_ext(hashtab_T *ht, int free_val)
3571{
3572 int todo;
3573 hashitem_T *hi;
3574 dictitem_T *v;
3575
3576 hash_lock(ht);
3577 todo = (int)ht->ht_used;
Yegappan Lakshmanan14113fd2023-03-07 17:13:51 +00003578 FOR_ALL_HASHTAB_ITEMS(ht, hi, todo)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003579 {
3580 if (!HASHITEM_EMPTY(hi))
3581 {
3582 --todo;
3583
3584 // Free the variable. Don't remove it from the hashtab,
3585 // ht_array might change then. hash_clear() takes care of it
3586 // later.
3587 v = HI2DI(hi);
3588 if (free_val)
3589 clear_tv(&v->di_tv);
3590 if (v->di_flags & DI_FLAGS_ALLOC)
3591 vim_free(v);
3592 }
3593 }
3594 hash_clear(ht);
Bram Moolenaar8d739de2020-10-14 19:39:19 +02003595 hash_init(ht);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003596}
3597
3598/*
3599 * Delete a variable from hashtab "ht" at item "hi".
3600 * Clear the variable value and free the dictitem.
3601 */
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02003602 void
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003603delete_var(hashtab_T *ht, hashitem_T *hi)
3604{
3605 dictitem_T *di = HI2DI(hi);
3606
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00003607 if (hash_remove(ht, hi, "delete variable") != OK)
3608 return;
3609
3610 clear_tv(&di->di_tv);
3611 vim_free(di);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003612}
3613
3614/*
3615 * List the value of one internal variable.
3616 */
3617 static void
3618list_one_var(dictitem_T *v, char *prefix, int *first)
3619{
3620 char_u *tofree;
3621 char_u *s;
3622 char_u numbuf[NUMBUFLEN];
3623
3624 s = echo_string(&v->di_tv, &tofree, numbuf, get_copyID());
3625 list_one_var_a(prefix, v->di_key, v->di_tv.v_type,
3626 s == NULL ? (char_u *)"" : s, first);
3627 vim_free(tofree);
3628}
3629
3630 static void
3631list_one_var_a(
3632 char *prefix,
3633 char_u *name,
3634 int type,
3635 char_u *string,
3636 int *first) // when TRUE clear rest of screen and set to FALSE
3637{
3638 // don't use msg() or msg_attr() to avoid overwriting "v:statusmsg"
3639 msg_start();
3640 msg_puts(prefix);
3641 if (name != NULL) // "a:" vars don't have a name stored
3642 msg_puts((char *)name);
3643 msg_putchar(' ');
3644 msg_advance(22);
3645 if (type == VAR_NUMBER)
3646 msg_putchar('#');
3647 else if (type == VAR_FUNC || type == VAR_PARTIAL)
3648 msg_putchar('*');
3649 else if (type == VAR_LIST)
3650 {
3651 msg_putchar('[');
3652 if (*string == '[')
3653 ++string;
3654 }
3655 else if (type == VAR_DICT)
3656 {
3657 msg_putchar('{');
3658 if (*string == '{')
3659 ++string;
3660 }
3661 else
3662 msg_putchar(' ');
3663
3664 msg_outtrans(string);
3665
3666 if (type == VAR_FUNC || type == VAR_PARTIAL)
3667 msg_puts("()");
3668 if (*first)
3669 {
3670 msg_clr_eos();
3671 *first = FALSE;
3672 }
3673}
3674
3675/*
zeertzjqedcba962023-09-24 23:13:51 +02003676 * Addition handling for setting a v: variable.
3677 * Return TRUE if the variable should be set normally,
3678 * FALSE if nothing else needs to be done.
3679 */
3680 int
3681before_set_vvar(
3682 char_u *varname,
3683 dictitem_T *di,
3684 typval_T *tv,
3685 int copy,
3686 int *type_error)
3687{
3688 if (di->di_tv.v_type == VAR_STRING)
3689 {
3690 VIM_CLEAR(di->di_tv.vval.v_string);
3691 if (copy || tv->v_type != VAR_STRING)
3692 {
3693 char_u *val = tv_get_string(tv);
3694
3695 // Careful: when assigning to v:errmsg and
3696 // tv_get_string() causes an error message the variable
3697 // will already be set.
3698 if (di->di_tv.vval.v_string == NULL)
3699 di->di_tv.vval.v_string = vim_strsave(val);
3700 }
3701 else
3702 {
3703 // Take over the string to avoid an extra alloc/free.
3704 di->di_tv.vval.v_string = tv->vval.v_string;
3705 tv->vval.v_string = NULL;
3706 }
3707 return FALSE;
3708 }
3709 else if (di->di_tv.v_type == VAR_NUMBER)
3710 {
3711 di->di_tv.vval.v_number = tv_get_number(tv);
3712 if (STRCMP(varname, "searchforward") == 0)
3713 set_search_direction(di->di_tv.vval.v_number ? '/' : '?');
3714#ifdef FEAT_SEARCH_EXTRA
3715 else if (STRCMP(varname, "hlsearch") == 0)
3716 {
3717 no_hlsearch = !di->di_tv.vval.v_number;
3718 redraw_all_later(UPD_SOME_VALID);
3719 }
3720#endif
3721 return FALSE;
3722 }
3723 else if (di->di_tv.v_type != tv->v_type)
3724 {
3725 *type_error = TRUE;
3726 return FALSE;
3727 }
3728 return TRUE;
3729}
3730
3731/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003732 * Set variable "name" to value in "tv".
3733 * If the variable already exists, the value is updated.
3734 * Otherwise the variable is created.
3735 */
3736 void
3737set_var(
3738 char_u *name,
3739 typval_T *tv,
3740 int copy) // make copy of value in "tv"
3741{
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003742 set_var_const(name, 0, NULL, tv, copy, ASSIGN_DECL, 0);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003743}
3744
3745/*
Bram Moolenaar0e3e7ba2022-01-13 20:18:56 +00003746 * Set variable "name" to value in "tv_arg".
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003747 * When "sid" is non-zero "name" is in the script with this ID.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003748 * If the variable already exists and "is_const" is FALSE the value is updated.
3749 * Otherwise the variable is created.
3750 */
3751 void
3752set_var_const(
3753 char_u *name,
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003754 scid_T sid,
Bram Moolenaar7824fc82021-11-26 17:36:51 +00003755 type_T *type_arg,
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003756 typval_T *tv_arg,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003757 int copy, // make copy of value in "tv"
Bram Moolenaarf6a8d422021-04-13 21:48:03 +02003758 int flags_arg, // ASSIGN_CONST, ASSIGN_FINAL, etc.
Bram Moolenaarf785aa12021-02-11 21:19:34 +01003759 int var_idx) // index for ":let [a, b] = list"
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003760{
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003761 typval_T *tv = tv_arg;
Bram Moolenaar7824fc82021-11-26 17:36:51 +00003762 type_T *type = type_arg;
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003763 typval_T bool_tv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003764 dictitem_T *di;
Bram Moolenaar993faa32022-02-21 15:59:11 +00003765 typval_T *dest_tv;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003766 char_u *varname;
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003767 char_u *name_tofree = NULL;
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003768 hashtab_T *ht = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003769 int is_script_local;
Bram Moolenaardbeecb22020-09-14 18:15:09 +02003770 int vim9script = in_vim9script();
Bram Moolenaare535db82021-03-31 21:07:24 +02003771 int var_in_vim9script;
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003772 int var_in_autoload = FALSE;
Bram Moolenaarf6a8d422021-04-13 21:48:03 +02003773 int flags = flags_arg;
Bram Moolenaardd297bc2021-12-10 10:37:38 +00003774 int free_tv_arg = !copy; // free tv_arg if not used
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003775
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003776 if (sid != 0)
3777 {
3778 if (SCRIPT_ID_VALID(sid))
3779 ht = &SCRIPT_VARS(sid);
3780 varname = name;
3781 }
3782 else
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003783 {
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003784 scriptitem_T *si;
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003785
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003786 if (in_vim9script() && is_export
3787 && SCRIPT_ID_VALID(current_sctx.sc_sid)
3788 && (si = SCRIPT_ITEM(current_sctx.sc_sid))
Bram Moolenaar0e1574c2022-03-03 17:05:35 +00003789 ->sn_autoload_prefix != NULL)
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003790 {
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003791 // In a vim9 autoload script an exported variable is put in the
3792 // global namespace with the autoload prefix.
3793 var_in_autoload = TRUE;
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003794 varname = concat_str(si->sn_autoload_prefix, name);
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003795 if (varname == NULL)
3796 goto failed;
3797 name_tofree = varname;
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003798 ht = &globvarht;
3799 }
3800 else
3801 ht = find_var_ht(name, &varname);
3802 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003803 if (ht == NULL || *varname == NUL)
3804 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00003805 semsg(_(e_illegal_variable_name_str), name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003806 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003807 }
Bram Moolenaar54969f42022-02-07 13:56:44 +00003808 is_script_local = ht == get_script_local_ht() || sid != 0
3809 || var_in_autoload;
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003810
Bram Moolenaardbeecb22020-09-14 18:15:09 +02003811 if (vim9script
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003812 && !is_script_local
Bram Moolenaar3862ea32021-01-01 21:05:55 +01003813 && (flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0
Bram Moolenaar89b474d2020-12-22 21:19:39 +01003814 && (flags & (ASSIGN_CONST | ASSIGN_FINAL)) == 0
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003815 && name[1] == ':')
Bram Moolenaar67979662020-06-20 22:50:47 +02003816 {
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003817 vim9_declare_error(name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003818 goto failed;
Bram Moolenaar67979662020-06-20 22:50:47 +02003819 }
Bram Moolenaar9510d222022-09-11 15:14:05 +01003820 if ((flags & ASSIGN_FOR_LOOP) && is_scoped_variable(name))
Bram Moolenaarf6a8d422021-04-13 21:48:03 +02003821 // Do not make g:var, w:var, b:var or t:var final.
3822 flags &= ~ASSIGN_FINAL;
3823
Bram Moolenaare535db82021-03-31 21:07:24 +02003824 var_in_vim9script = is_script_local && current_script_is_vim9();
Bram Moolenaar962c43b2021-04-10 17:18:09 +02003825 if (var_in_vim9script && name[0] == '_' && name[1] == NUL)
3826 {
Bram Moolenaarf93bbd02021-04-10 22:35:43 +02003827 // For "[a, _] = list" the underscore is ignored.
3828 if ((flags & ASSIGN_UNPACK) == 0)
3829 emsg(_(e_cannot_use_underscore_here));
Bram Moolenaar962c43b2021-04-10 17:18:09 +02003830 goto failed;
3831 }
Bram Moolenaar67979662020-06-20 22:50:47 +02003832
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003833 di = find_var_in_ht(ht, 0, varname, TRUE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003834
Bram Moolenaar24e93162021-07-18 20:40:33 +02003835 if (di == NULL && var_in_vim9script)
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003836 {
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00003837 imported_T *import = find_imported(varname, 0, FALSE);
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003838
Bram Moolenaar24e93162021-07-18 20:40:33 +02003839 if (import != NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003840 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003841 // imported name space cannot be used
Bram Moolenaar24e93162021-07-18 20:40:33 +02003842 if ((flags & ASSIGN_NO_DECL) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003843 {
Bram Moolenaar24e93162021-07-18 20:40:33 +02003844 semsg(_(e_redefining_imported_item_str), name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003845 goto failed;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003846 }
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003847 semsg(_(e_cannot_use_str_itself_it_is_imported), name);
3848 goto failed;
Bram Moolenaar24e93162021-07-18 20:40:33 +02003849 }
Bram Moolenaar75e27d72022-02-13 13:56:29 +00003850 if (!in_vim9script())
3851 {
3852 semsg(_(e_cannot_create_vim9_script_variable_in_function_str),
3853 name);
3854 goto failed;
3855 }
Bram Moolenaar24e93162021-07-18 20:40:33 +02003856 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003857
Bram Moolenaar993faa32022-02-21 15:59:11 +00003858 // Search in parent scope which is possible to reference from lambda
3859 if (di == NULL)
3860 di = find_var_in_scoped_ht(name, TRUE);
3861
3862 if ((tv->v_type == VAR_FUNC || tv->v_type == VAR_PARTIAL)
3863 && var_wrong_func_name(name, di == NULL))
3864 goto failed;
3865
3866 if (need_convert_to_bool(type, tv))
Bram Moolenaar24e93162021-07-18 20:40:33 +02003867 {
Bram Moolenaar993faa32022-02-21 15:59:11 +00003868 // Destination is a bool and the value is not, but it can be
3869 // converted.
3870 CLEAR_FIELD(bool_tv);
3871 bool_tv.v_type = VAR_BOOL;
3872 bool_tv.vval.v_number = tv2bool(tv) ? VVAL_TRUE : VVAL_FALSE;
3873 tv = &bool_tv;
3874 }
Bram Moolenaar24e93162021-07-18 20:40:33 +02003875
Bram Moolenaar993faa32022-02-21 15:59:11 +00003876 if (di != NULL)
3877 {
3878 // Item already exists. Allowed to replace when reloading.
3879 if ((di->di_flags & DI_FLAGS_RELOAD) == 0)
Bram Moolenaar24e93162021-07-18 20:40:33 +02003880 {
Bram Moolenaar993faa32022-02-21 15:59:11 +00003881 if ((flags & (ASSIGN_CONST | ASSIGN_FINAL))
3882 && (flags & ASSIGN_FOR_LOOP) == 0)
Bram Moolenaar24e93162021-07-18 20:40:33 +02003883 {
Bram Moolenaar993faa32022-02-21 15:59:11 +00003884 emsg(_(e_cannot_modify_existing_variable));
3885 goto failed;
Bram Moolenaar24e93162021-07-18 20:40:33 +02003886 }
3887
Bram Moolenaar993faa32022-02-21 15:59:11 +00003888 if (is_script_local && vim9script
3889 && (flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0)
Bram Moolenaar12be7342021-03-31 21:47:33 +02003890 {
3891 semsg(_(e_redefining_script_item_str), name);
3892 goto failed;
3893 }
3894
Bram Moolenaar993faa32022-02-21 15:59:11 +00003895 if (var_in_vim9script && (flags & ASSIGN_FOR_LOOP) == 0)
Bram Moolenaar24e93162021-07-18 20:40:33 +02003896 {
Bram Moolenaar993faa32022-02-21 15:59:11 +00003897 where_T where = WHERE_INIT;
Bram Moolenaar7a411a32022-04-04 14:58:06 +01003898 svar_T *sv = find_typval_in_script(&di->di_tv, sid, TRUE);
Bram Moolenaar993faa32022-02-21 15:59:11 +00003899
3900 if (sv != NULL)
3901 {
3902 // check the type and adjust to bool if needed
LemonBoyc5d27442023-08-19 13:02:35 +02003903 if (var_idx > 0)
3904 {
3905 where.wt_index = var_idx;
3906 where.wt_kind = WT_VARIABLE;
3907 }
Bram Moolenaar993faa32022-02-21 15:59:11 +00003908 if (check_script_var_type(sv, tv, name, where) == FAIL)
3909 goto failed;
3910 if (type == NULL)
3911 type = sv->sv_type;
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003912 sv->sv_flags |= SVFLAG_ASSIGNED;
Bram Moolenaar993faa32022-02-21 15:59:11 +00003913 }
Bram Moolenaar24e93162021-07-18 20:40:33 +02003914 }
3915
Bram Moolenaar993faa32022-02-21 15:59:11 +00003916 if ((flags & ASSIGN_FOR_LOOP) == 0
Bram Moolenaar16d2c022023-06-05 19:46:18 +01003917 ? var_check_permission(di, name) == FAIL
3918 : var_check_ro(di->di_flags, name, FALSE))
Bram Moolenaar24e93162021-07-18 20:40:33 +02003919 goto failed;
Bram Moolenaar993faa32022-02-21 15:59:11 +00003920 }
3921 else
3922 {
3923 // can only redefine once
3924 di->di_flags &= ~DI_FLAGS_RELOAD;
Bram Moolenaar24e93162021-07-18 20:40:33 +02003925
Bram Moolenaar993faa32022-02-21 15:59:11 +00003926 // A Vim9 script-local variable is also present in sn_all_vars
3927 // and sn_var_vals. It may set "type" from "tv".
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003928 if (var_in_vim9script || var_in_autoload)
Bram Moolenaar993faa32022-02-21 15:59:11 +00003929 update_vim9_script_var(FALSE, di,
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003930 var_in_autoload ? name : di->di_key, flags,
Bram Moolenaar993faa32022-02-21 15:59:11 +00003931 tv, &type, (flags & ASSIGN_NO_MEMBER_TYPE) == 0);
Bram Moolenaar07a65d22020-12-26 20:09:15 +01003932 }
3933
Bram Moolenaar993faa32022-02-21 15:59:11 +00003934 // existing variable, need to clear the value
3935
zeertzjqedcba962023-09-24 23:13:51 +02003936 // Handle setting internal v: variables separately where needed to
Bram Moolenaar993faa32022-02-21 15:59:11 +00003937 // prevent changing the type.
zeertzjqedcba962023-09-24 23:13:51 +02003938 int type_error = FALSE;
3939 if (ht == &vimvarht
3940 && !before_set_vvar(varname, di, tv, copy, &type_error))
Bram Moolenaar993faa32022-02-21 15:59:11 +00003941 {
zeertzjqedcba962023-09-24 23:13:51 +02003942 if (type_error)
3943 semsg(_(e_setting_v_str_to_value_with_wrong_type), varname);
3944 goto failed;
Bram Moolenaar993faa32022-02-21 15:59:11 +00003945 }
3946
3947 clear_tv(&di->di_tv);
Bram Moolenaar766ae5b2022-09-14 00:30:51 +01003948
3949 if ((flags & ASSIGN_UPDATE_BLOCK_ID)
3950 && SCRIPT_ID_VALID(current_sctx.sc_sid))
3951 {
3952 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
3953
3954 update_script_var_block_id(name, si->sn_current_block_id);
3955 }
Bram Moolenaar993faa32022-02-21 15:59:11 +00003956 }
3957 else
3958 {
3959 // Item not found, check if a function already exists.
3960 if (is_script_local && (flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0
3961 && lookup_scriptitem(name, STRLEN(name), FALSE, NULL) == OK)
3962 {
3963 semsg(_(e_redefining_script_item_str), name);
3964 goto failed;
3965 }
3966
3967 // add a new variable
3968 if (var_in_vim9script && (flags & ASSIGN_NO_DECL))
3969 {
3970 semsg(_(e_unknown_variable_str), name);
3971 goto failed;
3972 }
3973
Bram Moolenaaref2c3252022-11-25 16:31:51 +00003974 if (check_hashtab_frozen(ht, "add variable"))
3975 goto failed;
3976
Bram Moolenaar993faa32022-02-21 15:59:11 +00003977 // Can't add "v:" or "a:" variable.
3978 if (ht == &vimvarht || ht == get_funccal_args_ht())
3979 {
3980 semsg(_(e_illegal_variable_name_str), name);
3981 goto failed;
3982 }
3983
3984 // Make sure the variable name is valid. In Vim9 script an
3985 // autoload variable must be prefixed with "g:" unless in an
3986 // autoload script.
3987 if (!valid_varname(varname, -1, !vim9script
3988 || STRNCMP(name, "g:", 2) == 0 || var_in_autoload))
3989 goto failed;
3990
zeertzjq1b438a82023-02-01 13:11:15 +00003991 di = alloc(offsetof(dictitem_T, di_key) + STRLEN(varname) + 1);
Bram Moolenaar993faa32022-02-21 15:59:11 +00003992 if (di == NULL)
3993 goto failed;
3994 STRCPY(di->di_key, varname);
Bram Moolenaaref2c3252022-11-25 16:31:51 +00003995 if (hash_add(ht, DI2HIKEY(di), "add variable") == FAIL)
Bram Moolenaar993faa32022-02-21 15:59:11 +00003996 {
3997 vim_free(di);
3998 goto failed;
3999 }
4000 di->di_flags = DI_FLAGS_ALLOC;
4001 if (flags & (ASSIGN_CONST | ASSIGN_FINAL))
4002 di->di_flags |= DI_FLAGS_LOCK;
4003
4004 // A Vim9 script-local variable is also added to sn_all_vars and
4005 // sn_var_vals. It may set "type" from "tv".
4006 if (var_in_vim9script || var_in_autoload)
4007 update_vim9_script_var(TRUE, di,
4008 var_in_autoload ? name : di->di_key, flags,
4009 tv, &type, (flags & ASSIGN_NO_MEMBER_TYPE) == 0);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004010 }
4011
Bram Moolenaar993faa32022-02-21 15:59:11 +00004012 dest_tv = &di->di_tv;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004013 if (copy || tv->v_type == VAR_NUMBER || tv->v_type == VAR_FLOAT)
Bram Moolenaar24e93162021-07-18 20:40:33 +02004014 copy_tv(tv, dest_tv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004015 else
4016 {
Bram Moolenaar24e93162021-07-18 20:40:33 +02004017 *dest_tv = *tv;
4018 dest_tv->v_lock = 0;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004019 init_tv(tv);
4020 }
Bram Moolenaardd297bc2021-12-10 10:37:38 +00004021 free_tv_arg = FALSE;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004022
Bram Moolenaaraa210a32021-01-02 15:41:03 +01004023 if (vim9script && type != NULL)
Bram Moolenaar381692b2022-02-02 20:01:27 +00004024 set_tv_type(dest_tv, type);
Bram Moolenaaraa210a32021-01-02 15:41:03 +01004025
Bram Moolenaar1dcf55d2020-12-22 22:07:30 +01004026 // ":const var = value" locks the value
4027 // ":final var = value" locks "var"
Bram Moolenaar30fd8202020-09-26 15:09:30 +02004028 if (flags & ASSIGN_CONST)
Bram Moolenaar021bda52020-08-17 21:07:22 +02004029 // Like :lockvar! name: lock the value and what it contains, but only
4030 // if the reference count is up to one. That locks only literal
4031 // values.
Bram Moolenaar24e93162021-07-18 20:40:33 +02004032 item_lock(dest_tv, DICT_MAXNEST, TRUE, TRUE);
Bram Moolenaar24e93162021-07-18 20:40:33 +02004033
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02004034failed:
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00004035 vim_free(name_tofree);
Bram Moolenaardd297bc2021-12-10 10:37:38 +00004036 if (free_tv_arg)
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02004037 clear_tv(tv_arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004038}
4039
4040/*
Bram Moolenaar3bdc90b2020-12-22 20:35:40 +01004041 * Check in this order for backwards compatibility:
4042 * - Whether the variable is read-only
4043 * - Whether the variable value is locked
4044 * - Whether the variable is locked
4045 */
4046 int
4047var_check_permission(dictitem_T *di, char_u *name)
4048{
4049 if (var_check_ro(di->di_flags, name, FALSE)
4050 || value_check_lock(di->di_tv.v_lock, name, FALSE)
4051 || var_check_lock(di->di_flags, name, FALSE))
4052 return FAIL;
4053 return OK;
4054}
4055
4056/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004057 * Return TRUE if di_flags "flags" indicates variable "name" is read-only.
4058 * Also give an error message.
4059 */
4060 int
4061var_check_ro(int flags, char_u *name, int use_gettext)
4062{
4063 if (flags & DI_FLAGS_RO)
4064 {
Bram Moolenaar71b76852021-12-17 20:15:38 +00004065 if (name == NULL)
4066 emsg(_(e_cannot_change_readonly_variable));
4067 else
4068 semsg(_(e_cannot_change_readonly_variable_str),
Bram Moolenaard8e44472021-07-21 22:20:33 +02004069 use_gettext ? (char_u *)_(name) : name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004070 return TRUE;
4071 }
4072 if ((flags & DI_FLAGS_RO_SBX) && sandbox)
4073 {
Bram Moolenaar71b76852021-12-17 20:15:38 +00004074 if (name == NULL)
4075 emsg(_(e_cannot_set_variable_in_sandbox));
4076 else
4077 semsg(_(e_cannot_set_variable_in_sandbox_str),
4078 use_gettext ? (char_u *)_(name) : name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004079 return TRUE;
4080 }
4081 return FALSE;
4082}
4083
4084/*
Bram Moolenaara187c432020-09-16 21:08:28 +02004085 * Return TRUE if di_flags "flags" indicates variable "name" is locked.
4086 * Also give an error message.
4087 */
4088 int
4089var_check_lock(int flags, char_u *name, int use_gettext)
4090{
4091 if (flags & DI_FLAGS_LOCK)
4092 {
4093 semsg(_(e_variable_is_locked_str),
4094 use_gettext ? (char_u *)_(name) : name);
4095 return TRUE;
4096 }
4097 return FALSE;
4098}
4099
4100/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004101 * Return TRUE if di_flags "flags" indicates variable "name" is fixed.
4102 * Also give an error message.
4103 */
4104 int
4105var_check_fixed(int flags, char_u *name, int use_gettext)
4106{
4107 if (flags & DI_FLAGS_FIX)
4108 {
Bram Moolenaar71b76852021-12-17 20:15:38 +00004109 if (name == NULL)
4110 emsg(_(e_cannot_delete_variable));
4111 else
4112 semsg(_(e_cannot_delete_variable_str),
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004113 use_gettext ? (char_u *)_(name) : name);
4114 return TRUE;
4115 }
4116 return FALSE;
4117}
4118
4119/*
4120 * Check if a funcref is assigned to a valid variable name.
4121 * Return TRUE and give an error if not.
4122 */
4123 int
Bram Moolenaar98b4f142020-08-08 15:46:01 +02004124var_wrong_func_name(
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004125 char_u *name, // points to start of variable name
4126 int new_var) // TRUE when creating the variable
4127{
Bram Moolenaar32154662021-03-28 21:14:06 +02004128 // Allow for w: b: s: and t:. In Vim9 script s: is not allowed, because
4129 // the name can be used without the s: prefix.
thinca6c667bd2022-09-02 11:25:37 +01004130 // Allow autoload variable.
Bram Moolenaar32154662021-03-28 21:14:06 +02004131 if (!((vim_strchr((char_u *)"wbt", name[0]) != NULL
4132 || (!in_vim9script() && name[0] == 's')) && name[1] == ':')
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004133 && !ASCII_ISUPPER((name[0] != NUL && name[1] == ':')
thinca6c667bd2022-09-02 11:25:37 +01004134 ? name[2] : name[0])
4135 && vim_strchr(name, '#') == NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004136 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004137 semsg(_(e_funcref_variable_name_must_start_with_capital_str), name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004138 return TRUE;
4139 }
4140 // Don't allow hiding a function. When "v" is not NULL we might be
4141 // assigning another function to the same var, the type is checked
4142 // below.
4143 if (new_var && function_exists(name, FALSE))
4144 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004145 semsg(_(e_variable_name_conflicts_with_existing_function_str),
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004146 name);
4147 return TRUE;
4148 }
4149 return FALSE;
4150}
4151
4152/*
Bram Moolenaara187c432020-09-16 21:08:28 +02004153 * Return TRUE if "flags" indicates variable "name" has a locked (immutable)
4154 * value. Also give an error message, using "name" or _("name") when
4155 * "use_gettext" is TRUE.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004156 */
4157 int
Bram Moolenaara187c432020-09-16 21:08:28 +02004158value_check_lock(int lock, char_u *name, int use_gettext)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004159{
4160 if (lock & VAR_LOCKED)
4161 {
Bram Moolenaar71b76852021-12-17 20:15:38 +00004162 if (name == NULL)
4163 emsg(_(e_value_is_locked));
4164 else
4165 semsg(_(e_value_is_locked_str),
4166 use_gettext ? (char_u *)_(name) : name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004167 return TRUE;
4168 }
4169 if (lock & VAR_FIXED)
4170 {
Bram Moolenaar71b76852021-12-17 20:15:38 +00004171 if (name == NULL)
4172 emsg(_(e_cannot_change_value));
4173 else
4174 semsg(_(e_cannot_change_value_of_str),
4175 use_gettext ? (char_u *)_(name) : name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004176 return TRUE;
4177 }
4178 return FALSE;
4179}
4180
4181/*
Bram Moolenaar03290b82020-12-19 16:30:44 +01004182 * Check if a variable name is valid. When "autoload" is true "#" is allowed.
Bram Moolenaar3b3755f2021-11-22 20:10:18 +00004183 * If "len" is -1 use all of "varname", otherwise up to "varname[len]".
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004184 * Return FALSE and give an error if not.
4185 */
4186 int
Bram Moolenaar3b3755f2021-11-22 20:10:18 +00004187valid_varname(char_u *varname, int len, int autoload)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004188{
4189 char_u *p;
4190
Bram Moolenaar3b3755f2021-11-22 20:10:18 +00004191 for (p = varname; len < 0 ? *p != NUL : p < varname + len; ++p)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004192 if (!eval_isnamec1(*p) && (p == varname || !VIM_ISDIGIT(*p))
Bram Moolenaar03290b82020-12-19 16:30:44 +01004193 && !(autoload && *p == AUTOLOAD_CHAR))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004194 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004195 semsg(_(e_illegal_variable_name_str), varname);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004196 return FALSE;
4197 }
4198 return TRUE;
4199}
4200
4201/*
LemonBoy47d4e312022-05-04 18:12:55 +01004202 * Implements the logic to retrieve local variable and option values.
4203 * Used by "getwinvar()" "gettabvar()" "gettabwinvar()" "getbufvar()".
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004204 */
4205 static void
LemonBoy47d4e312022-05-04 18:12:55 +01004206get_var_from(
4207 char_u *varname,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004208 typval_T *rettv,
LemonBoy47d4e312022-05-04 18:12:55 +01004209 typval_T *deftv, // Default value if not found.
4210 int htname, // 't'ab, 'w'indow or 'b'uffer local.
4211 tabpage_T *tp, // can be NULL
4212 win_T *win,
4213 buf_T *buf) // Ignored if htname is not 'b'.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004214{
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004215 dictitem_T *v;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004216 int done = FALSE;
Bram Moolenaar18f47402022-01-06 13:24:51 +00004217 switchwin_T switchwin;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004218 int need_switch_win;
zeertzjqcd6ad642022-07-25 12:28:09 +01004219 int do_change_curbuf = buf != NULL && htname == 'b';
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004220
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004221 ++emsg_off;
4222
4223 rettv->v_type = VAR_STRING;
4224 rettv->vval.v_string = NULL;
4225
LemonBoy47d4e312022-05-04 18:12:55 +01004226 if (varname != NULL && tp != NULL && win != NULL
4227 && (htname != 'b' || buf != NULL))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004228 {
4229 // Set curwin to be our win, temporarily. Also set the tabpage,
4230 // otherwise the window is not valid. Only do this when needed,
4231 // autocommands get blocked.
LemonBoy47d4e312022-05-04 18:12:55 +01004232 // If we have a buffer reference avoid the switching, we're saving and
4233 // restoring curbuf directly.
zeertzjqcd6ad642022-07-25 12:28:09 +01004234 need_switch_win = !(tp == curtab && win == curwin) && !do_change_curbuf;
LemonBoy47d4e312022-05-04 18:12:55 +01004235 if (!need_switch_win || switch_win(&switchwin, win, tp, TRUE) == OK)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004236 {
LemonBoy47d4e312022-05-04 18:12:55 +01004237 // Handle options. There are no tab-local options.
4238 if (*varname == '&' && htname != 't')
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004239 {
LemonBoy47d4e312022-05-04 18:12:55 +01004240 buf_T *save_curbuf = curbuf;
4241
4242 // Change curbuf so the option is read from the correct buffer.
zeertzjqcd6ad642022-07-25 12:28:09 +01004243 if (do_change_curbuf)
LemonBoy47d4e312022-05-04 18:12:55 +01004244 curbuf = buf;
4245
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004246 if (varname[1] == NUL)
4247 {
zeertzjqcd6ad642022-07-25 12:28:09 +01004248 // get all window-local or buffer-local options in a dict
LemonBoy47d4e312022-05-04 18:12:55 +01004249 dict_T *opts = get_winbuf_options(htname == 'b');
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004250
4251 if (opts != NULL)
4252 {
4253 rettv_dict_set(rettv, opts);
4254 done = TRUE;
4255 }
4256 }
LemonBoy47d4e312022-05-04 18:12:55 +01004257 else if (eval_option(&varname, rettv, TRUE) == OK)
4258 // Local option
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004259 done = TRUE;
LemonBoy47d4e312022-05-04 18:12:55 +01004260
4261 curbuf = save_curbuf;
4262 }
4263 else if (*varname == NUL)
4264 {
4265 // Empty string: return a dict with all the local variables.
4266 if (htname == 'b')
4267 v = &buf->b_bufvar;
4268 else if (htname == 'w')
4269 v = &win->w_winvar;
4270 else
4271 v = &tp->tp_winvar;
4272 copy_tv(&v->di_tv, rettv);
4273 done = TRUE;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004274 }
4275 else
4276 {
LemonBoy47d4e312022-05-04 18:12:55 +01004277 hashtab_T *ht;
4278
4279 if (htname == 'b')
4280 ht = &buf->b_vars->dv_hashtab;
4281 else if (htname == 'w')
4282 ht = &win->w_vars->dv_hashtab;
4283 else
4284 ht = &tp->tp_vars->dv_hashtab;
4285
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004286 // Look up the variable.
LemonBoy47d4e312022-05-04 18:12:55 +01004287 v = find_var_in_ht(ht, htname, varname, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004288 if (v != NULL)
4289 {
4290 copy_tv(&v->di_tv, rettv);
4291 done = TRUE;
4292 }
4293 }
4294 }
4295
4296 if (need_switch_win)
4297 // restore previous notion of curwin
Bram Moolenaar18f47402022-01-06 13:24:51 +00004298 restore_win(&switchwin, TRUE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004299 }
4300
LemonBoy47d4e312022-05-04 18:12:55 +01004301 if (!done && deftv->v_type != VAR_UNKNOWN)
4302 // use the default value
4303 copy_tv(deftv, rettv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004304
4305 --emsg_off;
4306}
4307
4308/*
LemonBoy47d4e312022-05-04 18:12:55 +01004309 * getwinvar() and gettabwinvar()
4310 */
4311 static void
4312getwinvar(
4313 typval_T *argvars,
4314 typval_T *rettv,
4315 int off) // 1 for gettabwinvar()
4316{
4317 char_u *varname;
4318 tabpage_T *tp;
4319 win_T *win;
4320
4321 if (off == 1)
4322 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
4323 else
4324 tp = curtab;
4325 win = find_win_by_nr(&argvars[off], tp);
4326 varname = tv_get_string_chk(&argvars[off + 1]);
4327
4328 get_var_from(varname, rettv, &argvars[off + 2], 'w', tp, win, NULL);
4329}
4330
4331/*
Bram Moolenaar191929b2020-08-19 21:20:49 +02004332 * Set option "varname" to the value of "varp" for the current buffer/window.
4333 */
4334 static void
4335set_option_from_tv(char_u *varname, typval_T *varp)
4336{
4337 long numval = 0;
4338 char_u *strval;
4339 char_u nbuf[NUMBUFLEN];
4340 int error = FALSE;
4341
zeertzjq4c7cb372023-06-14 16:39:54 +01004342 int opt_idx = findoption(varname);
4343 if (opt_idx < 0)
4344 {
4345 semsg(_(e_unknown_option_str_2), varname);
4346 return;
4347 }
4348 int opt_p_flags = get_option_flags(opt_idx);
4349
Bram Moolenaar31a201a2021-01-03 14:47:25 +01004350 if (varp->v_type == VAR_BOOL)
Bram Moolenaarb0d81822021-01-03 15:55:10 +01004351 {
zeertzjq4c7cb372023-06-14 16:39:54 +01004352 if (opt_p_flags & P_STRING)
Bram Moolenaar28f84e12022-07-27 12:30:13 +01004353 {
4354 emsg(_(e_string_required));
4355 return;
4356 }
Bram Moolenaar31a201a2021-01-03 14:47:25 +01004357 numval = (long)varp->vval.v_number;
Bram Moolenaarb0d81822021-01-03 15:55:10 +01004358 strval = (char_u *)"0"; // avoid using "false"
4359 }
4360 else
4361 {
zeertzjq4c7cb372023-06-14 16:39:54 +01004362 if ((opt_p_flags & (P_NUM|P_BOOL))
4363 && (!in_vim9script() || varp->v_type != VAR_STRING))
Bram Moolenaarb0d81822021-01-03 15:55:10 +01004364 numval = (long)tv_get_number_chk(varp, &error);
zeertzjq4c7cb372023-06-14 16:39:54 +01004365 if (!error)
4366 strval = tv_get_string_buf_chk(varp, nbuf);
Bram Moolenaarb0d81822021-01-03 15:55:10 +01004367 }
Bram Moolenaar191929b2020-08-19 21:20:49 +02004368 if (!error && strval != NULL)
Bram Moolenaar31e5c602022-04-15 13:53:33 +01004369 set_option_value_give_err(varname, numval, strval, OPT_LOCAL);
Bram Moolenaar191929b2020-08-19 21:20:49 +02004370}
4371
4372/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004373 * "setwinvar()" and "settabwinvar()" functions
4374 */
4375 static void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004376setwinvar(typval_T *argvars, int off)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004377{
4378 win_T *win;
Bram Moolenaar18f47402022-01-06 13:24:51 +00004379 switchwin_T switchwin;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004380 int need_switch_win;
4381 char_u *varname, *winvarname;
4382 typval_T *varp;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004383 tabpage_T *tp = NULL;
4384
4385 if (check_secure())
4386 return;
4387
4388 if (off == 1)
4389 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
4390 else
4391 tp = curtab;
4392 win = find_win_by_nr(&argvars[off], tp);
4393 varname = tv_get_string_chk(&argvars[off + 1]);
4394 varp = &argvars[off + 2];
4395
zeertzjqea720ae2023-01-03 10:54:09 +00004396 if (win == NULL || varname == NULL)
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00004397 return;
4398
4399 need_switch_win = !(tp == curtab && win == curwin);
4400 if (!need_switch_win
4401 || switch_win(&switchwin, win, tp, TRUE) == OK)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004402 {
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00004403 if (*varname == '&')
4404 set_option_from_tv(varname + 1, varp);
4405 else
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004406 {
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00004407 winvarname = alloc(STRLEN(varname) + 3);
4408 if (winvarname != NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004409 {
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00004410 STRCPY(winvarname, "w:");
4411 STRCPY(winvarname + 2, varname);
4412 set_var(winvarname, varp, TRUE);
4413 vim_free(winvarname);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004414 }
4415 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004416 }
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00004417 if (need_switch_win)
4418 restore_win(&switchwin, TRUE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004419}
4420
Bram Moolenaare5cdf152019-08-29 22:09:46 +02004421/*
4422 * reset v:option_new, v:option_old, v:option_oldlocal, v:option_oldglobal,
4423 * v:option_type, and v:option_command.
4424 */
4425 void
4426reset_v_option_vars(void)
4427{
4428 set_vim_var_string(VV_OPTION_NEW, NULL, -1);
4429 set_vim_var_string(VV_OPTION_OLD, NULL, -1);
4430 set_vim_var_string(VV_OPTION_OLDLOCAL, NULL, -1);
4431 set_vim_var_string(VV_OPTION_OLDGLOBAL, NULL, -1);
4432 set_vim_var_string(VV_OPTION_TYPE, NULL, -1);
4433 set_vim_var_string(VV_OPTION_COMMAND, NULL, -1);
4434}
4435
4436/*
4437 * Add an assert error to v:errors.
4438 */
4439 void
4440assert_error(garray_T *gap)
4441{
4442 struct vimvar *vp = &vimvars[VV_ERRORS];
4443
Bram Moolenaard787e402021-12-24 21:36:12 +00004444 if (vp->vv_tv_type != VAR_LIST || vimvars[VV_ERRORS].vv_list == NULL)
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004445 // Make sure v:errors is a list.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02004446 set_vim_var_list(VV_ERRORS, list_alloc());
4447 list_append_string(vimvars[VV_ERRORS].vv_list, gap->ga_data, gap->ga_len);
4448}
4449
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004450 int
4451var_exists(char_u *var)
4452{
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02004453 char_u *arg = var;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004454 char_u *name;
4455 char_u *tofree;
4456 typval_T tv;
4457 int len = 0;
4458 int n = FALSE;
4459
4460 // get_name_len() takes care of expanding curly braces
4461 name = var;
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02004462 len = get_name_len(&arg, &tofree, TRUE, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004463 if (len > 0)
4464 {
4465 if (tofree != NULL)
4466 name = tofree;
Bram Moolenaard5f400c2022-01-06 21:10:28 +00004467 n = (eval_variable(name, len, 0, &tv, NULL,
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01004468 EVAL_VAR_NOAUTOLOAD + EVAL_VAR_IMPORT) == OK);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004469 if (n)
4470 {
4471 // handle d.key, l[idx], f(expr)
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02004472 arg = skipwhite(arg);
Bram Moolenaar32884ad2022-01-07 12:45:29 +00004473 n = (handle_subscript(&arg, name, &tv, &EVALARG_EVALUATE,
4474 FALSE) == OK);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004475 if (n)
4476 clear_tv(&tv);
4477 }
4478 }
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02004479 if (*arg != NUL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004480 n = FALSE;
4481
4482 vim_free(tofree);
4483 return n;
4484}
4485
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004486static lval_T *redir_lval = NULL;
4487#define EVALCMD_BUSY (redir_lval == (lval_T *)&redir_lval)
4488static garray_T redir_ga; // only valid when redir_lval is not NULL
4489static char_u *redir_endp = NULL;
4490static char_u *redir_varname = NULL;
4491
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004492 int
4493alloc_redir_lval(void)
4494{
4495 redir_lval = ALLOC_CLEAR_ONE(lval_T);
4496 if (redir_lval == NULL)
4497 return FAIL;
4498 return OK;
4499}
4500
4501 void
4502clear_redir_lval(void)
4503{
4504 VIM_CLEAR(redir_lval);
4505}
4506
4507 void
4508init_redir_ga(void)
4509{
Bram Moolenaar04935fb2022-01-08 16:19:22 +00004510 ga_init2(&redir_ga, sizeof(char), 500);
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004511}
4512
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004513/*
4514 * Start recording command output to a variable
4515 * When "append" is TRUE append to an existing variable.
4516 * Returns OK if successfully completed the setup. FAIL otherwise.
4517 */
4518 int
4519var_redir_start(char_u *name, int append)
4520{
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02004521 int called_emsg_before;
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004522 typval_T tv;
4523
4524 // Catch a bad name early.
4525 if (!eval_isnamec1(*name))
4526 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00004527 emsg(_(e_invalid_argument));
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004528 return FAIL;
4529 }
4530
4531 // Make a copy of the name, it is used in redir_lval until redir ends.
4532 redir_varname = vim_strsave(name);
4533 if (redir_varname == NULL)
4534 return FAIL;
4535
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004536 if (alloc_redir_lval() == FAIL)
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004537 {
4538 var_redir_stop();
4539 return FAIL;
4540 }
4541
4542 // The output is stored in growarray "redir_ga" until redirection ends.
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004543 init_redir_ga();
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004544
4545 // Parse the variable name (can be a dict or list entry).
4546 redir_endp = get_lval(redir_varname, NULL, redir_lval, FALSE, FALSE, 0,
4547 FNE_CHECK_START);
4548 if (redir_endp == NULL || redir_lval->ll_name == NULL || *redir_endp != NUL)
4549 {
4550 clear_lval(redir_lval);
4551 if (redir_endp != NULL && *redir_endp != NUL)
4552 // Trailing characters are present after the variable name
Bram Moolenaar74409f62022-01-01 15:58:22 +00004553 semsg(_(e_trailing_characters_str), redir_endp);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004554 else
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00004555 semsg(_(e_invalid_argument_str), name);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004556 redir_endp = NULL; // don't store a value, only cleanup
4557 var_redir_stop();
4558 return FAIL;
4559 }
4560
4561 // check if we can write to the variable: set it to or append an empty
4562 // string
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02004563 called_emsg_before = called_emsg;
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004564 tv.v_type = VAR_STRING;
4565 tv.vval.v_string = (char_u *)"";
4566 if (append)
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +02004567 set_var_lval(redir_lval, redir_endp, &tv, TRUE,
Bram Moolenaarf785aa12021-02-11 21:19:34 +01004568 ASSIGN_NO_DECL, (char_u *)".", 0);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004569 else
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +02004570 set_var_lval(redir_lval, redir_endp, &tv, TRUE,
Bram Moolenaarf785aa12021-02-11 21:19:34 +01004571 ASSIGN_NO_DECL, (char_u *)"=", 0);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004572 clear_lval(redir_lval);
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02004573 if (called_emsg > called_emsg_before)
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004574 {
4575 redir_endp = NULL; // don't store a value, only cleanup
4576 var_redir_stop();
4577 return FAIL;
4578 }
4579
4580 return OK;
4581}
4582
4583/*
4584 * Append "value[value_len]" to the variable set by var_redir_start().
4585 * The actual appending is postponed until redirection ends, because the value
4586 * appended may in fact be the string we write to, changing it may cause freed
4587 * memory to be used:
4588 * :redir => foo
4589 * :let foo
4590 * :redir END
4591 */
4592 void
4593var_redir_str(char_u *value, int value_len)
4594{
4595 int len;
4596
4597 if (redir_lval == NULL)
4598 return;
4599
4600 if (value_len == -1)
4601 len = (int)STRLEN(value); // Append the entire string
4602 else
4603 len = value_len; // Append only "value_len" characters
4604
4605 if (ga_grow(&redir_ga, len) == OK)
4606 {
4607 mch_memmove((char *)redir_ga.ga_data + redir_ga.ga_len, value, len);
4608 redir_ga.ga_len += len;
4609 }
4610 else
4611 var_redir_stop();
4612}
4613
4614/*
4615 * Stop redirecting command output to a variable.
4616 * Frees the allocated memory.
4617 */
4618 void
4619var_redir_stop(void)
4620{
4621 typval_T tv;
4622
4623 if (EVALCMD_BUSY)
4624 {
4625 redir_lval = NULL;
4626 return;
4627 }
4628
4629 if (redir_lval != NULL)
4630 {
4631 // If there was no error: assign the text to the variable.
4632 if (redir_endp != NULL)
4633 {
4634 ga_append(&redir_ga, NUL); // Append the trailing NUL.
4635 tv.v_type = VAR_STRING;
4636 tv.vval.v_string = redir_ga.ga_data;
4637 // Call get_lval() again, if it's inside a Dict or List it may
4638 // have changed.
4639 redir_endp = get_lval(redir_varname, NULL, redir_lval,
4640 FALSE, FALSE, 0, FNE_CHECK_START);
4641 if (redir_endp != NULL && redir_lval->ll_name != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004642 set_var_lval(redir_lval, redir_endp, &tv, FALSE, 0,
Bram Moolenaarf785aa12021-02-11 21:19:34 +01004643 (char_u *)".", 0);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004644 clear_lval(redir_lval);
4645 }
4646
4647 // free the collected output
4648 VIM_CLEAR(redir_ga.ga_data);
4649
4650 VIM_CLEAR(redir_lval);
4651 }
4652 VIM_CLEAR(redir_varname);
4653}
4654
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004655/*
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004656 * Get the collected redirected text and clear redir_ga.
4657 */
4658 char_u *
4659get_clear_redir_ga(void)
4660{
4661 char_u *res;
4662
4663 ga_append(&redir_ga, NUL); // Append the trailing NUL.
4664 res = redir_ga.ga_data;
4665 redir_ga.ga_data = NULL;
4666 return res;
4667}
4668
4669/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004670 * "gettabvar()" function
4671 */
4672 void
4673f_gettabvar(typval_T *argvars, typval_T *rettv)
4674{
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004675 char_u *varname;
LemonBoy47d4e312022-05-04 18:12:55 +01004676 tabpage_T *tp;
4677 win_T *win = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004678
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004679 if (in_vim9script()
4680 && (check_for_number_arg(argvars, 0) == FAIL
4681 || check_for_string_arg(argvars, 1) == FAIL))
4682 return;
4683
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004684 varname = tv_get_string_chk(&argvars[1]);
4685 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
LemonBoy47d4e312022-05-04 18:12:55 +01004686 if (tp != NULL)
4687 win = tp == curtab || tp->tp_firstwin == NULL ? firstwin
4688 : tp->tp_firstwin;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004689
LemonBoy47d4e312022-05-04 18:12:55 +01004690 get_var_from(varname, rettv, &argvars[2], 't', tp, win, NULL);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004691}
4692
4693/*
4694 * "gettabwinvar()" function
4695 */
4696 void
4697f_gettabwinvar(typval_T *argvars, typval_T *rettv)
4698{
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004699 if (in_vim9script()
4700 && (check_for_number_arg(argvars, 0) == FAIL
4701 || check_for_number_arg(argvars, 1) == FAIL
4702 || check_for_string_arg(argvars, 2) == FAIL))
4703 return;
4704
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004705 getwinvar(argvars, rettv, 1);
4706}
4707
4708/*
4709 * "getwinvar()" function
4710 */
4711 void
4712f_getwinvar(typval_T *argvars, typval_T *rettv)
4713{
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004714 if (in_vim9script()
4715 && (check_for_number_arg(argvars, 0) == FAIL
4716 || check_for_string_arg(argvars, 1) == FAIL))
4717 return;
4718
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004719 getwinvar(argvars, rettv, 0);
4720}
4721
4722/*
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004723 * "getbufvar()" function
4724 */
4725 void
4726f_getbufvar(typval_T *argvars, typval_T *rettv)
4727{
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004728 char_u *varname;
LemonBoy47d4e312022-05-04 18:12:55 +01004729 buf_T *buf;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004730
Yegappan Lakshmanan7973de32021-07-24 16:16:15 +02004731 if (in_vim9script()
4732 && (check_for_buffer_arg(argvars, 0) == FAIL
4733 || check_for_string_arg(argvars, 1) == FAIL))
4734 return;
4735
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004736 varname = tv_get_string_chk(&argvars[1]);
Bram Moolenaar6f84b6d2020-09-01 23:16:32 +02004737 buf = tv_get_buf_from_arg(&argvars[0]);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004738
LemonBoy47d4e312022-05-04 18:12:55 +01004739 get_var_from(varname, rettv, &argvars[2], 'b', curtab, curwin, buf);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004740}
4741
4742/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004743 * "settabvar()" function
4744 */
4745 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004746f_settabvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004747{
4748 tabpage_T *save_curtab;
4749 tabpage_T *tp;
4750 char_u *varname, *tabvarname;
4751 typval_T *varp;
4752
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004753 if (check_secure())
4754 return;
4755
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004756 if (in_vim9script()
4757 && (check_for_number_arg(argvars, 0) == FAIL
4758 || check_for_string_arg(argvars, 1) == FAIL))
4759 return;
4760
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004761 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
4762 varname = tv_get_string_chk(&argvars[1]);
4763 varp = &argvars[2];
4764
zeertzjqea720ae2023-01-03 10:54:09 +00004765 if (varname == NULL || tp == NULL)
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00004766 return;
4767
4768 save_curtab = curtab;
4769 goto_tabpage_tp(tp, FALSE, FALSE);
4770
4771 tabvarname = alloc(STRLEN(varname) + 3);
4772 if (tabvarname != NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004773 {
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00004774 STRCPY(tabvarname, "t:");
4775 STRCPY(tabvarname + 2, varname);
4776 set_var(tabvarname, varp, TRUE);
4777 vim_free(tabvarname);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004778 }
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00004779
4780 // Restore current tabpage
4781 if (valid_tabpage(save_curtab))
4782 goto_tabpage_tp(save_curtab, FALSE, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004783}
4784
4785/*
4786 * "settabwinvar()" function
4787 */
4788 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004789f_settabwinvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004790{
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004791 if (in_vim9script()
4792 && (check_for_number_arg(argvars, 0) == FAIL
4793 || check_for_number_arg(argvars, 1) == FAIL
4794 || check_for_string_arg(argvars, 2) == FAIL))
4795 return;
4796
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004797 setwinvar(argvars, 1);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004798}
4799
4800/*
4801 * "setwinvar()" function
4802 */
4803 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004804f_setwinvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004805{
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004806 if (in_vim9script()
4807 && (check_for_number_arg(argvars, 0) == FAIL
4808 || check_for_string_arg(argvars, 1) == FAIL))
4809 return;
4810
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004811 setwinvar(argvars, 0);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004812}
4813
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004814/*
4815 * "setbufvar()" function
4816 */
4817 void
4818f_setbufvar(typval_T *argvars, typval_T *rettv UNUSED)
4819{
4820 buf_T *buf;
4821 char_u *varname, *bufvarname;
4822 typval_T *varp;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004823
4824 if (check_secure())
4825 return;
Yegappan Lakshmanan7973de32021-07-24 16:16:15 +02004826
4827 if (in_vim9script()
4828 && (check_for_buffer_arg(argvars, 0) == FAIL
4829 || check_for_string_arg(argvars, 1) == FAIL))
4830 return;
4831
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004832 varname = tv_get_string_chk(&argvars[1]);
Bram Moolenaar6f84b6d2020-09-01 23:16:32 +02004833 buf = tv_get_buf_from_arg(&argvars[0]);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004834 varp = &argvars[2];
4835
zeertzjqea720ae2023-01-03 10:54:09 +00004836 if (buf == NULL || varname == NULL)
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00004837 return;
4838
4839 if (*varname == '&')
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004840 {
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00004841 aco_save_T aco;
4842
4843 // Set curbuf to be our buf, temporarily.
4844 aucmd_prepbuf(&aco, buf);
4845 if (curbuf == buf)
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004846 {
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00004847 // Only when it worked to set "curbuf".
4848 set_option_from_tv(varname + 1, varp);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004849
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00004850 // reset notion of buffer
4851 aucmd_restbuf(&aco);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004852 }
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00004853 }
4854 else
4855 {
4856 bufvarname = alloc(STRLEN(varname) + 3);
4857 if (bufvarname != NULL)
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004858 {
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00004859 buf_T *save_curbuf = curbuf;
Bram Moolenaar86015452020-03-29 15:12:15 +02004860
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00004861 curbuf = buf;
4862 STRCPY(bufvarname, "b:");
4863 STRCPY(bufvarname + 2, varname);
4864 set_var(bufvarname, varp, TRUE);
4865 vim_free(bufvarname);
4866 curbuf = save_curbuf;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004867 }
4868 }
4869}
4870
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004871/*
4872 * Get a callback from "arg". It can be a Funcref or a function name.
Bram Moolenaarc96b7f52022-12-02 15:58:38 +00004873 * When "arg" is zero "res.cb_name" is set to an empty string.
4874 * If "res.cb_name" is allocated then "res.cb_free_name" is set to TRUE.
4875 * "res.cb_name" is set to NULL for an invalid argument.
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004876 */
4877 callback_T
4878get_callback(typval_T *arg)
4879{
Bram Moolenaar14e579092020-03-07 16:59:25 +01004880 callback_T res;
4881 int r = OK;
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004882
Bram Moolenaarc96b7f52022-12-02 15:58:38 +00004883 CLEAR_FIELD(res);
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004884 if (arg->v_type == VAR_PARTIAL && arg->vval.v_partial != NULL)
4885 {
4886 res.cb_partial = arg->vval.v_partial;
4887 ++res.cb_partial->pt_refcount;
4888 res.cb_name = partial_name(res.cb_partial);
4889 }
4890 else
4891 {
Bram Moolenaar14e579092020-03-07 16:59:25 +01004892 if (arg->v_type == VAR_STRING && arg->vval.v_string != NULL
4893 && isdigit(*arg->vval.v_string))
4894 r = FAIL;
4895 else if (arg->v_type == VAR_FUNC || arg->v_type == VAR_STRING)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004896 {
Bram Moolenaarc96b7f52022-12-02 15:58:38 +00004897 res.cb_name = arg->vval.v_string;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004898 if (arg->v_type == VAR_STRING)
4899 {
Bram Moolenaarc96b7f52022-12-02 15:58:38 +00004900 char_u *name = get_scriptlocal_funcname(arg->vval.v_string);
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004901 if (name != NULL)
4902 {
Bram Moolenaarc96b7f52022-12-02 15:58:38 +00004903 res.cb_name = name;
4904 res.cb_free_name = TRUE;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004905 }
4906 }
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004907 func_ref(res.cb_name);
4908 }
4909 else if (arg->v_type == VAR_NUMBER && arg->vval.v_number == 0)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004910 res.cb_name = (char_u *)"";
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004911 else
Bram Moolenaar14e579092020-03-07 16:59:25 +01004912 r = FAIL;
4913
4914 if (r == FAIL)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004915 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00004916 emsg(_(e_invalid_callback_argument));
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004917 res.cb_name = NULL;
4918 }
4919 }
4920 return res;
4921}
4922
4923/*
4924 * Copy a callback into a typval_T.
4925 */
4926 void
4927put_callback(callback_T *cb, typval_T *tv)
4928{
4929 if (cb->cb_partial != NULL)
4930 {
4931 tv->v_type = VAR_PARTIAL;
4932 tv->vval.v_partial = cb->cb_partial;
4933 ++tv->vval.v_partial->pt_refcount;
4934 }
4935 else
4936 {
4937 tv->v_type = VAR_FUNC;
4938 tv->vval.v_string = vim_strsave(cb->cb_name);
4939 func_ref(cb->cb_name);
4940 }
4941}
4942
4943/*
4944 * Make a copy of "src" into "dest", allocating the function name if needed,
4945 * without incrementing the refcount.
4946 */
4947 void
4948set_callback(callback_T *dest, callback_T *src)
4949{
4950 if (src->cb_partial == NULL)
4951 {
4952 // just a function name, make a copy
4953 dest->cb_name = vim_strsave(src->cb_name);
4954 dest->cb_free_name = TRUE;
4955 }
4956 else
4957 {
4958 // cb_name is a pointer into cb_partial
4959 dest->cb_name = src->cb_name;
4960 dest->cb_free_name = FALSE;
4961 }
4962 dest->cb_partial = src->cb_partial;
4963}
4964
4965/*
Bram Moolenaard43906d2020-07-20 21:31:32 +02004966 * Copy callback from "src" to "dest", incrementing the refcounts.
4967 */
4968 void
4969copy_callback(callback_T *dest, callback_T *src)
4970{
4971 dest->cb_partial = src->cb_partial;
4972 if (dest->cb_partial != NULL)
4973 {
4974 dest->cb_name = src->cb_name;
4975 dest->cb_free_name = FALSE;
4976 ++dest->cb_partial->pt_refcount;
4977 }
4978 else
4979 {
4980 dest->cb_name = vim_strsave(src->cb_name);
4981 dest->cb_free_name = TRUE;
4982 func_ref(src->cb_name);
4983 }
4984}
4985
4986/*
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00004987 * When a callback refers to an autoload import, change the function name to
4988 * the "path#name" form. Uses the current script context.
4989 * Only works when the name is allocated.
4990 */
4991 void
4992expand_autload_callback(callback_T *cb)
4993{
Bram Moolenaar3e93a2b2022-01-24 21:28:01 +00004994 char_u *name;
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00004995 char_u *p;
4996 imported_T *import;
4997
Bram Moolenaar3e93a2b2022-01-24 21:28:01 +00004998 if (!in_vim9script() || cb->cb_name == NULL
4999 || (!cb->cb_free_name
5000 && (cb->cb_partial == NULL || cb->cb_partial->pt_name == NULL)))
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00005001 return;
Bram Moolenaar3e93a2b2022-01-24 21:28:01 +00005002 if (cb->cb_partial != NULL)
5003 name = cb->cb_partial->pt_name;
5004 else
5005 name = cb->cb_name;
5006 p = vim_strchr(name, '.');
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00005007 if (p == NULL)
5008 return;
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00005009
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00005010 import = find_imported(name, p - name, FALSE);
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00005011 if (import == NULL || !SCRIPT_ID_VALID(import->imp_sid))
5012 return;
5013
5014 scriptitem_T *si = SCRIPT_ITEM(import->imp_sid);
5015 if (si->sn_autoload_prefix == NULL)
5016 return;
5017
5018 char_u *newname = concat_str(si->sn_autoload_prefix, p + 1);
5019 if (newname == NULL)
5020 return;
5021
5022 if (cb->cb_partial != NULL)
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00005023 {
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00005024 if (cb->cb_name == cb->cb_partial->pt_name)
5025 cb->cb_name = newname;
5026 vim_free(cb->cb_partial->pt_name);
5027 cb->cb_partial->pt_name = newname;
5028 }
5029 else
5030 {
5031 vim_free(cb->cb_name);
5032 cb->cb_name = newname;
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00005033 }
5034}
5035
5036/*
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02005037 * Unref/free "callback" returned by get_callback() or set_callback().
5038 */
5039 void
5040free_callback(callback_T *callback)
5041{
5042 if (callback->cb_partial != NULL)
5043 {
5044 partial_unref(callback->cb_partial);
5045 callback->cb_partial = NULL;
5046 }
5047 else if (callback->cb_name != NULL)
5048 func_unref(callback->cb_name);
5049 if (callback->cb_free_name)
5050 {
5051 vim_free(callback->cb_name);
5052 callback->cb_free_name = FALSE;
5053 }
5054 callback->cb_name = NULL;
5055}
5056
Bram Moolenaar0522ba02019-08-27 22:48:30 +02005057#endif // FEAT_EVAL