blob: d7a1a96a541e07a55ee60f34c8f80412b96365bd [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;
Yegappan Lakshmananb5a07192023-10-05 20:14:43 +02001861 lval_flags |= (flags & ASSIGN_FOR_LOOP) ? GLV_FOR_LOOP : 0;
Bram Moolenaar22ebd172022-04-01 15:26:58 +01001862 if (op != NULL && *op != '=')
1863 lval_flags |= GLV_ASSIGN_WITH_OP;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001864
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001865 // ":let var = expr": Set internal variable.
1866 // ":let var: type = expr": Set internal variable with type.
1867 // ":let {expr} = expr": Idem, name made with curly braces
Bram Moolenaar22ebd172022-04-01 15:26:58 +01001868 p = get_lval(arg, tv, &lv, FALSE, FALSE, lval_flags, FNE_CHECK_START);
Bram Moolenaar822ba242020-05-24 23:00:18 +02001869 if (p != NULL && lv.ll_name != NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001870 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001871 if (endchars != NULL && vim_strchr(endchars,
1872 *skipwhite(lv.ll_name_end)) == NULL)
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001873 {
Bram Moolenaar108010a2021-06-27 22:03:33 +02001874 emsg(_(e_unexpected_characters_in_let));
Bram Moolenaar3ccb5792021-11-28 19:53:42 +00001875 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001876 else
1877 {
Bram Moolenaarf785aa12021-02-11 21:19:34 +01001878 set_var_lval(&lv, p, tv, copy, flags, op, var_idx);
Bram Moolenaara3589a02021-04-14 13:30:46 +02001879 arg_end = lv.ll_name_end;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001880 }
1881 }
1882 clear_lval(&lv);
1883 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001884 else
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001885 semsg(_(e_invalid_argument_str), arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001886
1887 return arg_end;
1888}
1889
1890/*
1891 * ":unlet[!] var1 ... " command.
1892 */
1893 void
1894ex_unlet(exarg_T *eap)
1895{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001896 ex_unletlock(eap, eap->arg, 0, 0, do_unlet_var, NULL);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001897}
1898
1899/*
1900 * ":lockvar" and ":unlockvar" commands
1901 */
1902 void
1903ex_lockvar(exarg_T *eap)
1904{
1905 char_u *arg = eap->arg;
1906 int deep = 2;
1907
1908 if (eap->forceit)
1909 deep = -1;
1910 else if (vim_isdigit(*arg))
1911 {
1912 deep = getdigits(&arg);
1913 arg = skipwhite(arg);
1914 }
1915
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001916 ex_unletlock(eap, arg, deep, 0, do_lock_var, NULL);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001917}
1918
1919/*
1920 * ":unlet", ":lockvar" and ":unlockvar" are quite similar.
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001921 * Also used for Vim9 script. "callback" is invoked as:
1922 * callback(&lv, name_end, eap, deep, cookie)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001923 */
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001924 void
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001925ex_unletlock(
1926 exarg_T *eap,
1927 char_u *argstart,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001928 int deep,
1929 int glv_flags,
1930 int (*callback)(lval_T *, char_u *, exarg_T *, int, void *),
1931 void *cookie)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001932{
1933 char_u *arg = argstart;
1934 char_u *name_end;
1935 int error = FALSE;
1936 lval_T lv;
1937
1938 do
1939 {
1940 if (*arg == '$')
1941 {
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001942 lv.ll_name = arg;
1943 lv.ll_tv = NULL;
1944 ++arg;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001945 if (get_env_len(&arg) == 0)
1946 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001947 semsg(_(e_invalid_argument_str), arg - 1);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001948 return;
1949 }
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02001950 if (!error && !eap->skip
1951 && callback(&lv, arg, eap, deep, cookie) == FAIL)
1952 error = TRUE;
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001953 name_end = arg;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001954 }
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001955 else
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001956 {
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001957 // Parse the name and find the end.
1958 name_end = get_lval(arg, NULL, &lv, TRUE, eap->skip || error,
Bram Moolenaarc3689572021-01-01 19:40:02 +01001959 glv_flags | GLV_NO_DECL, FNE_CHECK_START);
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001960 if (lv.ll_name == NULL)
1961 error = TRUE; // error but continue parsing
1962 if (name_end == NULL || (!VIM_ISWHITE(*name_end)
1963 && !ends_excmd(*name_end)))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001964 {
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001965 if (name_end != NULL)
1966 {
1967 emsg_severe = TRUE;
Bram Moolenaar74409f62022-01-01 15:58:22 +00001968 semsg(_(e_trailing_characters_str), name_end);
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001969 }
1970 if (!(eap->skip || error))
1971 clear_lval(&lv);
1972 break;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001973 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001974
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001975 if (!error && !eap->skip
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001976 && callback(&lv, name_end, eap, deep, cookie) == FAIL)
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001977 error = TRUE;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001978
Bram Moolenaar2bb76ac2020-04-19 22:57:44 +02001979 if (!eap->skip)
1980 clear_lval(&lv);
1981 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001982
1983 arg = skipwhite(name_end);
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001984 } while (!ends_excmd2(name_end, arg));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001985
Bram Moolenaar63b91732021-08-05 20:40:03 +02001986 set_nextcmd(eap, arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001987}
1988
1989 static int
1990do_unlet_var(
1991 lval_T *lp,
1992 char_u *name_end,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001993 exarg_T *eap,
1994 int deep UNUSED,
1995 void *cookie UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001996{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02001997 int forceit = eap->forceit;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02001998 int ret = OK;
1999 int cc;
2000
2001 if (lp->ll_tv == NULL)
2002 {
2003 cc = *name_end;
2004 *name_end = NUL;
2005
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002006 // Environment variable, normal name or expanded name.
2007 if (*lp->ll_name == '$')
LemonBoy77142312022-04-15 20:50:46 +01002008 vim_unsetenv_ext(lp->ll_name + 1);
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002009 else if (do_unlet(lp->ll_name, forceit) == FAIL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002010 ret = FAIL;
2011 *name_end = cc;
2012 }
2013 else if ((lp->ll_list != NULL
Bram Moolenaara187c432020-09-16 21:08:28 +02002014 && value_check_lock(lp->ll_list->lv_lock, lp->ll_name, FALSE))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002015 || (lp->ll_dict != NULL
Bram Moolenaara187c432020-09-16 21:08:28 +02002016 && value_check_lock(lp->ll_dict->dv_lock, lp->ll_name, FALSE)))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002017 return FAIL;
2018 else if (lp->ll_range)
Bram Moolenaar6b8c7ba2022-03-20 17:46:06 +00002019 list_unlet_range(lp->ll_list, lp->ll_li, lp->ll_n1,
2020 !lp->ll_empty2, lp->ll_n2);
2021 else if (lp->ll_list != NULL)
2022 // unlet a List item.
2023 listitem_remove(lp->ll_list, lp->ll_li);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002024 else
Bram Moolenaar6b8c7ba2022-03-20 17:46:06 +00002025 // unlet a Dictionary item.
Bram Moolenaaref2c3252022-11-25 16:31:51 +00002026 dictitem_remove(lp->ll_dict, lp->ll_di, "unlet");
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002027
2028 return ret;
2029}
2030
2031/*
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002032 * Unlet one item or a range of items from a list.
2033 * Return OK or FAIL.
2034 */
Bram Moolenaar6b8c7ba2022-03-20 17:46:06 +00002035 void
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002036list_unlet_range(
2037 list_T *l,
2038 listitem_T *li_first,
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002039 long n1_arg,
2040 int has_n2,
2041 long n2)
2042{
2043 listitem_T *li = li_first;
2044 int n1 = n1_arg;
2045
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002046 // Delete a range of List items.
2047 li = li_first;
2048 n1 = n1_arg;
2049 while (li != NULL && (!has_n2 || n2 >= n1))
2050 {
2051 listitem_T *next = li->li_next;
2052
2053 listitem_remove(l, li);
2054 li = next;
2055 ++n1;
2056 }
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002057}
2058/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002059 * "unlet" a variable. Return OK if it existed, FAIL if not.
2060 * When "forceit" is TRUE don't complain if the variable doesn't exist.
2061 */
2062 int
2063do_unlet(char_u *name, int forceit)
2064{
2065 hashtab_T *ht;
2066 hashitem_T *hi;
mityu8be36ee2022-05-25 17:29:46 +01002067 char_u *varname = NULL; // init to shut up gcc
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002068 dict_T *d;
2069 dictitem_T *di;
2070
Bram Moolenaar9aed7292020-12-18 15:38:00 +01002071 // can't :unlet a script variable in Vim9 script
Bram Moolenaareb6880b2020-07-12 17:07:05 +02002072 if (in_vim9script() && check_vim9_unlet(name) == FAIL)
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02002073 return FAIL;
2074
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002075 ht = find_var_ht(name, &varname);
Bram Moolenaar9aed7292020-12-18 15:38:00 +01002076
2077 // can't :unlet a script variable in Vim9 script from a function
2078 if (ht == get_script_local_ht()
2079 && SCRIPT_ID_VALID(current_sctx.sc_sid)
2080 && SCRIPT_ITEM(current_sctx.sc_sid)->sn_version
2081 == SCRIPT_VERSION_VIM9
2082 && check_vim9_unlet(name) == FAIL)
2083 return FAIL;
2084
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002085 if (ht != NULL && *varname != NUL)
2086 {
2087 d = get_current_funccal_dict(ht);
2088 if (d == NULL)
2089 {
2090 if (ht == &globvarht)
2091 d = &globvardict;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002092 else if (ht == &compat_hashtab)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002093 d = &vimvardict;
2094 else
2095 {
2096 di = find_var_in_ht(ht, *name, (char_u *)"", FALSE);
2097 d = di == NULL ? NULL : di->di_tv.vval.v_dict;
2098 }
2099 if (d == NULL)
2100 {
2101 internal_error("do_unlet()");
2102 return FAIL;
2103 }
2104 }
2105 hi = hash_find(ht, varname);
2106 if (HASHITEM_EMPTY(hi))
2107 hi = find_hi_in_scoped_ht(name, &ht);
2108 if (hi != NULL && !HASHITEM_EMPTY(hi))
2109 {
2110 di = HI2DI(hi);
2111 if (var_check_fixed(di->di_flags, name, FALSE)
2112 || var_check_ro(di->di_flags, name, FALSE)
Bram Moolenaaref2c3252022-11-25 16:31:51 +00002113 || value_check_lock(d->dv_lock, name, FALSE)
2114 || check_hashtab_frozen(ht, "unlet"))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002115 return FAIL;
2116
2117 delete_var(ht, hi);
2118 return OK;
2119 }
2120 }
2121 if (forceit)
2122 return OK;
Bram Moolenaare1242042021-12-16 20:56:57 +00002123 semsg(_(e_no_such_variable_str), name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002124 return FAIL;
2125}
2126
Ernie Raelee865f32023-09-29 19:53:55 +02002127 static void
2128report_lockvar_member(char *msg, lval_T *lp)
2129{
2130 int did_alloc = FALSE;
2131 char_u *vname = (char_u *)"";
2132 char_u *class_name = lp->ll_class != NULL
2133 ? lp->ll_class->class_name : (char_u *)"";
2134 if (lp->ll_name != NULL)
2135 {
2136 if (lp->ll_name_end == NULL)
2137 vname = lp->ll_name;
2138 else
2139 {
2140 vname = vim_strnsave(lp->ll_name, lp->ll_name_end - lp->ll_name);
2141 if (vname == NULL)
2142 return;
2143 did_alloc = TRUE;
2144 }
2145 }
2146 semsg(_(msg), vname, class_name);
2147 if (did_alloc)
2148 vim_free(vname);
2149}
2150
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002151/*
2152 * Lock or unlock variable indicated by "lp".
2153 * "deep" is the levels to go (-1 for unlimited);
2154 * "lock" is TRUE for ":lockvar", FALSE for ":unlockvar".
2155 */
2156 static int
2157do_lock_var(
2158 lval_T *lp,
2159 char_u *name_end,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02002160 exarg_T *eap,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002161 int deep,
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02002162 void *cookie UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002163{
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02002164 int lock = eap->cmdidx == CMD_lockvar;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002165 int ret = OK;
2166 int cc;
2167 dictitem_T *di;
2168
Ernie Raelee865f32023-09-29 19:53:55 +02002169#ifdef LOG_LOCKVAR
2170 ch_log(NULL, "LKVAR: do_lock_var(): name %s, is_root %d", lp->ll_name, lp->ll_is_root);
2171#endif
2172
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002173 if (lp->ll_tv == NULL)
2174 {
2175 cc = *name_end;
2176 *name_end = NUL;
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002177 if (*lp->ll_name == '$')
2178 {
Bram Moolenaar3a846e62022-01-01 16:21:00 +00002179 semsg(_(e_cannot_lock_or_unlock_variable_str), lp->ll_name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002180 ret = FAIL;
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002181 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002182 else
2183 {
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002184 // Normal name or expanded name.
2185 di = find_var(lp->ll_name, NULL, TRUE);
2186 if (di == NULL)
Bram Moolenaar04b568b2021-11-22 21:58:41 +00002187 {
2188 if (in_vim9script())
2189 semsg(_(e_cannot_find_variable_to_unlock_str),
2190 lp->ll_name);
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002191 ret = FAIL;
Bram Moolenaar04b568b2021-11-22 21:58:41 +00002192 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002193 else
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002194 {
Bram Moolenaar7a411a32022-04-04 14:58:06 +01002195 if ((di->di_flags & DI_FLAGS_FIX)
2196 && di->di_tv.v_type != VAR_DICT
2197 && di->di_tv.v_type != VAR_LIST)
2198 {
2199 // For historic reasons this error is not given for a list
2200 // or dict. E.g., the b: dict could be locked/unlocked.
2201 semsg(_(e_cannot_lock_or_unlock_variable_str), lp->ll_name);
2202 ret = FAIL;
2203 }
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002204 else
Bram Moolenaar7a411a32022-04-04 14:58:06 +01002205 {
2206 if (in_vim9script())
2207 {
2208 svar_T *sv = find_typval_in_script(&di->di_tv,
2209 0, FALSE);
2210
2211 if (sv != NULL && sv->sv_const != 0)
2212 {
2213 semsg(_(e_cannot_change_readonly_variable_str),
2214 lp->ll_name);
2215 ret = FAIL;
2216 }
2217 }
2218
2219 if (ret == OK)
2220 {
2221 if (lock)
2222 di->di_flags |= DI_FLAGS_LOCK;
2223 else
2224 di->di_flags &= ~DI_FLAGS_LOCK;
2225 if (deep != 0)
2226 item_lock(&di->di_tv, deep, lock, FALSE);
2227 }
2228 }
Bram Moolenaar7e0868e2020-04-19 17:24:53 +02002229 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002230 }
2231 *name_end = cc;
2232 }
Ernie Raelee865f32023-09-29 19:53:55 +02002233 else if (deep == 0 && lp->ll_object == NULL && lp->ll_class == NULL)
Bram Moolenaara187c432020-09-16 21:08:28 +02002234 {
2235 // nothing to do
2236 }
Ernie Raelee865f32023-09-29 19:53:55 +02002237 else if (lp->ll_is_root)
2238 // (un)lock the item.
2239 item_lock(lp->ll_tv, deep, lock, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002240 else if (lp->ll_range)
2241 {
2242 listitem_T *li = lp->ll_li;
2243
2244 // (un)lock a range of List items.
2245 while (li != NULL && (lp->ll_empty2 || lp->ll_n2 >= lp->ll_n1))
2246 {
Bram Moolenaar021bda52020-08-17 21:07:22 +02002247 item_lock(&li->li_tv, deep, lock, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002248 li = li->li_next;
2249 ++lp->ll_n1;
2250 }
2251 }
2252 else if (lp->ll_list != NULL)
2253 // (un)lock a List item.
Bram Moolenaar021bda52020-08-17 21:07:22 +02002254 item_lock(&lp->ll_li->li_tv, deep, lock, FALSE);
Ernie Raelee865f32023-09-29 19:53:55 +02002255 else if (lp->ll_object != NULL) // This check must be before ll_class.
2256 {
2257 // (un)lock an object variable.
2258 report_lockvar_member(e_cannot_lock_object_variable_str, lp);
2259 ret = FAIL;
2260 }
2261 else if (lp->ll_class != NULL)
2262 {
2263 // (un)lock a class variable.
2264 report_lockvar_member(e_cannot_lock_class_variable_str, lp);
2265 ret = FAIL;
2266 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002267 else
Ernie Raelee865f32023-09-29 19:53:55 +02002268 {
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002269 // (un)lock a Dictionary item.
Ernie Raelee865f32023-09-29 19:53:55 +02002270 if (lp->ll_di == NULL)
2271 {
2272 emsg(_(e_dictionary_required));
2273 ret = FAIL;
2274 }
2275 else
2276 item_lock(&lp->ll_di->di_tv, deep, lock, FALSE);
2277 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002278
2279 return ret;
2280}
2281
2282/*
2283 * Lock or unlock an item. "deep" is nr of levels to go.
Bram Moolenaar021bda52020-08-17 21:07:22 +02002284 * When "check_refcount" is TRUE do not lock a list or dict with a reference
2285 * count larger than 1.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002286 */
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +02002287 void
Bram Moolenaar021bda52020-08-17 21:07:22 +02002288item_lock(typval_T *tv, int deep, int lock, int check_refcount)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002289{
2290 static int recurse = 0;
2291 list_T *l;
2292 listitem_T *li;
2293 dict_T *d;
2294 blob_T *b;
2295 hashitem_T *hi;
2296 int todo;
2297
Ernie Raelee865f32023-09-29 19:53:55 +02002298#ifdef LOG_LOCKVAR
Ernie Rael64885642023-10-04 20:16:22 +02002299 ch_log(NULL, "LKVAR: item_lock(): type %s", vartype_name(tv->v_type));
Ernie Raelee865f32023-09-29 19:53:55 +02002300#endif
2301
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002302 if (recurse >= DICT_MAXNEST)
2303 {
Bram Moolenaar677658a2022-01-05 16:09:06 +00002304 emsg(_(e_variable_nested_too_deep_for_unlock));
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002305 return;
2306 }
2307 if (deep == 0)
2308 return;
2309 ++recurse;
2310
2311 // lock/unlock the item itself
2312 if (lock)
2313 tv->v_lock |= VAR_LOCKED;
2314 else
2315 tv->v_lock &= ~VAR_LOCKED;
2316
2317 switch (tv->v_type)
2318 {
2319 case VAR_UNKNOWN:
Bram Moolenaar4c683752020-04-05 21:38:23 +02002320 case VAR_ANY:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002321 case VAR_VOID:
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002322 case VAR_NUMBER:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002323 case VAR_BOOL:
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002324 case VAR_STRING:
2325 case VAR_FUNC:
2326 case VAR_PARTIAL:
2327 case VAR_FLOAT:
2328 case VAR_SPECIAL:
2329 case VAR_JOB:
2330 case VAR_CHANNEL:
Bram Moolenaarf18332f2021-05-07 17:55:55 +02002331 case VAR_INSTR:
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002332 case VAR_CLASS:
2333 case VAR_OBJECT:
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002334 break;
2335
2336 case VAR_BLOB:
Bram Moolenaar021bda52020-08-17 21:07:22 +02002337 if ((b = tv->vval.v_blob) != NULL
2338 && !(check_refcount && b->bv_refcount > 1))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002339 {
2340 if (lock)
2341 b->bv_lock |= VAR_LOCKED;
2342 else
2343 b->bv_lock &= ~VAR_LOCKED;
2344 }
2345 break;
2346 case VAR_LIST:
Bram Moolenaar021bda52020-08-17 21:07:22 +02002347 if ((l = tv->vval.v_list) != NULL
2348 && !(check_refcount && l->lv_refcount > 1))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002349 {
2350 if (lock)
2351 l->lv_lock |= VAR_LOCKED;
2352 else
2353 l->lv_lock &= ~VAR_LOCKED;
Bram Moolenaar70c43d82022-01-26 21:01:15 +00002354 if (deep < 0 || deep > 1)
2355 {
2356 if (l->lv_first == &range_list_item)
2357 l->lv_lock |= VAR_ITEMS_LOCKED;
2358 else
2359 {
2360 // recursive: lock/unlock the items the List contains
2361 CHECK_LIST_MATERIALIZE(l);
2362 FOR_ALL_LIST_ITEMS(l, li) item_lock(&li->li_tv,
2363 deep - 1, lock, check_refcount);
2364 }
2365 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002366 }
2367 break;
2368 case VAR_DICT:
Bram Moolenaar021bda52020-08-17 21:07:22 +02002369 if ((d = tv->vval.v_dict) != NULL
2370 && !(check_refcount && d->dv_refcount > 1))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002371 {
2372 if (lock)
2373 d->dv_lock |= VAR_LOCKED;
2374 else
2375 d->dv_lock &= ~VAR_LOCKED;
2376 if (deep < 0 || deep > 1)
2377 {
2378 // recursive: lock/unlock the items the List contains
2379 todo = (int)d->dv_hashtab.ht_used;
Yegappan Lakshmanan14113fd2023-03-07 17:13:51 +00002380 FOR_ALL_HASHTAB_ITEMS(&d->dv_hashtab, hi, todo)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002381 {
2382 if (!HASHITEM_EMPTY(hi))
2383 {
2384 --todo;
Bram Moolenaar021bda52020-08-17 21:07:22 +02002385 item_lock(&HI2DI(hi)->di_tv, deep - 1, lock,
2386 check_refcount);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002387 }
2388 }
2389 }
2390 }
2391 }
2392 --recurse;
2393}
2394
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002395#if (defined(FEAT_MENU) && defined(FEAT_MULTI_LANG)) || defined(PROTO)
2396/*
2397 * Delete all "menutrans_" variables.
2398 */
2399 void
2400del_menutrans_vars(void)
2401{
2402 hashitem_T *hi;
2403 int todo;
2404
2405 hash_lock(&globvarht);
2406 todo = (int)globvarht.ht_used;
2407 for (hi = globvarht.ht_array; todo > 0 && !got_int; ++hi)
2408 {
2409 if (!HASHITEM_EMPTY(hi))
2410 {
2411 --todo;
2412 if (STRNCMP(HI2DI(hi)->di_key, "menutrans_", 10) == 0)
2413 delete_var(&globvarht, hi);
2414 }
2415 }
2416 hash_unlock(&globvarht);
2417}
2418#endif
2419
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002420/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002421 * Local string buffer for the next two functions to store a variable name
2422 * with its prefix. Allocated in cat_prefix_varname(), freed later in
2423 * get_user_var_name().
2424 */
2425
2426static char_u *varnamebuf = NULL;
2427static int varnamebuflen = 0;
2428
2429/*
2430 * Function to concatenate a prefix and a variable name.
2431 */
Bram Moolenaar1bb4de52021-01-13 19:48:46 +01002432 char_u *
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002433cat_prefix_varname(int prefix, char_u *name)
2434{
2435 int len;
2436
2437 len = (int)STRLEN(name) + 3;
2438 if (len > varnamebuflen)
2439 {
2440 vim_free(varnamebuf);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02002441 len += 10; // some additional space
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002442 varnamebuf = alloc(len);
2443 if (varnamebuf == NULL)
2444 {
2445 varnamebuflen = 0;
2446 return NULL;
2447 }
2448 varnamebuflen = len;
2449 }
2450 *varnamebuf = prefix;
2451 varnamebuf[1] = ':';
2452 STRCPY(varnamebuf + 2, name);
2453 return varnamebuf;
2454}
2455
2456/*
2457 * Function given to ExpandGeneric() to obtain the list of user defined
2458 * (global/buffer/window/built-in) variable names.
2459 */
2460 char_u *
2461get_user_var_name(expand_T *xp, int idx)
2462{
2463 static long_u gdone;
2464 static long_u bdone;
2465 static long_u wdone;
2466 static long_u tdone;
2467 static int vidx;
2468 static hashitem_T *hi;
2469 hashtab_T *ht;
2470
2471 if (idx == 0)
2472 {
2473 gdone = bdone = wdone = vidx = 0;
2474 tdone = 0;
2475 }
2476
2477 // Global variables
2478 if (gdone < globvarht.ht_used)
2479 {
2480 if (gdone++ == 0)
2481 hi = globvarht.ht_array;
2482 else
2483 ++hi;
2484 while (HASHITEM_EMPTY(hi))
2485 ++hi;
2486 if (STRNCMP("g:", xp->xp_pattern, 2) == 0)
2487 return cat_prefix_varname('g', hi->hi_key);
2488 return hi->hi_key;
2489 }
2490
2491 // b: variables
Bram Moolenaar0f6e28f2022-02-20 20:49:35 +00002492 ht = &prevwin_curwin()->w_buffer->b_vars->dv_hashtab;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002493 if (bdone < ht->ht_used)
2494 {
2495 if (bdone++ == 0)
2496 hi = ht->ht_array;
2497 else
2498 ++hi;
2499 while (HASHITEM_EMPTY(hi))
2500 ++hi;
2501 return cat_prefix_varname('b', hi->hi_key);
2502 }
2503
2504 // w: variables
Bram Moolenaar0f6e28f2022-02-20 20:49:35 +00002505 ht = &prevwin_curwin()->w_vars->dv_hashtab;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002506 if (wdone < ht->ht_used)
2507 {
2508 if (wdone++ == 0)
2509 hi = ht->ht_array;
2510 else
2511 ++hi;
2512 while (HASHITEM_EMPTY(hi))
2513 ++hi;
2514 return cat_prefix_varname('w', hi->hi_key);
2515 }
2516
2517 // t: variables
2518 ht = &curtab->tp_vars->dv_hashtab;
2519 if (tdone < ht->ht_used)
2520 {
2521 if (tdone++ == 0)
2522 hi = ht->ht_array;
2523 else
2524 ++hi;
2525 while (HASHITEM_EMPTY(hi))
2526 ++hi;
2527 return cat_prefix_varname('t', hi->hi_key);
2528 }
2529
2530 // v: variables
2531 if (vidx < VV_LEN)
2532 return cat_prefix_varname('v', (char_u *)vimvars[vidx++].vv_name);
2533
2534 VIM_CLEAR(varnamebuf);
2535 varnamebuflen = 0;
2536 return NULL;
2537}
2538
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002539 char *
2540get_var_special_name(int nr)
2541{
2542 switch (nr)
2543 {
Bram Moolenaara8b8af12021-01-01 15:11:04 +01002544 case VVAL_FALSE: return in_vim9script() ? "false" : "v:false";
2545 case VVAL_TRUE: return in_vim9script() ? "true" : "v:true";
Bram Moolenaar67977822021-01-03 21:53:53 +01002546 case VVAL_NULL: return in_vim9script() ? "null" : "v:null";
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002547 case VVAL_NONE: return "v:none";
Bram Moolenaarda6c0332019-09-01 16:01:30 +02002548 }
2549 internal_error("get_var_special_name()");
2550 return "42";
2551}
2552
2553/*
2554 * Returns the global variable dictionary
2555 */
2556 dict_T *
2557get_globvar_dict(void)
2558{
2559 return &globvardict;
2560}
2561
2562/*
2563 * Returns the global variable hash table
2564 */
2565 hashtab_T *
2566get_globvar_ht(void)
2567{
2568 return &globvarht;
2569}
2570
2571/*
2572 * Returns the v: variable dictionary
2573 */
2574 dict_T *
2575get_vimvar_dict(void)
2576{
2577 return &vimvardict;
2578}
2579
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002580/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002581 * Returns the index of a v:variable. Negative if not found.
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002582 * Returns DI_ flags in "di_flags".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002583 */
2584 int
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002585find_vim_var(char_u *name, int *di_flags)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002586{
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002587 dictitem_T *di = find_var_in_ht(&vimvarht, 0, name, TRUE);
2588 struct vimvar *vv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002589
2590 if (di == NULL)
2591 return -1;
Bram Moolenaar5da356e2020-04-09 19:34:43 +02002592 *di_flags = di->di_flags;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002593 vv = (struct vimvar *)((char *)di - offsetof(vimvar_T, vv_di));
2594 return (int)(vv - vimvars);
2595}
2596
2597
2598/*
Bram Moolenaar34ed68d2019-08-29 22:48:24 +02002599 * Set type of v: variable to "type".
2600 */
2601 void
2602set_vim_var_type(int idx, vartype_T type)
2603{
Bram Moolenaard787e402021-12-24 21:36:12 +00002604 vimvars[idx].vv_tv_type = type;
Bram Moolenaar34ed68d2019-08-29 22:48:24 +02002605}
2606
2607/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002608 * Set number v: variable to "val".
Bram Moolenaar8d71b542019-08-30 15:46:30 +02002609 * Note that this does not set the type, use set_vim_var_type() for that.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002610 */
2611 void
2612set_vim_var_nr(int idx, varnumber_T val)
2613{
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002614 vimvars[idx].vv_nr = val;
2615}
2616
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002617 char *
2618get_vim_var_name(int idx)
2619{
2620 return vimvars[idx].vv_name;
2621}
2622
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002623/*
2624 * Get typval_T v: variable value.
2625 */
2626 typval_T *
2627get_vim_var_tv(int idx)
2628{
2629 return &vimvars[idx].vv_tv;
2630}
2631
Bram Moolenaard787e402021-12-24 21:36:12 +00002632 type_T *
2633get_vim_var_type(int idx, garray_T *type_list)
2634{
2635 if (vimvars[idx].vv_type != NULL)
2636 return vimvars[idx].vv_type;
2637 return typval2type_vimvar(&vimvars[idx].vv_tv, type_list);
2638}
2639
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002640/*
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002641 * Set v: variable to "tv". Only accepts the same type.
2642 * Takes over the value of "tv".
2643 */
2644 int
2645set_vim_var_tv(int idx, typval_T *tv)
2646{
Bram Moolenaard787e402021-12-24 21:36:12 +00002647 if (vimvars[idx].vv_tv_type != tv->v_type)
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002648 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02002649 emsg(_(e_type_mismatch_for_v_variable));
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002650 clear_tv(tv);
2651 return FAIL;
2652 }
Bram Moolenaarcab27672020-04-09 20:10:55 +02002653 // VV_RO is also checked when compiling, but let's check here as well.
2654 if (vimvars[idx].vv_flags & VV_RO)
2655 {
Bram Moolenaard8e44472021-07-21 22:20:33 +02002656 semsg(_(e_cannot_change_readonly_variable_str), vimvars[idx].vv_name);
Bram Moolenaarcab27672020-04-09 20:10:55 +02002657 return FAIL;
2658 }
2659 if (sandbox && (vimvars[idx].vv_flags & VV_RO_SBX))
2660 {
Bram Moolenaar71b76852021-12-17 20:15:38 +00002661 semsg(_(e_cannot_set_variable_in_sandbox_str), vimvars[idx].vv_name);
Bram Moolenaarcab27672020-04-09 20:10:55 +02002662 return FAIL;
2663 }
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01002664 clear_tv(&vimvars[idx].vv_di.di_tv);
2665 vimvars[idx].vv_di.di_tv = *tv;
2666 return OK;
2667}
2668
2669/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002670 * Get number v: variable value.
2671 */
2672 varnumber_T
2673get_vim_var_nr(int idx)
2674{
2675 return vimvars[idx].vv_nr;
2676}
2677
2678/*
2679 * Get string v: variable value. Uses a static buffer, can only be used once.
2680 * If the String variable has never been set, return an empty string.
2681 * Never returns NULL;
2682 */
2683 char_u *
2684get_vim_var_str(int idx)
2685{
2686 return tv_get_string(&vimvars[idx].vv_tv);
2687}
2688
2689/*
2690 * Get List v: variable value. Caller must take care of reference count when
2691 * needed.
2692 */
2693 list_T *
2694get_vim_var_list(int idx)
2695{
2696 return vimvars[idx].vv_list;
2697}
2698
2699/*
2700 * Get Dict v: variable value. Caller must take care of reference count when
2701 * needed.
2702 */
2703 dict_T *
2704get_vim_var_dict(int idx)
2705{
2706 return vimvars[idx].vv_dict;
2707}
2708
2709/*
2710 * Set v:char to character "c".
2711 */
2712 void
2713set_vim_var_char(int c)
2714{
2715 char_u buf[MB_MAXBYTES + 1];
2716
2717 if (has_mbyte)
2718 buf[(*mb_char2bytes)(c, buf)] = NUL;
2719 else
2720 {
2721 buf[0] = c;
2722 buf[1] = NUL;
2723 }
2724 set_vim_var_string(VV_CHAR, buf, -1);
2725}
2726
2727/*
2728 * Set v:count to "count" and v:count1 to "count1".
2729 * When "set_prevcount" is TRUE first set v:prevcount from v:count.
2730 */
2731 void
2732set_vcount(
2733 long count,
2734 long count1,
2735 int set_prevcount)
2736{
2737 if (set_prevcount)
2738 vimvars[VV_PREVCOUNT].vv_nr = vimvars[VV_COUNT].vv_nr;
2739 vimvars[VV_COUNT].vv_nr = count;
2740 vimvars[VV_COUNT1].vv_nr = count1;
2741}
2742
2743/*
2744 * Save variables that might be changed as a side effect. Used when executing
2745 * a timer callback.
2746 */
2747 void
2748save_vimvars(vimvars_save_T *vvsave)
2749{
2750 vvsave->vv_prevcount = vimvars[VV_PREVCOUNT].vv_nr;
2751 vvsave->vv_count = vimvars[VV_COUNT].vv_nr;
2752 vvsave->vv_count1 = vimvars[VV_COUNT1].vv_nr;
2753}
2754
2755/*
2756 * Restore variables saved by save_vimvars().
2757 */
2758 void
2759restore_vimvars(vimvars_save_T *vvsave)
2760{
2761 vimvars[VV_PREVCOUNT].vv_nr = vvsave->vv_prevcount;
2762 vimvars[VV_COUNT].vv_nr = vvsave->vv_count;
2763 vimvars[VV_COUNT1].vv_nr = vvsave->vv_count1;
2764}
2765
2766/*
2767 * Set string v: variable to a copy of "val". If 'copy' is FALSE, then set the
2768 * value.
2769 */
2770 void
2771set_vim_var_string(
2772 int idx,
2773 char_u *val,
2774 int len) // length of "val" to use or -1 (whole string)
2775{
2776 clear_tv(&vimvars[idx].vv_di.di_tv);
Bram Moolenaard787e402021-12-24 21:36:12 +00002777 vimvars[idx].vv_tv_type = VAR_STRING;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002778 if (val == NULL)
2779 vimvars[idx].vv_str = NULL;
2780 else if (len == -1)
2781 vimvars[idx].vv_str = vim_strsave(val);
2782 else
2783 vimvars[idx].vv_str = vim_strnsave(val, len);
2784}
2785
2786/*
2787 * Set List v: variable to "val".
2788 */
2789 void
2790set_vim_var_list(int idx, list_T *val)
2791{
2792 clear_tv(&vimvars[idx].vv_di.di_tv);
Bram Moolenaard787e402021-12-24 21:36:12 +00002793 vimvars[idx].vv_tv_type = VAR_LIST;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002794 vimvars[idx].vv_list = val;
2795 if (val != NULL)
2796 ++val->lv_refcount;
2797}
2798
2799/*
2800 * Set Dictionary v: variable to "val".
2801 */
2802 void
2803set_vim_var_dict(int idx, dict_T *val)
2804{
2805 clear_tv(&vimvars[idx].vv_di.di_tv);
Bram Moolenaard787e402021-12-24 21:36:12 +00002806 vimvars[idx].vv_tv_type = VAR_DICT;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002807 vimvars[idx].vv_dict = val;
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00002808 if (val == NULL)
2809 return;
2810
2811 ++val->dv_refcount;
2812 dict_set_items_ro(val);
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002813}
2814
2815/*
Bram Moolenaar69bf6342019-10-29 04:16:57 +01002816 * Set the v:argv list.
2817 */
2818 void
2819set_argv_var(char **argv, int argc)
2820{
2821 list_T *l = list_alloc();
2822 int i;
2823
2824 if (l == NULL)
2825 getout(1);
2826 l->lv_lock = VAR_FIXED;
2827 for (i = 0; i < argc; ++i)
2828 {
2829 if (list_append_string(l, (char_u *)argv[i], -1) == FAIL)
2830 getout(1);
Bram Moolenaar0ff6aad2020-01-29 21:27:21 +01002831 l->lv_u.mat.lv_last->li_tv.v_lock = VAR_FIXED;
Bram Moolenaar69bf6342019-10-29 04:16:57 +01002832 }
2833 set_vim_var_list(VV_ARGV, l);
2834}
2835
2836/*
Bram Moolenaar439c0362020-06-06 15:58:03 +02002837 * Reset v:register, taking the 'clipboard' setting into account.
2838 */
2839 void
2840reset_reg_var(void)
2841{
2842 int regname = 0;
2843
2844 // Adjust the register according to 'clipboard', so that when
2845 // "unnamed" is present it becomes '*' or '+' instead of '"'.
2846#ifdef FEAT_CLIPBOARD
2847 adjust_clip_reg(&regname);
2848#endif
2849 set_reg_var(regname);
2850}
2851
2852/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02002853 * Set v:register if needed.
2854 */
2855 void
2856set_reg_var(int c)
2857{
2858 char_u regname;
2859
2860 if (c == 0 || c == ' ')
2861 regname = '"';
2862 else
2863 regname = c;
2864 // Avoid free/alloc when the value is already right.
2865 if (vimvars[VV_REG].vv_str == NULL || vimvars[VV_REG].vv_str[0] != c)
2866 set_vim_var_string(VV_REG, &regname, 1);
2867}
2868
2869/*
2870 * Get or set v:exception. If "oldval" == NULL, return the current value.
2871 * Otherwise, restore the value to "oldval" and return NULL.
2872 * Must always be called in pairs to save and restore v:exception! Does not
2873 * take care of memory allocations.
2874 */
2875 char_u *
2876v_exception(char_u *oldval)
2877{
2878 if (oldval == NULL)
2879 return vimvars[VV_EXCEPTION].vv_str;
2880
2881 vimvars[VV_EXCEPTION].vv_str = oldval;
2882 return NULL;
2883}
2884
2885/*
2886 * Get or set v:throwpoint. If "oldval" == NULL, return the current value.
2887 * Otherwise, restore the value to "oldval" and return NULL.
2888 * Must always be called in pairs to save and restore v:throwpoint! Does not
2889 * take care of memory allocations.
2890 */
2891 char_u *
2892v_throwpoint(char_u *oldval)
2893{
2894 if (oldval == NULL)
2895 return vimvars[VV_THROWPOINT].vv_str;
2896
2897 vimvars[VV_THROWPOINT].vv_str = oldval;
2898 return NULL;
2899}
2900
2901/*
2902 * Set v:cmdarg.
2903 * If "eap" != NULL, use "eap" to generate the value and return the old value.
2904 * If "oldarg" != NULL, restore the value to "oldarg" and return NULL.
2905 * Must always be called in pairs!
2906 */
2907 char_u *
2908set_cmdarg(exarg_T *eap, char_u *oldarg)
2909{
2910 char_u *oldval;
2911 char_u *newval;
2912 unsigned len;
2913
2914 oldval = vimvars[VV_CMDARG].vv_str;
2915 if (eap == NULL)
2916 {
2917 vim_free(oldval);
2918 vimvars[VV_CMDARG].vv_str = oldarg;
2919 return NULL;
2920 }
2921
2922 if (eap->force_bin == FORCE_BIN)
2923 len = 6;
2924 else if (eap->force_bin == FORCE_NOBIN)
2925 len = 8;
2926 else
2927 len = 0;
2928
2929 if (eap->read_edit)
2930 len += 7;
2931
2932 if (eap->force_ff != 0)
2933 len += 10; // " ++ff=unix"
2934 if (eap->force_enc != 0)
2935 len += (unsigned)STRLEN(eap->cmd + eap->force_enc) + 7;
2936 if (eap->bad_char != 0)
2937 len += 7 + 4; // " ++bad=" + "keep" or "drop"
2938
2939 newval = alloc(len + 1);
2940 if (newval == NULL)
2941 return NULL;
2942
2943 if (eap->force_bin == FORCE_BIN)
2944 sprintf((char *)newval, " ++bin");
2945 else if (eap->force_bin == FORCE_NOBIN)
2946 sprintf((char *)newval, " ++nobin");
2947 else
2948 *newval = NUL;
2949
2950 if (eap->read_edit)
2951 STRCAT(newval, " ++edit");
2952
2953 if (eap->force_ff != 0)
2954 sprintf((char *)newval + STRLEN(newval), " ++ff=%s",
2955 eap->force_ff == 'u' ? "unix"
2956 : eap->force_ff == 'd' ? "dos"
2957 : "mac");
2958 if (eap->force_enc != 0)
2959 sprintf((char *)newval + STRLEN(newval), " ++enc=%s",
2960 eap->cmd + eap->force_enc);
2961 if (eap->bad_char == BAD_KEEP)
2962 STRCPY(newval + STRLEN(newval), " ++bad=keep");
2963 else if (eap->bad_char == BAD_DROP)
2964 STRCPY(newval + STRLEN(newval), " ++bad=drop");
2965 else if (eap->bad_char != 0)
2966 sprintf((char *)newval + STRLEN(newval), " ++bad=%c", eap->bad_char);
2967 vimvars[VV_CMDARG].vv_str = newval;
2968 return oldval;
2969}
2970
2971/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002972 * Get the value of internal variable "name".
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002973 * If "flags" has EVAL_VAR_IMPORT may return a VAR_ANY with v_number set to the
2974 * imported script ID.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002975 * Return OK or FAIL. If OK is returned "rettv" must be cleared.
2976 */
2977 int
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02002978eval_variable(
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002979 char_u *name,
Bram Moolenaar94674f22023-01-06 18:42:20 +00002980 int len, // length of "name" or zero
Bram Moolenaard5f400c2022-01-06 21:10:28 +00002981 scid_T sid, // script ID for imported item or zero
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002982 typval_T *rettv, // NULL when only checking existence
2983 dictitem_T **dip, // non-NULL when typval's dict item is needed
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002984 int flags) // EVAL_VAR_ flags
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002985{
2986 int ret = OK;
2987 typval_T *tv = NULL;
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01002988 int found = FALSE;
Bram Moolenaarf055d452021-07-08 20:57:24 +02002989 hashtab_T *ht = NULL;
Bram Moolenaar94674f22023-01-06 18:42:20 +00002990 int cc = 0;
Bram Moolenaarc967d572021-07-08 21:38:50 +02002991 type_T *type = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002992
Bram Moolenaar94674f22023-01-06 18:42:20 +00002993 if (len > 0)
2994 {
2995 // truncate the name, so that we can use strcmp()
2996 cc = name[len];
2997 name[len] = NUL;
2998 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02002999
Bram Moolenaar1b0a9dd2021-06-14 21:32:21 +02003000 // Check for local variable when debugging.
3001 if ((tv = lookup_debug_var(name)) == NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003002 {
Bram Moolenaar1b0a9dd2021-06-14 21:32:21 +02003003 // Check for user-defined variables.
Bram Moolenaarc967d572021-07-08 21:38:50 +02003004 dictitem_T *v = find_var(name, &ht, flags & EVAL_VAR_NOAUTOLOAD);
3005
Bram Moolenaar1b0a9dd2021-06-14 21:32:21 +02003006 if (v != NULL)
3007 {
3008 tv = &v->di_tv;
3009 if (dip != NULL)
3010 *dip = v;
3011 }
Bram Moolenaarc967d572021-07-08 21:38:50 +02003012 else
3013 ht = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003014 }
3015
Bram Moolenaareb6880b2020-07-12 17:07:05 +02003016 if (tv == NULL && (in_vim9script() || STRNCMP(name, "s:", 2) == 0))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003017 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003018 imported_T *import = NULL;
Bram Moolenaar9721fb42020-06-11 23:10:46 +02003019 char_u *p = STRNCMP(name, "s:", 2) == 0 ? name + 2 : name;
3020
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003021 if (sid == 0)
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00003022 import = find_imported(p, 0, TRUE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003023
3024 // imported variable from another script
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003025 if (import != NULL || sid != 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003026 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003027 if ((flags & EVAL_VAR_IMPORT) == 0)
Bram Moolenaarc620c052020-07-08 15:16:19 +02003028 {
Bram Moolenaar71f21932022-01-07 18:20:55 +00003029 if (SCRIPT_ID_VALID(sid))
Bram Moolenaarc620c052020-07-08 15:16:19 +02003030 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003031 ht = &SCRIPT_VARS(sid);
3032 if (ht != NULL)
3033 {
3034 dictitem_T *v = find_var_in_ht(ht, 0, name,
3035 flags & EVAL_VAR_NOAUTOLOAD);
3036
3037 if (v != NULL)
3038 {
3039 tv = &v->di_tv;
3040 if (dip != NULL)
3041 *dip = v;
3042 }
3043 else
3044 ht = NULL;
3045 }
Bram Moolenaarc620c052020-07-08 15:16:19 +02003046 }
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003047 else
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01003048 {
3049 if (flags & EVAL_VAR_VERBOSE)
Bram Moolenaardd5893b2022-01-20 21:32:54 +00003050 semsg(_(e_expected_dot_after_name_str), name);
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01003051 ret = FAIL;
3052 }
Bram Moolenaarf6a44f72020-09-27 13:51:14 +02003053 }
Bram Moolenaarc620c052020-07-08 15:16:19 +02003054 else
3055 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003056 if (rettv != NULL)
3057 {
Bram Moolenaar753885b2022-08-24 16:30:36 +01003058 // special value that is used in handle_subscript()
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003059 rettv->v_type = VAR_ANY;
3060 rettv->vval.v_number = sid != 0 ? sid : import->imp_sid;
3061 }
3062 found = TRUE;
Bram Moolenaarc620c052020-07-08 15:16:19 +02003063 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003064 }
Bram Moolenaar052ff292021-12-11 13:54:46 +00003065 else if (in_vim9script() && (flags & EVAL_VAR_NO_FUNC) == 0)
Bram Moolenaar601e76a2020-08-27 21:33:10 +02003066 {
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003067 int has_g_prefix = STRNCMP(name, "g:", 2) == 0;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003068 ufunc_T *ufunc = find_func(name, FALSE);
Bram Moolenaar601e76a2020-08-27 21:33:10 +02003069
Bram Moolenaarb033ee22021-08-15 16:08:36 +02003070 // In Vim9 script we can get a function reference by using the
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003071 // function name. For a global non-autoload function "g:" is
3072 // required.
3073 if (ufunc != NULL && (has_g_prefix
3074 || !func_requires_g_prefix(ufunc)))
Bram Moolenaar601e76a2020-08-27 21:33:10 +02003075 {
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01003076 found = TRUE;
Bram Moolenaar601e76a2020-08-27 21:33:10 +02003077 if (rettv != NULL)
3078 {
3079 rettv->v_type = VAR_FUNC;
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003080 if (has_g_prefix)
Bram Moolenaaref082e12021-12-12 21:02:03 +00003081 // Keep the "g:", otherwise script-local may be
3082 // assumed.
3083 rettv->vval.v_string = vim_strsave(name);
3084 else
3085 rettv->vval.v_string = vim_strsave(ufunc->uf_name);
Bram Moolenaarb033ee22021-08-15 16:08:36 +02003086 if (rettv->vval.v_string != NULL)
3087 func_ref(ufunc->uf_name);
Bram Moolenaar601e76a2020-08-27 21:33:10 +02003088 }
3089 }
3090 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003091 }
3092
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01003093 if (!found)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003094 {
Bram Moolenaarc620c052020-07-08 15:16:19 +02003095 if (tv == NULL)
3096 {
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01003097 if (rettv != NULL && (flags & EVAL_VAR_VERBOSE))
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003098 semsg(_(e_undefined_variable_str), name);
Bram Moolenaarc620c052020-07-08 15:16:19 +02003099 ret = FAIL;
3100 }
3101 else if (rettv != NULL)
Bram Moolenaar348be7e2020-11-04 11:36:35 +01003102 {
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003103 svar_T *sv = NULL;
3104 int was_assigned = FALSE;
3105
Bram Moolenaar11005b02021-07-11 20:59:00 +02003106 if (ht != NULL && ht == get_script_local_ht()
3107 && tv != &SCRIPT_SV(current_sctx.sc_sid)->sv_var.di_tv)
Bram Moolenaarf055d452021-07-08 20:57:24 +02003108 {
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003109 sv = find_typval_in_script(tv, 0, TRUE);
Bram Moolenaarf055d452021-07-08 20:57:24 +02003110 if (sv != NULL)
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003111 {
Bram Moolenaarf055d452021-07-08 20:57:24 +02003112 type = sv->sv_type;
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003113 was_assigned = sv->sv_flags & SVFLAG_ASSIGNED;
3114 }
Bram Moolenaarf055d452021-07-08 20:57:24 +02003115 }
3116
Bram Moolenaarec15b1c2022-03-27 16:29:53 +01003117 // If a list or dict variable wasn't initialized and has meaningful
3118 // type, do it now. Not for global variables, they are not
3119 // declared.
Bram Moolenaar7a222242022-03-01 19:23:24 +00003120 if (ht != &globvarht)
Bram Moolenaar348be7e2020-11-04 11:36:35 +01003121 {
Bram Moolenaarec15b1c2022-03-27 16:29:53 +01003122 if (tv->v_type == VAR_DICT && tv->vval.v_dict == NULL
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003123 && ((type != NULL && !was_assigned)
Bram Moolenaar859cc212022-03-28 15:22:35 +01003124 || !in_vim9script()))
Bram Moolenaarf055d452021-07-08 20:57:24 +02003125 {
Bram Moolenaar7a222242022-03-01 19:23:24 +00003126 tv->vval.v_dict = dict_alloc();
3127 if (tv->vval.v_dict != NULL)
3128 {
3129 ++tv->vval.v_dict->dv_refcount;
3130 tv->vval.v_dict->dv_type = alloc_type(type);
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003131 if (sv != NULL)
3132 sv->sv_flags |= SVFLAG_ASSIGNED;
Bram Moolenaar7a222242022-03-01 19:23:24 +00003133 }
Bram Moolenaarf055d452021-07-08 20:57:24 +02003134 }
Bram Moolenaarec15b1c2022-03-27 16:29:53 +01003135 else if (tv->v_type == VAR_LIST && tv->vval.v_list == NULL
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003136 && ((type != NULL && !was_assigned)
Bram Moolenaar501f9782022-03-27 16:51:04 +01003137 || !in_vim9script()))
Bram Moolenaarf055d452021-07-08 20:57:24 +02003138 {
Bram Moolenaar7a222242022-03-01 19:23:24 +00003139 tv->vval.v_list = list_alloc();
3140 if (tv->vval.v_list != NULL)
3141 {
3142 ++tv->vval.v_list->lv_refcount;
3143 tv->vval.v_list->lv_type = alloc_type(type);
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003144 if (sv != NULL)
3145 sv->sv_flags |= SVFLAG_ASSIGNED;
Bram Moolenaar7a222242022-03-01 19:23:24 +00003146 }
Bram Moolenaarf055d452021-07-08 20:57:24 +02003147 }
Bram Moolenaar859cc212022-03-28 15:22:35 +01003148 else if (tv->v_type == VAR_BLOB && tv->vval.v_blob == NULL
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003149 && ((type != NULL && !was_assigned)
Bram Moolenaar859cc212022-03-28 15:22:35 +01003150 || !in_vim9script()))
3151 {
3152 tv->vval.v_blob = blob_alloc();
3153 if (tv->vval.v_blob != NULL)
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003154 {
Bram Moolenaar859cc212022-03-28 15:22:35 +01003155 ++tv->vval.v_blob->bv_refcount;
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003156 if (sv != NULL)
3157 sv->sv_flags |= SVFLAG_ASSIGNED;
3158 }
Bram Moolenaar859cc212022-03-28 15:22:35 +01003159 }
Bram Moolenaarb7c21af2021-04-18 14:12:31 +02003160 }
Bram Moolenaarc620c052020-07-08 15:16:19 +02003161 copy_tv(tv, rettv);
Bram Moolenaar348be7e2020-11-04 11:36:35 +01003162 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003163 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003164
Bram Moolenaar94674f22023-01-06 18:42:20 +00003165 if (len > 0)
3166 name[len] = cc;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003167
3168 return ret;
3169}
3170
3171/*
Bram Moolenaara86655a2023-01-12 17:06:27 +00003172 * Get the value of internal variable "name", also handling "import.name".
3173 * Return OK or FAIL. If OK is returned "rettv" must be cleared.
3174 */
3175 int
3176eval_variable_import(
3177 char_u *name,
3178 typval_T *rettv)
3179{
3180 char_u *s = name;
3181 while (ASCII_ISALNUM(*s) || *s == '_')
3182 ++s;
3183 int len = (int)(s - name);
3184
3185 if (eval_variable(name, len, 0, rettv, NULL, EVAL_VAR_IMPORT) == FAIL)
3186 return FAIL;
3187 if (rettv->v_type == VAR_ANY && *s == '.')
3188 {
Bram Moolenaar40594002023-01-12 20:04:51 +00003189 char_u *ns = s + 1;
3190 s = ns;
3191 while (ASCII_ISALNUM(*s) || *s == '_')
3192 ++s;
Bram Moolenaara86655a2023-01-12 17:06:27 +00003193 int sid = rettv->vval.v_number;
Bram Moolenaar40594002023-01-12 20:04:51 +00003194 return eval_variable(ns, (int)(s - ns), sid, rettv, NULL, 0);
Bram Moolenaara86655a2023-01-12 17:06:27 +00003195 }
3196 return OK;
3197}
3198
3199
3200/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003201 * Check if variable "name[len]" is a local variable or an argument.
3202 * If so, "*eval_lavars_used" is set to TRUE.
3203 */
3204 void
3205check_vars(char_u *name, int len)
3206{
3207 int cc;
3208 char_u *varname;
3209 hashtab_T *ht;
3210
3211 if (eval_lavars_used == NULL)
3212 return;
3213
3214 // truncate the name, so that we can use strcmp()
3215 cc = name[len];
3216 name[len] = NUL;
3217
3218 ht = find_var_ht(name, &varname);
3219 if (ht == get_funccal_local_ht() || ht == get_funccal_args_ht())
3220 {
3221 if (find_var(name, NULL, TRUE) != NULL)
3222 *eval_lavars_used = TRUE;
3223 }
3224
3225 name[len] = cc;
3226}
3227
3228/*
3229 * Find variable "name" in the list of variables.
3230 * Return a pointer to it if found, NULL if not found.
3231 * Careful: "a:0" variables don't have a name.
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003232 * When "htp" is not NULL set "htp" to the hashtab_T used.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003233 */
3234 dictitem_T *
3235find_var(char_u *name, hashtab_T **htp, int no_autoload)
3236{
3237 char_u *varname;
3238 hashtab_T *ht;
3239 dictitem_T *ret = NULL;
3240
3241 ht = find_var_ht(name, &varname);
3242 if (htp != NULL)
3243 *htp = ht;
3244 if (ht == NULL)
3245 return NULL;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003246 ret = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003247 if (ret != NULL)
3248 return ret;
3249
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003250 // Search in parent scope for lambda
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003251 ret = find_var_in_scoped_ht(name, no_autoload);
Bram Moolenaar2ea95b62020-11-19 21:47:56 +01003252 if (ret != NULL)
3253 return ret;
3254
3255 // in Vim9 script items without a scope can be script-local
3256 if (in_vim9script() && name[0] != NUL && name[1] != ':')
3257 {
3258 ht = get_script_local_ht();
3259 if (ht != NULL)
3260 {
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003261 ret = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar2ea95b62020-11-19 21:47:56 +01003262 if (ret != NULL)
3263 {
3264 if (htp != NULL)
3265 *htp = ht;
3266 return ret;
3267 }
3268 }
3269 }
3270
Bram Moolenaar0e3e7ba2022-01-13 20:18:56 +00003271 // When using "vim9script autoload" script-local items are prefixed but can
3272 // be used with s:name.
3273 if (SCRIPT_ID_VALID(current_sctx.sc_sid)
Bram Moolenaar6c4d4a62022-10-13 17:47:42 +01003274 && (in_vim9script() || (name[0] == 's' && name[1] == ':')))
Bram Moolenaar0e3e7ba2022-01-13 20:18:56 +00003275 {
3276 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
3277
3278 if (si->sn_autoload_prefix != NULL)
3279 {
Bram Moolenaar6c4d4a62022-10-13 17:47:42 +01003280 char_u *base_name = (name[0] == 's' && name[1] == ':')
3281 ? name + 2 : name;
3282 char_u *auto_name = concat_str(si->sn_autoload_prefix, base_name);
Bram Moolenaar0e3e7ba2022-01-13 20:18:56 +00003283
3284 if (auto_name != NULL)
3285 {
3286 ht = &globvarht;
Bram Moolenaar6c4d4a62022-10-13 17:47:42 +01003287 ret = find_var_in_ht(ht, 'g', auto_name, TRUE);
Bram Moolenaar130f65d2022-01-13 20:39:41 +00003288 vim_free(auto_name);
Bram Moolenaar0e3e7ba2022-01-13 20:18:56 +00003289 if (ret != NULL)
3290 {
3291 if (htp != NULL)
3292 *htp = ht;
3293 return ret;
3294 }
3295 }
Bram Moolenaar0e3e7ba2022-01-13 20:18:56 +00003296 }
3297 }
3298
Bram Moolenaar2ea95b62020-11-19 21:47:56 +01003299 return NULL;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003300}
3301
3302/*
Bram Moolenaar71f21932022-01-07 18:20:55 +00003303 * Like find_var() but if the name starts with <SNR>99_ then look in the
3304 * referenced script (used for a funcref).
3305 */
3306 dictitem_T *
3307find_var_also_in_script(char_u *name, hashtab_T **htp, int no_autoload)
3308{
3309 if (STRNCMP(name, "<SNR>", 5) == 0 && isdigit(name[5]))
3310 {
3311 char_u *p = name + 5;
3312 int sid = getdigits(&p);
3313
3314 if (SCRIPT_ID_VALID(sid) && *p == '_')
3315 {
3316 hashtab_T *ht = &SCRIPT_VARS(sid);
3317
3318 if (ht != NULL)
3319 {
3320 dictitem_T *di = find_var_in_ht(ht, 0, p + 1, no_autoload);
3321
3322 if (di != NULL)
Bram Moolenaaraa9b3ca2022-01-08 15:44:22 +00003323 {
3324 if (htp != NULL)
3325 *htp = ht;
Bram Moolenaar71f21932022-01-07 18:20:55 +00003326 return di;
Bram Moolenaaraa9b3ca2022-01-08 15:44:22 +00003327 }
Bram Moolenaar71f21932022-01-07 18:20:55 +00003328 }
3329 }
3330 }
3331
3332 return find_var(name, htp, no_autoload);
3333}
3334
3335/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003336 * Find variable "varname" in hashtab "ht" with name "htname".
Bram Moolenaar52592752020-04-03 18:43:35 +02003337 * When "varname" is empty returns curwin/curtab/etc vars dictionary.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003338 * Returns NULL if not found.
3339 */
3340 dictitem_T *
3341find_var_in_ht(
3342 hashtab_T *ht,
3343 int htname,
3344 char_u *varname,
3345 int no_autoload)
3346{
3347 hashitem_T *hi;
3348
3349 if (*varname == NUL)
3350 {
3351 // Must be something like "s:", otherwise "ht" would be NULL.
3352 switch (htname)
3353 {
3354 case 's': return &SCRIPT_SV(current_sctx.sc_sid)->sv_var;
3355 case 'g': return &globvars_var;
3356 case 'v': return &vimvars_var;
3357 case 'b': return &curbuf->b_bufvar;
3358 case 'w': return &curwin->w_winvar;
3359 case 't': return &curtab->tp_winvar;
3360 case 'l': return get_funccal_local_var();
3361 case 'a': return get_funccal_args_var();
3362 }
3363 return NULL;
3364 }
3365
3366 hi = hash_find(ht, varname);
3367 if (HASHITEM_EMPTY(hi))
3368 {
3369 // For global variables we may try auto-loading the script. If it
3370 // worked find the variable again. Don't auto-load a script if it was
3371 // loaded already, otherwise it would be loaded every time when
3372 // checking if a function name is a Funcref variable.
3373 if (ht == &globvarht && !no_autoload)
3374 {
3375 // Note: script_autoload() may make "hi" invalid. It must either
3376 // be obtained again or not used.
3377 if (!script_autoload(varname, FALSE) || aborting())
3378 return NULL;
3379 hi = hash_find(ht, varname);
3380 }
3381 if (HASHITEM_EMPTY(hi))
3382 return NULL;
3383 }
3384 return HI2DI(hi);
3385}
3386
3387/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003388 * Get the script-local hashtab. NULL if not in a script context.
3389 */
Bram Moolenaar922acbd2020-10-08 21:30:40 +02003390 hashtab_T *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003391get_script_local_ht(void)
3392{
3393 scid_T sid = current_sctx.sc_sid;
3394
Bram Moolenaare3d46852020-08-29 13:39:17 +02003395 if (SCRIPT_ID_VALID(sid))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003396 return &SCRIPT_VARS(sid);
3397 return NULL;
3398}
3399
3400/*
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003401 * Look for "name[len]" in script-local variables and functions.
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003402 * When "cmd" is TRUE it must look like a command, a function must be followed
3403 * by "(" or "->".
Bram Moolenaar709664c2020-12-12 14:33:41 +01003404 * Return OK when found, FAIL when not found.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003405 */
Bram Moolenaar709664c2020-12-12 14:33:41 +01003406 int
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003407lookup_scriptitem(
Bram Moolenaar709664c2020-12-12 14:33:41 +01003408 char_u *name,
3409 size_t len,
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003410 int cmd,
Bram Moolenaar709664c2020-12-12 14:33:41 +01003411 cctx_T *dummy UNUSED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003412{
3413 hashtab_T *ht = get_script_local_ht();
3414 char_u buffer[30];
3415 char_u *p;
Bram Moolenaar709664c2020-12-12 14:33:41 +01003416 int res;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003417 hashitem_T *hi;
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003418 int is_global = FALSE;
3419 char_u *fname = name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003420
3421 if (ht == NULL)
Bram Moolenaar709664c2020-12-12 14:33:41 +01003422 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003423 if (len < sizeof(buffer) - 1)
3424 {
Bram Moolenaar7d3664d2020-05-09 13:06:24 +02003425 // avoid an alloc/free for short names
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003426 vim_strncpy(buffer, name, len);
3427 p = buffer;
3428 }
3429 else
3430 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02003431 p = vim_strnsave(name, len);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003432 if (p == NULL)
Bram Moolenaar709664c2020-12-12 14:33:41 +01003433 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003434 }
3435
3436 hi = hash_find(ht, p);
Bram Moolenaar709664c2020-12-12 14:33:41 +01003437 res = HASHITEM_EMPTY(hi) ? FAIL : OK;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003438
3439 // if not script-local, then perhaps imported
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00003440 if (res == FAIL && find_imported(p, 0, FALSE) != NULL)
Bram Moolenaar709664c2020-12-12 14:33:41 +01003441 res = OK;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003442 if (p != buffer)
3443 vim_free(p);
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003444
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003445 // Find a function, so that a following "->" works.
3446 // When used as a command require "(" or "->" to follow, "Cmd" is a user
3447 // command while "Cmd()" is a function call.
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003448 if (res != OK)
3449 {
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003450 p = skipwhite(name + len);
3451
3452 if (!cmd || name[len] == '(' || (p[0] == '-' && p[1] == '>'))
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003453 {
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003454 // Do not check for an internal function, since it might also be a
3455 // valid command, such as ":split" versus "split()".
3456 // Skip "g:" before a function name.
3457 if (name[0] == 'g' && name[1] == ':')
3458 {
3459 is_global = TRUE;
3460 fname = name + 2;
3461 }
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003462 if (find_func(fname, is_global) != NULL)
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003463 res = OK;
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003464 }
Bram Moolenaar2e2d7582021-03-03 21:22:41 +01003465 }
3466
Bram Moolenaar709664c2020-12-12 14:33:41 +01003467 return res;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003468}
3469
3470/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003471 * Find the hashtab used for a variable name.
3472 * Return NULL if the name is not valid.
3473 * Set "varname" to the start of name without ':'.
3474 */
3475 hashtab_T *
3476find_var_ht(char_u *name, char_u **varname)
3477{
3478 hashitem_T *hi;
3479 hashtab_T *ht;
3480
3481 if (name[0] == NUL)
3482 return NULL;
3483 if (name[1] != ':')
3484 {
3485 // The name must not start with a colon or #.
3486 if (name[0] == ':' || name[0] == AUTOLOAD_CHAR)
3487 return NULL;
3488 *varname = name;
3489
3490 // "version" is "v:version" in all scopes if scriptversion < 3.
3491 // Same for a few other variables marked with VV_COMPAT.
Bram Moolenaardd9de502021-08-15 13:49:42 +02003492 if (in_old_script(3))
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003493 {
3494 hi = hash_find(&compat_hashtab, name);
3495 if (!HASHITEM_EMPTY(hi))
3496 return &compat_hashtab;
3497 }
3498
3499 ht = get_funccal_local_ht();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003500 if (ht != NULL)
3501 return ht; // local variable
3502
Bram Moolenaarf0a40692021-06-11 22:05:47 +02003503 // In Vim9 script items at the script level are script-local, except
3504 // for autoload names.
3505 if (in_vim9script() && vim_strchr(name, AUTOLOAD_CHAR) == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003506 {
3507 ht = get_script_local_ht();
3508 if (ht != NULL)
3509 return ht;
3510 }
3511
3512 return &globvarht; // global variable
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003513 }
3514 *varname = name + 2;
3515 if (*name == 'g') // global variable
3516 return &globvarht;
3517 // There must be no ':' or '#' in the rest of the name, unless g: is used
3518 if (vim_strchr(name + 2, ':') != NULL
3519 || vim_strchr(name + 2, AUTOLOAD_CHAR) != NULL)
3520 return NULL;
3521 if (*name == 'b') // buffer variable
3522 return &curbuf->b_vars->dv_hashtab;
3523 if (*name == 'w') // window variable
3524 return &curwin->w_vars->dv_hashtab;
3525 if (*name == 't') // tab page variable
3526 return &curtab->tp_vars->dv_hashtab;
3527 if (*name == 'v') // v: variable
3528 return &vimvarht;
Bram Moolenaarb35efa52020-02-26 20:15:18 +01003529 if (get_current_funccal() != NULL
Bram Moolenaarca16c602022-09-06 18:57:08 +01003530 && get_current_funccal()->fc_func->uf_def_status
3531 == UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003532 {
Bram Moolenaarb35efa52020-02-26 20:15:18 +01003533 // a: and l: are only used in functions defined with ":function"
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003534 if (*name == 'a') // a: function argument
3535 return get_funccal_args_ht();
3536 if (*name == 'l') // l: local function variable
3537 return get_funccal_local_ht();
3538 }
3539 if (*name == 's') // script variable
3540 {
3541 ht = get_script_local_ht();
3542 if (ht != NULL)
3543 return ht;
3544 }
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003545 return NULL;
3546}
3547
3548/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003549 * Get the string value of a (global/local) variable.
3550 * Note: see tv_get_string() for how long the pointer remains valid.
3551 * Returns NULL when it doesn't exist.
3552 */
3553 char_u *
3554get_var_value(char_u *name)
3555{
3556 dictitem_T *v;
3557
3558 v = find_var(name, NULL, FALSE);
3559 if (v == NULL)
3560 return NULL;
3561 return tv_get_string(&v->di_tv);
3562}
3563
3564/*
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003565 * Allocate a new hashtab for a sourced script. It will be used while
3566 * sourcing this script and when executing functions defined in the script.
3567 */
3568 void
3569new_script_vars(scid_T id)
3570{
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003571 scriptvar_T *sv;
3572
Bram Moolenaar7ebcba62020-01-12 17:42:55 +01003573 sv = ALLOC_CLEAR_ONE(scriptvar_T);
3574 if (sv == NULL)
3575 return;
3576 init_var_dict(&sv->sv_dict, &sv->sv_var, VAR_SCOPE);
Bram Moolenaar21b9e972020-01-26 19:26:46 +01003577 SCRIPT_ITEM(id)->sn_vars = sv;
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003578}
3579
3580/*
3581 * Initialize dictionary "dict" as a scope and set variable "dict_var" to
3582 * point to it.
3583 */
3584 void
3585init_var_dict(dict_T *dict, dictitem_T *dict_var, int scope)
3586{
3587 hash_init(&dict->dv_hashtab);
3588 dict->dv_lock = 0;
3589 dict->dv_scope = scope;
3590 dict->dv_refcount = DO_NOT_FREE_CNT;
3591 dict->dv_copyID = 0;
3592 dict_var->di_tv.vval.v_dict = dict;
3593 dict_var->di_tv.v_type = VAR_DICT;
3594 dict_var->di_tv.v_lock = VAR_FIXED;
3595 dict_var->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
3596 dict_var->di_key[0] = NUL;
3597}
3598
3599/*
3600 * Unreference a dictionary initialized by init_var_dict().
3601 */
3602 void
3603unref_var_dict(dict_T *dict)
3604{
Bram Moolenaar8d71b542019-08-30 15:46:30 +02003605 // Now the dict needs to be freed if no one else is using it, go back to
3606 // normal reference counting.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02003607 dict->dv_refcount -= DO_NOT_FREE_CNT - 1;
3608 dict_unref(dict);
3609}
3610
3611/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003612 * Clean up a list of internal variables.
3613 * Frees all allocated variables and the value they contain.
3614 * Clears hashtab "ht", does not free it.
3615 */
3616 void
3617vars_clear(hashtab_T *ht)
3618{
3619 vars_clear_ext(ht, TRUE);
3620}
3621
3622/*
3623 * Like vars_clear(), but only free the value if "free_val" is TRUE.
3624 */
3625 void
3626vars_clear_ext(hashtab_T *ht, int free_val)
3627{
3628 int todo;
3629 hashitem_T *hi;
3630 dictitem_T *v;
3631
3632 hash_lock(ht);
3633 todo = (int)ht->ht_used;
Yegappan Lakshmanan14113fd2023-03-07 17:13:51 +00003634 FOR_ALL_HASHTAB_ITEMS(ht, hi, todo)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003635 {
3636 if (!HASHITEM_EMPTY(hi))
3637 {
3638 --todo;
3639
3640 // Free the variable. Don't remove it from the hashtab,
3641 // ht_array might change then. hash_clear() takes care of it
3642 // later.
3643 v = HI2DI(hi);
3644 if (free_val)
3645 clear_tv(&v->di_tv);
3646 if (v->di_flags & DI_FLAGS_ALLOC)
3647 vim_free(v);
3648 }
3649 }
3650 hash_clear(ht);
Bram Moolenaar8d739de2020-10-14 19:39:19 +02003651 hash_init(ht);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003652}
3653
3654/*
3655 * Delete a variable from hashtab "ht" at item "hi".
3656 * Clear the variable value and free the dictitem.
3657 */
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02003658 void
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003659delete_var(hashtab_T *ht, hashitem_T *hi)
3660{
3661 dictitem_T *di = HI2DI(hi);
3662
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00003663 if (hash_remove(ht, hi, "delete variable") != OK)
3664 return;
3665
3666 clear_tv(&di->di_tv);
3667 vim_free(di);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003668}
3669
3670/*
3671 * List the value of one internal variable.
3672 */
3673 static void
3674list_one_var(dictitem_T *v, char *prefix, int *first)
3675{
3676 char_u *tofree;
3677 char_u *s;
3678 char_u numbuf[NUMBUFLEN];
3679
3680 s = echo_string(&v->di_tv, &tofree, numbuf, get_copyID());
3681 list_one_var_a(prefix, v->di_key, v->di_tv.v_type,
3682 s == NULL ? (char_u *)"" : s, first);
3683 vim_free(tofree);
3684}
3685
3686 static void
3687list_one_var_a(
3688 char *prefix,
3689 char_u *name,
3690 int type,
3691 char_u *string,
3692 int *first) // when TRUE clear rest of screen and set to FALSE
3693{
3694 // don't use msg() or msg_attr() to avoid overwriting "v:statusmsg"
3695 msg_start();
3696 msg_puts(prefix);
3697 if (name != NULL) // "a:" vars don't have a name stored
3698 msg_puts((char *)name);
3699 msg_putchar(' ');
3700 msg_advance(22);
3701 if (type == VAR_NUMBER)
3702 msg_putchar('#');
3703 else if (type == VAR_FUNC || type == VAR_PARTIAL)
3704 msg_putchar('*');
3705 else if (type == VAR_LIST)
3706 {
3707 msg_putchar('[');
3708 if (*string == '[')
3709 ++string;
3710 }
3711 else if (type == VAR_DICT)
3712 {
3713 msg_putchar('{');
3714 if (*string == '{')
3715 ++string;
3716 }
3717 else
3718 msg_putchar(' ');
3719
3720 msg_outtrans(string);
3721
3722 if (type == VAR_FUNC || type == VAR_PARTIAL)
3723 msg_puts("()");
3724 if (*first)
3725 {
3726 msg_clr_eos();
3727 *first = FALSE;
3728 }
3729}
3730
3731/*
zeertzjqedcba962023-09-24 23:13:51 +02003732 * Addition handling for setting a v: variable.
3733 * Return TRUE if the variable should be set normally,
3734 * FALSE if nothing else needs to be done.
3735 */
3736 int
3737before_set_vvar(
3738 char_u *varname,
3739 dictitem_T *di,
3740 typval_T *tv,
3741 int copy,
3742 int *type_error)
3743{
3744 if (di->di_tv.v_type == VAR_STRING)
3745 {
3746 VIM_CLEAR(di->di_tv.vval.v_string);
3747 if (copy || tv->v_type != VAR_STRING)
3748 {
3749 char_u *val = tv_get_string(tv);
3750
3751 // Careful: when assigning to v:errmsg and
3752 // tv_get_string() causes an error message the variable
3753 // will already be set.
3754 if (di->di_tv.vval.v_string == NULL)
3755 di->di_tv.vval.v_string = vim_strsave(val);
3756 }
3757 else
3758 {
3759 // Take over the string to avoid an extra alloc/free.
3760 di->di_tv.vval.v_string = tv->vval.v_string;
3761 tv->vval.v_string = NULL;
3762 }
3763 return FALSE;
3764 }
3765 else if (di->di_tv.v_type == VAR_NUMBER)
3766 {
3767 di->di_tv.vval.v_number = tv_get_number(tv);
3768 if (STRCMP(varname, "searchforward") == 0)
3769 set_search_direction(di->di_tv.vval.v_number ? '/' : '?');
3770#ifdef FEAT_SEARCH_EXTRA
3771 else if (STRCMP(varname, "hlsearch") == 0)
3772 {
3773 no_hlsearch = !di->di_tv.vval.v_number;
3774 redraw_all_later(UPD_SOME_VALID);
3775 }
3776#endif
3777 return FALSE;
3778 }
3779 else if (di->di_tv.v_type != tv->v_type)
3780 {
3781 *type_error = TRUE;
3782 return FALSE;
3783 }
3784 return TRUE;
3785}
3786
3787/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003788 * Set variable "name" to value in "tv".
3789 * If the variable already exists, the value is updated.
3790 * Otherwise the variable is created.
3791 */
3792 void
3793set_var(
3794 char_u *name,
3795 typval_T *tv,
3796 int copy) // make copy of value in "tv"
3797{
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003798 set_var_const(name, 0, NULL, tv, copy, ASSIGN_DECL, 0);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003799}
3800
3801/*
Bram Moolenaar0e3e7ba2022-01-13 20:18:56 +00003802 * Set variable "name" to value in "tv_arg".
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003803 * When "sid" is non-zero "name" is in the script with this ID.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003804 * If the variable already exists and "is_const" is FALSE the value is updated.
3805 * Otherwise the variable is created.
3806 */
3807 void
3808set_var_const(
3809 char_u *name,
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003810 scid_T sid,
Bram Moolenaar7824fc82021-11-26 17:36:51 +00003811 type_T *type_arg,
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003812 typval_T *tv_arg,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003813 int copy, // make copy of value in "tv"
Bram Moolenaarf6a8d422021-04-13 21:48:03 +02003814 int flags_arg, // ASSIGN_CONST, ASSIGN_FINAL, etc.
Bram Moolenaarf785aa12021-02-11 21:19:34 +01003815 int var_idx) // index for ":let [a, b] = list"
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003816{
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003817 typval_T *tv = tv_arg;
Bram Moolenaar7824fc82021-11-26 17:36:51 +00003818 type_T *type = type_arg;
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003819 typval_T bool_tv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003820 dictitem_T *di;
Bram Moolenaar993faa32022-02-21 15:59:11 +00003821 typval_T *dest_tv;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003822 char_u *varname;
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003823 char_u *name_tofree = NULL;
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003824 hashtab_T *ht = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003825 int is_script_local;
Bram Moolenaardbeecb22020-09-14 18:15:09 +02003826 int vim9script = in_vim9script();
Bram Moolenaare535db82021-03-31 21:07:24 +02003827 int var_in_vim9script;
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003828 int var_in_autoload = FALSE;
Bram Moolenaarf6a8d422021-04-13 21:48:03 +02003829 int flags = flags_arg;
Bram Moolenaardd297bc2021-12-10 10:37:38 +00003830 int free_tv_arg = !copy; // free tv_arg if not used
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003831
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003832 if (sid != 0)
3833 {
3834 if (SCRIPT_ID_VALID(sid))
3835 ht = &SCRIPT_VARS(sid);
3836 varname = name;
3837 }
3838 else
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003839 {
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003840 scriptitem_T *si;
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003841
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003842 if (in_vim9script() && is_export
3843 && SCRIPT_ID_VALID(current_sctx.sc_sid)
3844 && (si = SCRIPT_ITEM(current_sctx.sc_sid))
Bram Moolenaar0e1574c2022-03-03 17:05:35 +00003845 ->sn_autoload_prefix != NULL)
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003846 {
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003847 // In a vim9 autoload script an exported variable is put in the
3848 // global namespace with the autoload prefix.
3849 var_in_autoload = TRUE;
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003850 varname = concat_str(si->sn_autoload_prefix, name);
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003851 if (varname == NULL)
3852 goto failed;
3853 name_tofree = varname;
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003854 ht = &globvarht;
3855 }
3856 else
3857 ht = find_var_ht(name, &varname);
3858 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003859 if (ht == NULL || *varname == NUL)
3860 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00003861 semsg(_(e_illegal_variable_name_str), name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003862 goto failed;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003863 }
Bram Moolenaar54969f42022-02-07 13:56:44 +00003864 is_script_local = ht == get_script_local_ht() || sid != 0
3865 || var_in_autoload;
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003866
Bram Moolenaardbeecb22020-09-14 18:15:09 +02003867 if (vim9script
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003868 && !is_script_local
Bram Moolenaar3862ea32021-01-01 21:05:55 +01003869 && (flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0
Bram Moolenaar89b474d2020-12-22 21:19:39 +01003870 && (flags & (ASSIGN_CONST | ASSIGN_FINAL)) == 0
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003871 && name[1] == ':')
Bram Moolenaar67979662020-06-20 22:50:47 +02003872 {
Bram Moolenaare55b1c02020-06-21 15:52:59 +02003873 vim9_declare_error(name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003874 goto failed;
Bram Moolenaar67979662020-06-20 22:50:47 +02003875 }
Bram Moolenaar9510d222022-09-11 15:14:05 +01003876 if ((flags & ASSIGN_FOR_LOOP) && is_scoped_variable(name))
Bram Moolenaarf6a8d422021-04-13 21:48:03 +02003877 // Do not make g:var, w:var, b:var or t:var final.
3878 flags &= ~ASSIGN_FINAL;
3879
Bram Moolenaare535db82021-03-31 21:07:24 +02003880 var_in_vim9script = is_script_local && current_script_is_vim9();
Bram Moolenaar962c43b2021-04-10 17:18:09 +02003881 if (var_in_vim9script && name[0] == '_' && name[1] == NUL)
3882 {
Bram Moolenaarf93bbd02021-04-10 22:35:43 +02003883 // For "[a, _] = list" the underscore is ignored.
3884 if ((flags & ASSIGN_UNPACK) == 0)
3885 emsg(_(e_cannot_use_underscore_here));
Bram Moolenaar962c43b2021-04-10 17:18:09 +02003886 goto failed;
3887 }
Bram Moolenaar67979662020-06-20 22:50:47 +02003888
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003889 di = find_var_in_ht(ht, 0, varname, TRUE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003890
Bram Moolenaar24e93162021-07-18 20:40:33 +02003891 if (di == NULL && var_in_vim9script)
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003892 {
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00003893 imported_T *import = find_imported(varname, 0, FALSE);
Bram Moolenaarc1ec0422020-09-09 22:27:58 +02003894
Bram Moolenaar24e93162021-07-18 20:40:33 +02003895 if (import != NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02003896 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003897 // imported name space cannot be used
Bram Moolenaar24e93162021-07-18 20:40:33 +02003898 if ((flags & ASSIGN_NO_DECL) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003899 {
Bram Moolenaar24e93162021-07-18 20:40:33 +02003900 semsg(_(e_redefining_imported_item_str), name);
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02003901 goto failed;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003902 }
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003903 semsg(_(e_cannot_use_str_itself_it_is_imported), name);
3904 goto failed;
Bram Moolenaar24e93162021-07-18 20:40:33 +02003905 }
Bram Moolenaar75e27d72022-02-13 13:56:29 +00003906 if (!in_vim9script())
3907 {
3908 semsg(_(e_cannot_create_vim9_script_variable_in_function_str),
3909 name);
3910 goto failed;
3911 }
Bram Moolenaar24e93162021-07-18 20:40:33 +02003912 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003913
Bram Moolenaar993faa32022-02-21 15:59:11 +00003914 // Search in parent scope which is possible to reference from lambda
3915 if (di == NULL)
3916 di = find_var_in_scoped_ht(name, TRUE);
3917
3918 if ((tv->v_type == VAR_FUNC || tv->v_type == VAR_PARTIAL)
3919 && var_wrong_func_name(name, di == NULL))
3920 goto failed;
3921
3922 if (need_convert_to_bool(type, tv))
Bram Moolenaar24e93162021-07-18 20:40:33 +02003923 {
Bram Moolenaar993faa32022-02-21 15:59:11 +00003924 // Destination is a bool and the value is not, but it can be
3925 // converted.
3926 CLEAR_FIELD(bool_tv);
3927 bool_tv.v_type = VAR_BOOL;
3928 bool_tv.vval.v_number = tv2bool(tv) ? VVAL_TRUE : VVAL_FALSE;
3929 tv = &bool_tv;
3930 }
Bram Moolenaar24e93162021-07-18 20:40:33 +02003931
Bram Moolenaar993faa32022-02-21 15:59:11 +00003932 if (di != NULL)
3933 {
3934 // Item already exists. Allowed to replace when reloading.
3935 if ((di->di_flags & DI_FLAGS_RELOAD) == 0)
Bram Moolenaar24e93162021-07-18 20:40:33 +02003936 {
Bram Moolenaar993faa32022-02-21 15:59:11 +00003937 if ((flags & (ASSIGN_CONST | ASSIGN_FINAL))
3938 && (flags & ASSIGN_FOR_LOOP) == 0)
Bram Moolenaar24e93162021-07-18 20:40:33 +02003939 {
Bram Moolenaar993faa32022-02-21 15:59:11 +00003940 emsg(_(e_cannot_modify_existing_variable));
3941 goto failed;
Bram Moolenaar24e93162021-07-18 20:40:33 +02003942 }
3943
Bram Moolenaar993faa32022-02-21 15:59:11 +00003944 if (is_script_local && vim9script
3945 && (flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0)
Bram Moolenaar12be7342021-03-31 21:47:33 +02003946 {
3947 semsg(_(e_redefining_script_item_str), name);
3948 goto failed;
3949 }
3950
Bram Moolenaar993faa32022-02-21 15:59:11 +00003951 if (var_in_vim9script && (flags & ASSIGN_FOR_LOOP) == 0)
Bram Moolenaar24e93162021-07-18 20:40:33 +02003952 {
Bram Moolenaar993faa32022-02-21 15:59:11 +00003953 where_T where = WHERE_INIT;
Bram Moolenaar7a411a32022-04-04 14:58:06 +01003954 svar_T *sv = find_typval_in_script(&di->di_tv, sid, TRUE);
Bram Moolenaar993faa32022-02-21 15:59:11 +00003955
3956 if (sv != NULL)
3957 {
3958 // check the type and adjust to bool if needed
LemonBoyc5d27442023-08-19 13:02:35 +02003959 if (var_idx > 0)
3960 {
3961 where.wt_index = var_idx;
3962 where.wt_kind = WT_VARIABLE;
3963 }
Bram Moolenaar993faa32022-02-21 15:59:11 +00003964 if (check_script_var_type(sv, tv, name, where) == FAIL)
3965 goto failed;
3966 if (type == NULL)
3967 type = sv->sv_type;
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003968 sv->sv_flags |= SVFLAG_ASSIGNED;
Bram Moolenaar993faa32022-02-21 15:59:11 +00003969 }
Bram Moolenaar24e93162021-07-18 20:40:33 +02003970 }
3971
Bram Moolenaar993faa32022-02-21 15:59:11 +00003972 if ((flags & ASSIGN_FOR_LOOP) == 0
Bram Moolenaar16d2c022023-06-05 19:46:18 +01003973 ? var_check_permission(di, name) == FAIL
3974 : var_check_ro(di->di_flags, name, FALSE))
Bram Moolenaar24e93162021-07-18 20:40:33 +02003975 goto failed;
Bram Moolenaar993faa32022-02-21 15:59:11 +00003976 }
3977 else
3978 {
3979 // can only redefine once
3980 di->di_flags &= ~DI_FLAGS_RELOAD;
Bram Moolenaar24e93162021-07-18 20:40:33 +02003981
Bram Moolenaar993faa32022-02-21 15:59:11 +00003982 // A Vim9 script-local variable is also present in sn_all_vars
3983 // and sn_var_vals. It may set "type" from "tv".
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003984 if (var_in_vim9script || var_in_autoload)
Bram Moolenaar993faa32022-02-21 15:59:11 +00003985 update_vim9_script_var(FALSE, di,
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00003986 var_in_autoload ? name : di->di_key, flags,
Bram Moolenaar993faa32022-02-21 15:59:11 +00003987 tv, &type, (flags & ASSIGN_NO_MEMBER_TYPE) == 0);
Bram Moolenaar07a65d22020-12-26 20:09:15 +01003988 }
3989
Bram Moolenaar993faa32022-02-21 15:59:11 +00003990 // existing variable, need to clear the value
3991
zeertzjqedcba962023-09-24 23:13:51 +02003992 // Handle setting internal v: variables separately where needed to
Bram Moolenaar993faa32022-02-21 15:59:11 +00003993 // prevent changing the type.
zeertzjqedcba962023-09-24 23:13:51 +02003994 int type_error = FALSE;
3995 if (ht == &vimvarht
3996 && !before_set_vvar(varname, di, tv, copy, &type_error))
Bram Moolenaar993faa32022-02-21 15:59:11 +00003997 {
zeertzjqedcba962023-09-24 23:13:51 +02003998 if (type_error)
3999 semsg(_(e_setting_v_str_to_value_with_wrong_type), varname);
4000 goto failed;
Bram Moolenaar993faa32022-02-21 15:59:11 +00004001 }
4002
4003 clear_tv(&di->di_tv);
Bram Moolenaar766ae5b2022-09-14 00:30:51 +01004004
4005 if ((flags & ASSIGN_UPDATE_BLOCK_ID)
4006 && SCRIPT_ID_VALID(current_sctx.sc_sid))
4007 {
4008 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
4009
4010 update_script_var_block_id(name, si->sn_current_block_id);
4011 }
Bram Moolenaar993faa32022-02-21 15:59:11 +00004012 }
4013 else
4014 {
4015 // Item not found, check if a function already exists.
4016 if (is_script_local && (flags & (ASSIGN_NO_DECL | ASSIGN_DECL)) == 0
4017 && lookup_scriptitem(name, STRLEN(name), FALSE, NULL) == OK)
4018 {
4019 semsg(_(e_redefining_script_item_str), name);
4020 goto failed;
4021 }
4022
4023 // add a new variable
4024 if (var_in_vim9script && (flags & ASSIGN_NO_DECL))
4025 {
4026 semsg(_(e_unknown_variable_str), name);
4027 goto failed;
4028 }
4029
Bram Moolenaaref2c3252022-11-25 16:31:51 +00004030 if (check_hashtab_frozen(ht, "add variable"))
4031 goto failed;
4032
Bram Moolenaar993faa32022-02-21 15:59:11 +00004033 // Can't add "v:" or "a:" variable.
4034 if (ht == &vimvarht || ht == get_funccal_args_ht())
4035 {
4036 semsg(_(e_illegal_variable_name_str), name);
4037 goto failed;
4038 }
4039
4040 // Make sure the variable name is valid. In Vim9 script an
4041 // autoload variable must be prefixed with "g:" unless in an
4042 // autoload script.
4043 if (!valid_varname(varname, -1, !vim9script
4044 || STRNCMP(name, "g:", 2) == 0 || var_in_autoload))
4045 goto failed;
4046
zeertzjq1b438a82023-02-01 13:11:15 +00004047 di = alloc(offsetof(dictitem_T, di_key) + STRLEN(varname) + 1);
Bram Moolenaar993faa32022-02-21 15:59:11 +00004048 if (di == NULL)
4049 goto failed;
4050 STRCPY(di->di_key, varname);
Bram Moolenaaref2c3252022-11-25 16:31:51 +00004051 if (hash_add(ht, DI2HIKEY(di), "add variable") == FAIL)
Bram Moolenaar993faa32022-02-21 15:59:11 +00004052 {
4053 vim_free(di);
4054 goto failed;
4055 }
4056 di->di_flags = DI_FLAGS_ALLOC;
4057 if (flags & (ASSIGN_CONST | ASSIGN_FINAL))
4058 di->di_flags |= DI_FLAGS_LOCK;
4059
4060 // A Vim9 script-local variable is also added to sn_all_vars and
4061 // sn_var_vals. It may set "type" from "tv".
4062 if (var_in_vim9script || var_in_autoload)
4063 update_vim9_script_var(TRUE, di,
4064 var_in_autoload ? name : di->di_key, flags,
4065 tv, &type, (flags & ASSIGN_NO_MEMBER_TYPE) == 0);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004066 }
4067
Bram Moolenaar993faa32022-02-21 15:59:11 +00004068 dest_tv = &di->di_tv;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004069 if (copy || tv->v_type == VAR_NUMBER || tv->v_type == VAR_FLOAT)
Bram Moolenaar24e93162021-07-18 20:40:33 +02004070 copy_tv(tv, dest_tv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004071 else
4072 {
Bram Moolenaar24e93162021-07-18 20:40:33 +02004073 *dest_tv = *tv;
4074 dest_tv->v_lock = 0;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004075 init_tv(tv);
4076 }
Bram Moolenaardd297bc2021-12-10 10:37:38 +00004077 free_tv_arg = FALSE;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004078
Bram Moolenaaraa210a32021-01-02 15:41:03 +01004079 if (vim9script && type != NULL)
Bram Moolenaar381692b2022-02-02 20:01:27 +00004080 set_tv_type(dest_tv, type);
Bram Moolenaaraa210a32021-01-02 15:41:03 +01004081
Bram Moolenaar1dcf55d2020-12-22 22:07:30 +01004082 // ":const var = value" locks the value
4083 // ":final var = value" locks "var"
Bram Moolenaar30fd8202020-09-26 15:09:30 +02004084 if (flags & ASSIGN_CONST)
Bram Moolenaar021bda52020-08-17 21:07:22 +02004085 // Like :lockvar! name: lock the value and what it contains, but only
4086 // if the reference count is up to one. That locks only literal
4087 // values.
Bram Moolenaar24e93162021-07-18 20:40:33 +02004088 item_lock(dest_tv, DICT_MAXNEST, TRUE, TRUE);
Bram Moolenaar24e93162021-07-18 20:40:33 +02004089
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02004090failed:
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00004091 vim_free(name_tofree);
Bram Moolenaardd297bc2021-12-10 10:37:38 +00004092 if (free_tv_arg)
Bram Moolenaarb0fa5e12020-09-12 19:51:42 +02004093 clear_tv(tv_arg);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004094}
4095
4096/*
Bram Moolenaar3bdc90b2020-12-22 20:35:40 +01004097 * Check in this order for backwards compatibility:
4098 * - Whether the variable is read-only
4099 * - Whether the variable value is locked
4100 * - Whether the variable is locked
4101 */
4102 int
4103var_check_permission(dictitem_T *di, char_u *name)
4104{
4105 if (var_check_ro(di->di_flags, name, FALSE)
4106 || value_check_lock(di->di_tv.v_lock, name, FALSE)
4107 || var_check_lock(di->di_flags, name, FALSE))
4108 return FAIL;
4109 return OK;
4110}
4111
4112/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004113 * Return TRUE if di_flags "flags" indicates variable "name" is read-only.
4114 * Also give an error message.
4115 */
4116 int
4117var_check_ro(int flags, char_u *name, int use_gettext)
4118{
4119 if (flags & DI_FLAGS_RO)
4120 {
Bram Moolenaar71b76852021-12-17 20:15:38 +00004121 if (name == NULL)
4122 emsg(_(e_cannot_change_readonly_variable));
4123 else
4124 semsg(_(e_cannot_change_readonly_variable_str),
Bram Moolenaard8e44472021-07-21 22:20:33 +02004125 use_gettext ? (char_u *)_(name) : name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004126 return TRUE;
4127 }
4128 if ((flags & DI_FLAGS_RO_SBX) && sandbox)
4129 {
Bram Moolenaar71b76852021-12-17 20:15:38 +00004130 if (name == NULL)
4131 emsg(_(e_cannot_set_variable_in_sandbox));
4132 else
4133 semsg(_(e_cannot_set_variable_in_sandbox_str),
4134 use_gettext ? (char_u *)_(name) : name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004135 return TRUE;
4136 }
4137 return FALSE;
4138}
4139
4140/*
Bram Moolenaara187c432020-09-16 21:08:28 +02004141 * Return TRUE if di_flags "flags" indicates variable "name" is locked.
4142 * Also give an error message.
4143 */
4144 int
4145var_check_lock(int flags, char_u *name, int use_gettext)
4146{
4147 if (flags & DI_FLAGS_LOCK)
4148 {
4149 semsg(_(e_variable_is_locked_str),
4150 use_gettext ? (char_u *)_(name) : name);
4151 return TRUE;
4152 }
4153 return FALSE;
4154}
4155
4156/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004157 * Return TRUE if di_flags "flags" indicates variable "name" is fixed.
4158 * Also give an error message.
4159 */
4160 int
4161var_check_fixed(int flags, char_u *name, int use_gettext)
4162{
4163 if (flags & DI_FLAGS_FIX)
4164 {
Bram Moolenaar71b76852021-12-17 20:15:38 +00004165 if (name == NULL)
4166 emsg(_(e_cannot_delete_variable));
4167 else
4168 semsg(_(e_cannot_delete_variable_str),
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004169 use_gettext ? (char_u *)_(name) : name);
4170 return TRUE;
4171 }
4172 return FALSE;
4173}
4174
4175/*
4176 * Check if a funcref is assigned to a valid variable name.
4177 * Return TRUE and give an error if not.
4178 */
4179 int
Bram Moolenaar98b4f142020-08-08 15:46:01 +02004180var_wrong_func_name(
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004181 char_u *name, // points to start of variable name
4182 int new_var) // TRUE when creating the variable
4183{
Bram Moolenaar32154662021-03-28 21:14:06 +02004184 // Allow for w: b: s: and t:. In Vim9 script s: is not allowed, because
4185 // the name can be used without the s: prefix.
thinca6c667bd2022-09-02 11:25:37 +01004186 // Allow autoload variable.
Bram Moolenaar32154662021-03-28 21:14:06 +02004187 if (!((vim_strchr((char_u *)"wbt", name[0]) != NULL
4188 || (!in_vim9script() && name[0] == 's')) && name[1] == ':')
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004189 && !ASCII_ISUPPER((name[0] != NUL && name[1] == ':')
thinca6c667bd2022-09-02 11:25:37 +01004190 ? name[2] : name[0])
4191 && vim_strchr(name, '#') == NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004192 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004193 semsg(_(e_funcref_variable_name_must_start_with_capital_str), name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004194 return TRUE;
4195 }
4196 // Don't allow hiding a function. When "v" is not NULL we might be
4197 // assigning another function to the same var, the type is checked
4198 // below.
4199 if (new_var && function_exists(name, FALSE))
4200 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004201 semsg(_(e_variable_name_conflicts_with_existing_function_str),
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004202 name);
4203 return TRUE;
4204 }
4205 return FALSE;
4206}
4207
4208/*
Bram Moolenaara187c432020-09-16 21:08:28 +02004209 * Return TRUE if "flags" indicates variable "name" has a locked (immutable)
4210 * value. Also give an error message, using "name" or _("name") when
4211 * "use_gettext" is TRUE.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004212 */
4213 int
Bram Moolenaara187c432020-09-16 21:08:28 +02004214value_check_lock(int lock, char_u *name, int use_gettext)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004215{
4216 if (lock & VAR_LOCKED)
4217 {
Bram Moolenaar71b76852021-12-17 20:15:38 +00004218 if (name == NULL)
4219 emsg(_(e_value_is_locked));
4220 else
4221 semsg(_(e_value_is_locked_str),
4222 use_gettext ? (char_u *)_(name) : name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004223 return TRUE;
4224 }
4225 if (lock & VAR_FIXED)
4226 {
Bram Moolenaar71b76852021-12-17 20:15:38 +00004227 if (name == NULL)
4228 emsg(_(e_cannot_change_value));
4229 else
4230 semsg(_(e_cannot_change_value_of_str),
4231 use_gettext ? (char_u *)_(name) : name);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004232 return TRUE;
4233 }
4234 return FALSE;
4235}
4236
4237/*
Bram Moolenaar03290b82020-12-19 16:30:44 +01004238 * Check if a variable name is valid. When "autoload" is true "#" is allowed.
Bram Moolenaar3b3755f2021-11-22 20:10:18 +00004239 * If "len" is -1 use all of "varname", otherwise up to "varname[len]".
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004240 * Return FALSE and give an error if not.
4241 */
4242 int
Bram Moolenaar3b3755f2021-11-22 20:10:18 +00004243valid_varname(char_u *varname, int len, int autoload)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004244{
4245 char_u *p;
4246
Bram Moolenaar3b3755f2021-11-22 20:10:18 +00004247 for (p = varname; len < 0 ? *p != NUL : p < varname + len; ++p)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004248 if (!eval_isnamec1(*p) && (p == varname || !VIM_ISDIGIT(*p))
Bram Moolenaar03290b82020-12-19 16:30:44 +01004249 && !(autoload && *p == AUTOLOAD_CHAR))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004250 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004251 semsg(_(e_illegal_variable_name_str), varname);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004252 return FALSE;
4253 }
4254 return TRUE;
4255}
4256
4257/*
LemonBoy47d4e312022-05-04 18:12:55 +01004258 * Implements the logic to retrieve local variable and option values.
4259 * Used by "getwinvar()" "gettabvar()" "gettabwinvar()" "getbufvar()".
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004260 */
4261 static void
LemonBoy47d4e312022-05-04 18:12:55 +01004262get_var_from(
4263 char_u *varname,
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004264 typval_T *rettv,
LemonBoy47d4e312022-05-04 18:12:55 +01004265 typval_T *deftv, // Default value if not found.
4266 int htname, // 't'ab, 'w'indow or 'b'uffer local.
4267 tabpage_T *tp, // can be NULL
4268 win_T *win,
4269 buf_T *buf) // Ignored if htname is not 'b'.
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004270{
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004271 dictitem_T *v;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004272 int done = FALSE;
Bram Moolenaar18f47402022-01-06 13:24:51 +00004273 switchwin_T switchwin;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004274 int need_switch_win;
zeertzjqcd6ad642022-07-25 12:28:09 +01004275 int do_change_curbuf = buf != NULL && htname == 'b';
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004276
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004277 ++emsg_off;
4278
4279 rettv->v_type = VAR_STRING;
4280 rettv->vval.v_string = NULL;
4281
LemonBoy47d4e312022-05-04 18:12:55 +01004282 if (varname != NULL && tp != NULL && win != NULL
4283 && (htname != 'b' || buf != NULL))
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004284 {
4285 // Set curwin to be our win, temporarily. Also set the tabpage,
4286 // otherwise the window is not valid. Only do this when needed,
4287 // autocommands get blocked.
LemonBoy47d4e312022-05-04 18:12:55 +01004288 // If we have a buffer reference avoid the switching, we're saving and
4289 // restoring curbuf directly.
zeertzjqcd6ad642022-07-25 12:28:09 +01004290 need_switch_win = !(tp == curtab && win == curwin) && !do_change_curbuf;
LemonBoy47d4e312022-05-04 18:12:55 +01004291 if (!need_switch_win || switch_win(&switchwin, win, tp, TRUE) == OK)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004292 {
LemonBoy47d4e312022-05-04 18:12:55 +01004293 // Handle options. There are no tab-local options.
4294 if (*varname == '&' && htname != 't')
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004295 {
LemonBoy47d4e312022-05-04 18:12:55 +01004296 buf_T *save_curbuf = curbuf;
4297
4298 // Change curbuf so the option is read from the correct buffer.
zeertzjqcd6ad642022-07-25 12:28:09 +01004299 if (do_change_curbuf)
LemonBoy47d4e312022-05-04 18:12:55 +01004300 curbuf = buf;
4301
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004302 if (varname[1] == NUL)
4303 {
zeertzjqcd6ad642022-07-25 12:28:09 +01004304 // get all window-local or buffer-local options in a dict
LemonBoy47d4e312022-05-04 18:12:55 +01004305 dict_T *opts = get_winbuf_options(htname == 'b');
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004306
4307 if (opts != NULL)
4308 {
4309 rettv_dict_set(rettv, opts);
4310 done = TRUE;
4311 }
4312 }
LemonBoy47d4e312022-05-04 18:12:55 +01004313 else if (eval_option(&varname, rettv, TRUE) == OK)
4314 // Local option
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004315 done = TRUE;
LemonBoy47d4e312022-05-04 18:12:55 +01004316
4317 curbuf = save_curbuf;
4318 }
4319 else if (*varname == NUL)
4320 {
4321 // Empty string: return a dict with all the local variables.
4322 if (htname == 'b')
4323 v = &buf->b_bufvar;
4324 else if (htname == 'w')
4325 v = &win->w_winvar;
4326 else
4327 v = &tp->tp_winvar;
4328 copy_tv(&v->di_tv, rettv);
4329 done = TRUE;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004330 }
4331 else
4332 {
LemonBoy47d4e312022-05-04 18:12:55 +01004333 hashtab_T *ht;
4334
4335 if (htname == 'b')
4336 ht = &buf->b_vars->dv_hashtab;
4337 else if (htname == 'w')
4338 ht = &win->w_vars->dv_hashtab;
4339 else
4340 ht = &tp->tp_vars->dv_hashtab;
4341
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004342 // Look up the variable.
LemonBoy47d4e312022-05-04 18:12:55 +01004343 v = find_var_in_ht(ht, htname, varname, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004344 if (v != NULL)
4345 {
4346 copy_tv(&v->di_tv, rettv);
4347 done = TRUE;
4348 }
4349 }
4350 }
4351
4352 if (need_switch_win)
4353 // restore previous notion of curwin
Bram Moolenaar18f47402022-01-06 13:24:51 +00004354 restore_win(&switchwin, TRUE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004355 }
4356
LemonBoy47d4e312022-05-04 18:12:55 +01004357 if (!done && deftv->v_type != VAR_UNKNOWN)
4358 // use the default value
4359 copy_tv(deftv, rettv);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004360
4361 --emsg_off;
4362}
4363
4364/*
LemonBoy47d4e312022-05-04 18:12:55 +01004365 * getwinvar() and gettabwinvar()
4366 */
4367 static void
4368getwinvar(
4369 typval_T *argvars,
4370 typval_T *rettv,
4371 int off) // 1 for gettabwinvar()
4372{
4373 char_u *varname;
4374 tabpage_T *tp;
4375 win_T *win;
4376
4377 if (off == 1)
4378 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
4379 else
4380 tp = curtab;
4381 win = find_win_by_nr(&argvars[off], tp);
4382 varname = tv_get_string_chk(&argvars[off + 1]);
4383
4384 get_var_from(varname, rettv, &argvars[off + 2], 'w', tp, win, NULL);
4385}
4386
4387/*
Bram Moolenaar191929b2020-08-19 21:20:49 +02004388 * Set option "varname" to the value of "varp" for the current buffer/window.
4389 */
4390 static void
4391set_option_from_tv(char_u *varname, typval_T *varp)
4392{
4393 long numval = 0;
4394 char_u *strval;
4395 char_u nbuf[NUMBUFLEN];
4396 int error = FALSE;
4397
zeertzjq4c7cb372023-06-14 16:39:54 +01004398 int opt_idx = findoption(varname);
4399 if (opt_idx < 0)
4400 {
4401 semsg(_(e_unknown_option_str_2), varname);
4402 return;
4403 }
4404 int opt_p_flags = get_option_flags(opt_idx);
4405
Bram Moolenaar31a201a2021-01-03 14:47:25 +01004406 if (varp->v_type == VAR_BOOL)
Bram Moolenaarb0d81822021-01-03 15:55:10 +01004407 {
zeertzjq4c7cb372023-06-14 16:39:54 +01004408 if (opt_p_flags & P_STRING)
Bram Moolenaar28f84e12022-07-27 12:30:13 +01004409 {
4410 emsg(_(e_string_required));
4411 return;
4412 }
Bram Moolenaar31a201a2021-01-03 14:47:25 +01004413 numval = (long)varp->vval.v_number;
Bram Moolenaarb0d81822021-01-03 15:55:10 +01004414 strval = (char_u *)"0"; // avoid using "false"
4415 }
4416 else
4417 {
zeertzjq4c7cb372023-06-14 16:39:54 +01004418 if ((opt_p_flags & (P_NUM|P_BOOL))
4419 && (!in_vim9script() || varp->v_type != VAR_STRING))
Bram Moolenaarb0d81822021-01-03 15:55:10 +01004420 numval = (long)tv_get_number_chk(varp, &error);
zeertzjq4c7cb372023-06-14 16:39:54 +01004421 if (!error)
4422 strval = tv_get_string_buf_chk(varp, nbuf);
Bram Moolenaarb0d81822021-01-03 15:55:10 +01004423 }
Bram Moolenaar191929b2020-08-19 21:20:49 +02004424 if (!error && strval != NULL)
Bram Moolenaar31e5c602022-04-15 13:53:33 +01004425 set_option_value_give_err(varname, numval, strval, OPT_LOCAL);
Bram Moolenaar191929b2020-08-19 21:20:49 +02004426}
4427
4428/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004429 * "setwinvar()" and "settabwinvar()" functions
4430 */
4431 static void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004432setwinvar(typval_T *argvars, int off)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004433{
4434 win_T *win;
Bram Moolenaar18f47402022-01-06 13:24:51 +00004435 switchwin_T switchwin;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004436 int need_switch_win;
4437 char_u *varname, *winvarname;
4438 typval_T *varp;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004439 tabpage_T *tp = NULL;
4440
4441 if (check_secure())
4442 return;
4443
4444 if (off == 1)
4445 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
4446 else
4447 tp = curtab;
4448 win = find_win_by_nr(&argvars[off], tp);
4449 varname = tv_get_string_chk(&argvars[off + 1]);
4450 varp = &argvars[off + 2];
4451
zeertzjqea720ae2023-01-03 10:54:09 +00004452 if (win == NULL || varname == NULL)
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00004453 return;
4454
4455 need_switch_win = !(tp == curtab && win == curwin);
4456 if (!need_switch_win
4457 || switch_win(&switchwin, win, tp, TRUE) == OK)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004458 {
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00004459 if (*varname == '&')
4460 set_option_from_tv(varname + 1, varp);
4461 else
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004462 {
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00004463 winvarname = alloc(STRLEN(varname) + 3);
4464 if (winvarname != NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004465 {
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00004466 STRCPY(winvarname, "w:");
4467 STRCPY(winvarname + 2, varname);
4468 set_var(winvarname, varp, TRUE);
4469 vim_free(winvarname);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004470 }
4471 }
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004472 }
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00004473 if (need_switch_win)
4474 restore_win(&switchwin, TRUE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004475}
4476
Bram Moolenaare5cdf152019-08-29 22:09:46 +02004477/*
4478 * reset v:option_new, v:option_old, v:option_oldlocal, v:option_oldglobal,
4479 * v:option_type, and v:option_command.
4480 */
4481 void
4482reset_v_option_vars(void)
4483{
4484 set_vim_var_string(VV_OPTION_NEW, NULL, -1);
4485 set_vim_var_string(VV_OPTION_OLD, NULL, -1);
4486 set_vim_var_string(VV_OPTION_OLDLOCAL, NULL, -1);
4487 set_vim_var_string(VV_OPTION_OLDGLOBAL, NULL, -1);
4488 set_vim_var_string(VV_OPTION_TYPE, NULL, -1);
4489 set_vim_var_string(VV_OPTION_COMMAND, NULL, -1);
4490}
4491
4492/*
4493 * Add an assert error to v:errors.
4494 */
4495 void
4496assert_error(garray_T *gap)
4497{
4498 struct vimvar *vp = &vimvars[VV_ERRORS];
4499
Bram Moolenaard787e402021-12-24 21:36:12 +00004500 if (vp->vv_tv_type != VAR_LIST || vimvars[VV_ERRORS].vv_list == NULL)
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004501 // Make sure v:errors is a list.
Bram Moolenaare5cdf152019-08-29 22:09:46 +02004502 set_vim_var_list(VV_ERRORS, list_alloc());
4503 list_append_string(vimvars[VV_ERRORS].vv_list, gap->ga_data, gap->ga_len);
4504}
4505
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004506 int
4507var_exists(char_u *var)
4508{
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02004509 char_u *arg = var;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004510 char_u *name;
4511 char_u *tofree;
4512 typval_T tv;
4513 int len = 0;
4514 int n = FALSE;
4515
4516 // get_name_len() takes care of expanding curly braces
4517 name = var;
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02004518 len = get_name_len(&arg, &tofree, TRUE, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004519 if (len > 0)
4520 {
4521 if (tofree != NULL)
4522 name = tofree;
Bram Moolenaard5f400c2022-01-06 21:10:28 +00004523 n = (eval_variable(name, len, 0, &tv, NULL,
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01004524 EVAL_VAR_NOAUTOLOAD + EVAL_VAR_IMPORT) == OK);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004525 if (n)
4526 {
4527 // handle d.key, l[idx], f(expr)
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02004528 arg = skipwhite(arg);
Bram Moolenaar32884ad2022-01-07 12:45:29 +00004529 n = (handle_subscript(&arg, name, &tv, &EVALARG_EVALUATE,
4530 FALSE) == OK);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004531 if (n)
4532 clear_tv(&tv);
4533 }
4534 }
Bram Moolenaarbb1b5e22020-08-05 10:53:21 +02004535 if (*arg != NUL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004536 n = FALSE;
4537
4538 vim_free(tofree);
4539 return n;
4540}
4541
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004542static lval_T *redir_lval = NULL;
4543#define EVALCMD_BUSY (redir_lval == (lval_T *)&redir_lval)
4544static garray_T redir_ga; // only valid when redir_lval is not NULL
4545static char_u *redir_endp = NULL;
4546static char_u *redir_varname = NULL;
4547
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004548 int
4549alloc_redir_lval(void)
4550{
4551 redir_lval = ALLOC_CLEAR_ONE(lval_T);
4552 if (redir_lval == NULL)
4553 return FAIL;
4554 return OK;
4555}
4556
4557 void
4558clear_redir_lval(void)
4559{
4560 VIM_CLEAR(redir_lval);
4561}
4562
4563 void
4564init_redir_ga(void)
4565{
Bram Moolenaar04935fb2022-01-08 16:19:22 +00004566 ga_init2(&redir_ga, sizeof(char), 500);
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004567}
4568
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004569/*
4570 * Start recording command output to a variable
4571 * When "append" is TRUE append to an existing variable.
4572 * Returns OK if successfully completed the setup. FAIL otherwise.
4573 */
4574 int
4575var_redir_start(char_u *name, int append)
4576{
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02004577 int called_emsg_before;
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004578 typval_T tv;
4579
4580 // Catch a bad name early.
4581 if (!eval_isnamec1(*name))
4582 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00004583 emsg(_(e_invalid_argument));
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004584 return FAIL;
4585 }
4586
4587 // Make a copy of the name, it is used in redir_lval until redir ends.
4588 redir_varname = vim_strsave(name);
4589 if (redir_varname == NULL)
4590 return FAIL;
4591
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004592 if (alloc_redir_lval() == FAIL)
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004593 {
4594 var_redir_stop();
4595 return FAIL;
4596 }
4597
4598 // The output is stored in growarray "redir_ga" until redirection ends.
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004599 init_redir_ga();
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004600
4601 // Parse the variable name (can be a dict or list entry).
4602 redir_endp = get_lval(redir_varname, NULL, redir_lval, FALSE, FALSE, 0,
4603 FNE_CHECK_START);
4604 if (redir_endp == NULL || redir_lval->ll_name == NULL || *redir_endp != NUL)
4605 {
4606 clear_lval(redir_lval);
4607 if (redir_endp != NULL && *redir_endp != NUL)
4608 // Trailing characters are present after the variable name
Bram Moolenaar74409f62022-01-01 15:58:22 +00004609 semsg(_(e_trailing_characters_str), redir_endp);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004610 else
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00004611 semsg(_(e_invalid_argument_str), name);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004612 redir_endp = NULL; // don't store a value, only cleanup
4613 var_redir_stop();
4614 return FAIL;
4615 }
4616
4617 // check if we can write to the variable: set it to or append an empty
4618 // string
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02004619 called_emsg_before = called_emsg;
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004620 tv.v_type = VAR_STRING;
4621 tv.vval.v_string = (char_u *)"";
4622 if (append)
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +02004623 set_var_lval(redir_lval, redir_endp, &tv, TRUE,
Bram Moolenaarf785aa12021-02-11 21:19:34 +01004624 ASSIGN_NO_DECL, (char_u *)".", 0);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004625 else
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +02004626 set_var_lval(redir_lval, redir_endp, &tv, TRUE,
Bram Moolenaarf785aa12021-02-11 21:19:34 +01004627 ASSIGN_NO_DECL, (char_u *)"=", 0);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004628 clear_lval(redir_lval);
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +02004629 if (called_emsg > called_emsg_before)
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004630 {
4631 redir_endp = NULL; // don't store a value, only cleanup
4632 var_redir_stop();
4633 return FAIL;
4634 }
4635
4636 return OK;
4637}
4638
4639/*
4640 * Append "value[value_len]" to the variable set by var_redir_start().
4641 * The actual appending is postponed until redirection ends, because the value
4642 * appended may in fact be the string we write to, changing it may cause freed
4643 * memory to be used:
4644 * :redir => foo
4645 * :let foo
4646 * :redir END
4647 */
4648 void
4649var_redir_str(char_u *value, int value_len)
4650{
4651 int len;
4652
4653 if (redir_lval == NULL)
4654 return;
4655
4656 if (value_len == -1)
4657 len = (int)STRLEN(value); // Append the entire string
4658 else
4659 len = value_len; // Append only "value_len" characters
4660
4661 if (ga_grow(&redir_ga, len) == OK)
4662 {
4663 mch_memmove((char *)redir_ga.ga_data + redir_ga.ga_len, value, len);
4664 redir_ga.ga_len += len;
4665 }
4666 else
4667 var_redir_stop();
4668}
4669
4670/*
4671 * Stop redirecting command output to a variable.
4672 * Frees the allocated memory.
4673 */
4674 void
4675var_redir_stop(void)
4676{
4677 typval_T tv;
4678
4679 if (EVALCMD_BUSY)
4680 {
4681 redir_lval = NULL;
4682 return;
4683 }
4684
4685 if (redir_lval != NULL)
4686 {
4687 // If there was no error: assign the text to the variable.
4688 if (redir_endp != NULL)
4689 {
4690 ga_append(&redir_ga, NUL); // Append the trailing NUL.
4691 tv.v_type = VAR_STRING;
4692 tv.vval.v_string = redir_ga.ga_data;
4693 // Call get_lval() again, if it's inside a Dict or List it may
4694 // have changed.
4695 redir_endp = get_lval(redir_varname, NULL, redir_lval,
4696 FALSE, FALSE, 0, FNE_CHECK_START);
4697 if (redir_endp != NULL && redir_lval->ll_name != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004698 set_var_lval(redir_lval, redir_endp, &tv, FALSE, 0,
Bram Moolenaarf785aa12021-02-11 21:19:34 +01004699 (char_u *)".", 0);
Bram Moolenaarda6c0332019-09-01 16:01:30 +02004700 clear_lval(redir_lval);
4701 }
4702
4703 // free the collected output
4704 VIM_CLEAR(redir_ga.ga_data);
4705
4706 VIM_CLEAR(redir_lval);
4707 }
4708 VIM_CLEAR(redir_varname);
4709}
4710
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004711/*
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004712 * Get the collected redirected text and clear redir_ga.
4713 */
4714 char_u *
4715get_clear_redir_ga(void)
4716{
4717 char_u *res;
4718
4719 ga_append(&redir_ga, NUL); // Append the trailing NUL.
4720 res = redir_ga.ga_data;
4721 redir_ga.ga_data = NULL;
4722 return res;
4723}
4724
4725/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004726 * "gettabvar()" function
4727 */
4728 void
4729f_gettabvar(typval_T *argvars, typval_T *rettv)
4730{
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004731 char_u *varname;
LemonBoy47d4e312022-05-04 18:12:55 +01004732 tabpage_T *tp;
4733 win_T *win = NULL;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004734
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004735 if (in_vim9script()
4736 && (check_for_number_arg(argvars, 0) == FAIL
4737 || check_for_string_arg(argvars, 1) == FAIL))
4738 return;
4739
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004740 varname = tv_get_string_chk(&argvars[1]);
4741 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
LemonBoy47d4e312022-05-04 18:12:55 +01004742 if (tp != NULL)
4743 win = tp == curtab || tp->tp_firstwin == NULL ? firstwin
4744 : tp->tp_firstwin;
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004745
LemonBoy47d4e312022-05-04 18:12:55 +01004746 get_var_from(varname, rettv, &argvars[2], 't', tp, win, NULL);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004747}
4748
4749/*
4750 * "gettabwinvar()" function
4751 */
4752 void
4753f_gettabwinvar(typval_T *argvars, typval_T *rettv)
4754{
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004755 if (in_vim9script()
4756 && (check_for_number_arg(argvars, 0) == FAIL
4757 || check_for_number_arg(argvars, 1) == FAIL
4758 || check_for_string_arg(argvars, 2) == FAIL))
4759 return;
4760
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004761 getwinvar(argvars, rettv, 1);
4762}
4763
4764/*
4765 * "getwinvar()" function
4766 */
4767 void
4768f_getwinvar(typval_T *argvars, typval_T *rettv)
4769{
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004770 if (in_vim9script()
4771 && (check_for_number_arg(argvars, 0) == FAIL
4772 || check_for_string_arg(argvars, 1) == FAIL))
4773 return;
4774
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004775 getwinvar(argvars, rettv, 0);
4776}
4777
4778/*
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004779 * "getbufvar()" function
4780 */
4781 void
4782f_getbufvar(typval_T *argvars, typval_T *rettv)
4783{
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004784 char_u *varname;
LemonBoy47d4e312022-05-04 18:12:55 +01004785 buf_T *buf;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004786
Yegappan Lakshmanan7973de32021-07-24 16:16:15 +02004787 if (in_vim9script()
4788 && (check_for_buffer_arg(argvars, 0) == FAIL
4789 || check_for_string_arg(argvars, 1) == FAIL))
4790 return;
4791
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004792 varname = tv_get_string_chk(&argvars[1]);
Bram Moolenaar6f84b6d2020-09-01 23:16:32 +02004793 buf = tv_get_buf_from_arg(&argvars[0]);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004794
LemonBoy47d4e312022-05-04 18:12:55 +01004795 get_var_from(varname, rettv, &argvars[2], 'b', curtab, curwin, buf);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004796}
4797
4798/*
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004799 * "settabvar()" function
4800 */
4801 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004802f_settabvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004803{
4804 tabpage_T *save_curtab;
4805 tabpage_T *tp;
4806 char_u *varname, *tabvarname;
4807 typval_T *varp;
4808
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004809 if (check_secure())
4810 return;
4811
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004812 if (in_vim9script()
4813 && (check_for_number_arg(argvars, 0) == FAIL
4814 || check_for_string_arg(argvars, 1) == FAIL))
4815 return;
4816
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004817 tp = find_tabpage((int)tv_get_number_chk(&argvars[0], NULL));
4818 varname = tv_get_string_chk(&argvars[1]);
4819 varp = &argvars[2];
4820
zeertzjqea720ae2023-01-03 10:54:09 +00004821 if (varname == NULL || tp == NULL)
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00004822 return;
4823
4824 save_curtab = curtab;
4825 goto_tabpage_tp(tp, FALSE, FALSE);
4826
4827 tabvarname = alloc(STRLEN(varname) + 3);
4828 if (tabvarname != NULL)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004829 {
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00004830 STRCPY(tabvarname, "t:");
4831 STRCPY(tabvarname + 2, varname);
4832 set_var(tabvarname, varp, TRUE);
4833 vim_free(tabvarname);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004834 }
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00004835
4836 // Restore current tabpage
4837 if (valid_tabpage(save_curtab))
4838 goto_tabpage_tp(save_curtab, FALSE, FALSE);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004839}
4840
4841/*
4842 * "settabwinvar()" function
4843 */
4844 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004845f_settabwinvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004846{
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004847 if (in_vim9script()
4848 && (check_for_number_arg(argvars, 0) == FAIL
4849 || check_for_number_arg(argvars, 1) == FAIL
4850 || check_for_string_arg(argvars, 2) == FAIL))
4851 return;
4852
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004853 setwinvar(argvars, 1);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004854}
4855
4856/*
4857 * "setwinvar()" function
4858 */
4859 void
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004860f_setwinvar(typval_T *argvars, typval_T *rettv UNUSED)
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004861{
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02004862 if (in_vim9script()
4863 && (check_for_number_arg(argvars, 0) == FAIL
4864 || check_for_string_arg(argvars, 1) == FAIL))
4865 return;
4866
Bram Moolenaar3d8a5132020-01-04 16:13:49 +01004867 setwinvar(argvars, 0);
Bram Moolenaar0522ba02019-08-27 22:48:30 +02004868}
4869
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004870/*
4871 * "setbufvar()" function
4872 */
4873 void
4874f_setbufvar(typval_T *argvars, typval_T *rettv UNUSED)
4875{
4876 buf_T *buf;
4877 char_u *varname, *bufvarname;
4878 typval_T *varp;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004879
4880 if (check_secure())
4881 return;
Yegappan Lakshmanan7973de32021-07-24 16:16:15 +02004882
4883 if (in_vim9script()
4884 && (check_for_buffer_arg(argvars, 0) == FAIL
4885 || check_for_string_arg(argvars, 1) == FAIL))
4886 return;
4887
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004888 varname = tv_get_string_chk(&argvars[1]);
Bram Moolenaar6f84b6d2020-09-01 23:16:32 +02004889 buf = tv_get_buf_from_arg(&argvars[0]);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004890 varp = &argvars[2];
4891
zeertzjqea720ae2023-01-03 10:54:09 +00004892 if (buf == NULL || varname == NULL)
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00004893 return;
4894
4895 if (*varname == '&')
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004896 {
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00004897 aco_save_T aco;
4898
4899 // Set curbuf to be our buf, temporarily.
4900 aucmd_prepbuf(&aco, buf);
4901 if (curbuf == buf)
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004902 {
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00004903 // Only when it worked to set "curbuf".
4904 set_option_from_tv(varname + 1, varp);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004905
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00004906 // reset notion of buffer
4907 aucmd_restbuf(&aco);
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004908 }
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00004909 }
4910 else
4911 {
4912 bufvarname = alloc(STRLEN(varname) + 3);
4913 if (bufvarname != NULL)
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004914 {
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00004915 buf_T *save_curbuf = curbuf;
Bram Moolenaar86015452020-03-29 15:12:15 +02004916
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00004917 curbuf = buf;
4918 STRCPY(bufvarname, "b:");
4919 STRCPY(bufvarname + 2, varname);
4920 set_var(bufvarname, varp, TRUE);
4921 vim_free(bufvarname);
4922 curbuf = save_curbuf;
Bram Moolenaar8d71b542019-08-30 15:46:30 +02004923 }
4924 }
4925}
4926
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004927/*
4928 * Get a callback from "arg". It can be a Funcref or a function name.
Bram Moolenaarc96b7f52022-12-02 15:58:38 +00004929 * When "arg" is zero "res.cb_name" is set to an empty string.
4930 * If "res.cb_name" is allocated then "res.cb_free_name" is set to TRUE.
4931 * "res.cb_name" is set to NULL for an invalid argument.
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004932 */
4933 callback_T
4934get_callback(typval_T *arg)
4935{
Bram Moolenaar14e579092020-03-07 16:59:25 +01004936 callback_T res;
4937 int r = OK;
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004938
Bram Moolenaarc96b7f52022-12-02 15:58:38 +00004939 CLEAR_FIELD(res);
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004940 if (arg->v_type == VAR_PARTIAL && arg->vval.v_partial != NULL)
4941 {
4942 res.cb_partial = arg->vval.v_partial;
4943 ++res.cb_partial->pt_refcount;
4944 res.cb_name = partial_name(res.cb_partial);
4945 }
4946 else
4947 {
Bram Moolenaar14e579092020-03-07 16:59:25 +01004948 if (arg->v_type == VAR_STRING && arg->vval.v_string != NULL
4949 && isdigit(*arg->vval.v_string))
4950 r = FAIL;
4951 else if (arg->v_type == VAR_FUNC || arg->v_type == VAR_STRING)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004952 {
Bram Moolenaarc96b7f52022-12-02 15:58:38 +00004953 res.cb_name = arg->vval.v_string;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004954 if (arg->v_type == VAR_STRING)
4955 {
Bram Moolenaarc96b7f52022-12-02 15:58:38 +00004956 char_u *name = get_scriptlocal_funcname(arg->vval.v_string);
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004957 if (name != NULL)
4958 {
Bram Moolenaarc96b7f52022-12-02 15:58:38 +00004959 res.cb_name = name;
4960 res.cb_free_name = TRUE;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004961 }
4962 }
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004963 func_ref(res.cb_name);
4964 }
4965 else if (arg->v_type == VAR_NUMBER && arg->vval.v_number == 0)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004966 res.cb_name = (char_u *)"";
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004967 else
Bram Moolenaar14e579092020-03-07 16:59:25 +01004968 r = FAIL;
4969
4970 if (r == FAIL)
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004971 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00004972 emsg(_(e_invalid_callback_argument));
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02004973 res.cb_name = NULL;
4974 }
4975 }
4976 return res;
4977}
4978
4979/*
4980 * Copy a callback into a typval_T.
4981 */
4982 void
4983put_callback(callback_T *cb, typval_T *tv)
4984{
4985 if (cb->cb_partial != NULL)
4986 {
4987 tv->v_type = VAR_PARTIAL;
4988 tv->vval.v_partial = cb->cb_partial;
4989 ++tv->vval.v_partial->pt_refcount;
4990 }
4991 else
4992 {
4993 tv->v_type = VAR_FUNC;
4994 tv->vval.v_string = vim_strsave(cb->cb_name);
4995 func_ref(cb->cb_name);
4996 }
4997}
4998
4999/*
5000 * Make a copy of "src" into "dest", allocating the function name if needed,
5001 * without incrementing the refcount.
5002 */
5003 void
5004set_callback(callback_T *dest, callback_T *src)
5005{
5006 if (src->cb_partial == NULL)
5007 {
5008 // just a function name, make a copy
5009 dest->cb_name = vim_strsave(src->cb_name);
5010 dest->cb_free_name = TRUE;
5011 }
5012 else
5013 {
5014 // cb_name is a pointer into cb_partial
5015 dest->cb_name = src->cb_name;
5016 dest->cb_free_name = FALSE;
5017 }
5018 dest->cb_partial = src->cb_partial;
5019}
5020
5021/*
Bram Moolenaard43906d2020-07-20 21:31:32 +02005022 * Copy callback from "src" to "dest", incrementing the refcounts.
5023 */
5024 void
5025copy_callback(callback_T *dest, callback_T *src)
5026{
5027 dest->cb_partial = src->cb_partial;
5028 if (dest->cb_partial != NULL)
5029 {
5030 dest->cb_name = src->cb_name;
5031 dest->cb_free_name = FALSE;
5032 ++dest->cb_partial->pt_refcount;
5033 }
5034 else
5035 {
5036 dest->cb_name = vim_strsave(src->cb_name);
5037 dest->cb_free_name = TRUE;
5038 func_ref(src->cb_name);
5039 }
5040}
5041
5042/*
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00005043 * When a callback refers to an autoload import, change the function name to
5044 * the "path#name" form. Uses the current script context.
5045 * Only works when the name is allocated.
5046 */
5047 void
5048expand_autload_callback(callback_T *cb)
5049{
Bram Moolenaar3e93a2b2022-01-24 21:28:01 +00005050 char_u *name;
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00005051 char_u *p;
5052 imported_T *import;
5053
Bram Moolenaar3e93a2b2022-01-24 21:28:01 +00005054 if (!in_vim9script() || cb->cb_name == NULL
5055 || (!cb->cb_free_name
5056 && (cb->cb_partial == NULL || cb->cb_partial->pt_name == NULL)))
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00005057 return;
Bram Moolenaar3e93a2b2022-01-24 21:28:01 +00005058 if (cb->cb_partial != NULL)
5059 name = cb->cb_partial->pt_name;
5060 else
5061 name = cb->cb_name;
5062 p = vim_strchr(name, '.');
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00005063 if (p == NULL)
5064 return;
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00005065
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00005066 import = find_imported(name, p - name, FALSE);
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00005067 if (import == NULL || !SCRIPT_ID_VALID(import->imp_sid))
5068 return;
5069
5070 scriptitem_T *si = SCRIPT_ITEM(import->imp_sid);
5071 if (si->sn_autoload_prefix == NULL)
5072 return;
5073
5074 char_u *newname = concat_str(si->sn_autoload_prefix, p + 1);
5075 if (newname == NULL)
5076 return;
5077
5078 if (cb->cb_partial != NULL)
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00005079 {
Yegappan Lakshmanandc4daa32023-01-02 16:54:53 +00005080 if (cb->cb_name == cb->cb_partial->pt_name)
5081 cb->cb_name = newname;
5082 vim_free(cb->cb_partial->pt_name);
5083 cb->cb_partial->pt_name = newname;
5084 }
5085 else
5086 {
5087 vim_free(cb->cb_name);
5088 cb->cb_name = newname;
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00005089 }
5090}
5091
5092/*
Bram Moolenaaraf7645d2019-09-05 22:33:28 +02005093 * Unref/free "callback" returned by get_callback() or set_callback().
5094 */
5095 void
5096free_callback(callback_T *callback)
5097{
5098 if (callback->cb_partial != NULL)
5099 {
5100 partial_unref(callback->cb_partial);
5101 callback->cb_partial = NULL;
5102 }
5103 else if (callback->cb_name != NULL)
5104 func_unref(callback->cb_name);
5105 if (callback->cb_free_name)
5106 {
5107 vim_free(callback->cb_name);
5108 callback->cb_free_name = FALSE;
5109 }
5110 callback->cb_name = NULL;
5111}
5112
Bram Moolenaar0522ba02019-08-27 22:48:30 +02005113#endif // FEAT_EVAL