blob: 3d8921ad853de5ca1ebd145754867ab339c6c97d [file] [log] [blame]
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001/* 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/*
Bram Moolenaardc7c3662021-12-20 15:04:29 +000011 * vim9compile.c: compiling a :def function
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010012 */
13
14#define USING_FLOAT_STUFF
15#include "vim.h"
16
17#if defined(FEAT_EVAL) || defined(PROTO)
18
Bram Moolenaardc7c3662021-12-20 15:04:29 +000019// When not generating protos this is included in proto.h
20#ifdef PROTO
21# include "vim9.h"
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010022#endif
23
Bram Moolenaardc7c3662021-12-20 15:04:29 +000024// Functions defined with :def are stored in this growarray.
25// They are never removed, so that they can be found by index.
26// Deleted functions have the df_deleted flag set.
27garray_T def_functions = {0, 0, sizeof(dfunc_T), 50, NULL};
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010028
Bram Moolenaarcdc40c42020-12-26 17:43:08 +010029static void delete_def_function_contents(dfunc_T *dfunc, int mark_deleted);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010030
31/*
Bram Moolenaar709664c2020-12-12 14:33:41 +010032 * Lookup variable "name" in the local scope and return it in "lvar".
Bram Moolenaarab360522021-01-10 14:02:28 +010033 * "lvar->lv_from_outer" is incremented accordingly.
Bram Moolenaar709664c2020-12-12 14:33:41 +010034 * If "lvar" is NULL only check if the variable can be found.
35 * Return FAIL if not found.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010036 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +000037 int
Bram Moolenaar709664c2020-12-12 14:33:41 +010038lookup_local(char_u *name, size_t len, lvar_T *lvar, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010039{
40 int idx;
Bram Moolenaar709664c2020-12-12 14:33:41 +010041 lvar_T *lvp;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010042
Bram Moolenaarae8d2de2020-02-13 21:42:24 +010043 if (len == 0)
Bram Moolenaar709664c2020-12-12 14:33:41 +010044 return FAIL;
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +020045
Bram Moolenaar58b40092023-01-11 15:59:05 +000046 if (((len == 4 && STRNCMP(name, "this", 4) == 0)
47 || (len == 5 && STRNCMP(name, "super", 5) == 0))
Bram Moolenaar00b28d62022-12-08 15:32:33 +000048 && cctx->ctx_ufunc != NULL
Bram Moolenaar574950d2023-01-03 19:08:50 +000049 && (cctx->ctx_ufunc->uf_flags & (FC_OBJECT|FC_NEW)))
Bram Moolenaar00b28d62022-12-08 15:32:33 +000050 {
Bram Moolenaar58b40092023-01-11 15:59:05 +000051 int is_super = *name == 's';
Bram Moolenaar6aa09372023-01-11 17:59:38 +000052 if (is_super)
53 {
54 if (name[5] != '.')
55 {
56 emsg(_(e_super_must_be_followed_by_dot));
57 return FAIL;
58 }
59 if (cctx->ctx_ufunc->uf_class != NULL
60 && cctx->ctx_ufunc->uf_class->class_extends == NULL)
61 {
62 emsg(_(e_using_super_not_in_child_class));
63 return FAIL;
64 }
65 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +000066 if (lvar != NULL)
67 {
68 CLEAR_POINTER(lvar);
Bram Moolenaar486fc252023-01-18 14:51:07 +000069 lvar->lv_loop_depth = -1;
Bram Moolenaar58b40092023-01-11 15:59:05 +000070 lvar->lv_name = (char_u *)(is_super ? "super" : "this");
Bram Moolenaar00b28d62022-12-08 15:32:33 +000071 if (cctx->ctx_ufunc->uf_class != NULL)
Bram Moolenaar58b40092023-01-11 15:59:05 +000072 {
Bram Moolenaarffdaca92022-12-09 21:41:48 +000073 lvar->lv_type = &cctx->ctx_ufunc->uf_class->class_object_type;
Bram Moolenaar58b40092023-01-11 15:59:05 +000074 if (is_super)
75 {
76 type_T *type = get_type_ptr(cctx->ctx_type_list);
77
78 if (type != NULL)
79 {
80 *type = *lvar->lv_type;
81 lvar->lv_type = type;
82 type->tt_flags |= TTFLAG_SUPER;
83 }
84 }
85 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +000086 }
87 return OK;
88 }
89
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +020090 // Find local in current function scope.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010091 for (idx = 0; idx < cctx->ctx_locals.ga_len; ++idx)
92 {
Bram Moolenaar709664c2020-12-12 14:33:41 +010093 lvp = ((lvar_T *)cctx->ctx_locals.ga_data) + idx;
Bram Moolenaara275f2c2022-10-11 20:04:09 +010094 if (lvp->lv_name != NULL
95 && STRNCMP(name, lvp->lv_name, len) == 0
Bram Moolenaar709664c2020-12-12 14:33:41 +010096 && STRLEN(lvp->lv_name) == len)
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +020097 {
Bram Moolenaar709664c2020-12-12 14:33:41 +010098 if (lvar != NULL)
99 {
100 *lvar = *lvp;
Bram Moolenaarab360522021-01-10 14:02:28 +0100101 lvar->lv_from_outer = 0;
Bram Moolenaar65449bd2022-09-19 16:02:43 +0100102 // If the variable was declared inside a loop set
103 // lvar->lv_loop_idx and lvar->lv_loop_depth.
104 get_loop_var_idx(cctx, idx, lvar);
Bram Moolenaar709664c2020-12-12 14:33:41 +0100105 }
106 return OK;
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +0200107 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100108 }
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +0200109
110 // Find local in outer function scope.
111 if (cctx->ctx_outer != NULL)
112 {
Bram Moolenaar709664c2020-12-12 14:33:41 +0100113 if (lookup_local(name, len, lvar, cctx->ctx_outer) == OK)
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +0200114 {
Bram Moolenaar709664c2020-12-12 14:33:41 +0100115 if (lvar != NULL)
116 {
117 cctx->ctx_outer_used = TRUE;
Bram Moolenaarab360522021-01-10 14:02:28 +0100118 ++lvar->lv_from_outer;
Bram Moolenaar709664c2020-12-12 14:33:41 +0100119 }
120 return OK;
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +0200121 }
122 }
123
Bram Moolenaar709664c2020-12-12 14:33:41 +0100124 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100125}
126
127/*
Bram Moolenaar2fd4cd72020-05-03 22:30:49 +0200128 * Lookup an argument in the current function and an enclosing function.
129 * Returns the argument index in "idxp"
130 * Returns the argument type in "type"
131 * Sets "gen_load_outer" to TRUE if found in outer scope.
132 * Returns OK when found, FAIL otherwise.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100133 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +0000134 int
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200135arg_exists(
Bram Moolenaar2fd4cd72020-05-03 22:30:49 +0200136 char_u *name,
137 size_t len,
138 int *idxp,
139 type_T **type,
140 int *gen_load_outer,
141 cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100142{
143 int idx;
Bram Moolenaar2fd4cd72020-05-03 22:30:49 +0200144 char_u *va_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100145
Bram Moolenaarae8d2de2020-02-13 21:42:24 +0100146 if (len == 0)
Bram Moolenaar2fd4cd72020-05-03 22:30:49 +0200147 return FAIL;
Bram Moolenaare28d9b32021-07-03 18:56:53 +0200148 for (idx = 0; idx < cctx->ctx_ufunc->uf_args_visible; ++idx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100149 {
150 char_u *arg = FUNCARG(cctx->ctx_ufunc, idx);
151
Bram Moolenaar2fd4cd72020-05-03 22:30:49 +0200152 if (STRNCMP(name, arg, len) == 0 && arg[len] == NUL)
153 {
154 if (idxp != NULL)
155 {
156 // Arguments are located above the frame pointer. One further
157 // if there is a vararg argument
158 *idxp = idx - (cctx->ctx_ufunc->uf_args.ga_len
159 + STACK_FRAME_SIZE)
160 + (cctx->ctx_ufunc->uf_va_name != NULL ? -1 : 0);
161
162 if (cctx->ctx_ufunc->uf_arg_types != NULL)
163 *type = cctx->ctx_ufunc->uf_arg_types[idx];
164 else
165 *type = &t_any;
166 }
167 return OK;
168 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100169 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100170
Bram Moolenaar2fd4cd72020-05-03 22:30:49 +0200171 va_name = cctx->ctx_ufunc->uf_va_name;
172 if (va_name != NULL
173 && STRNCMP(name, va_name, len) == 0 && va_name[len] == NUL)
174 {
175 if (idxp != NULL)
176 {
177 // varargs is always the last argument
178 *idxp = -STACK_FRAME_SIZE - 1;
179 *type = cctx->ctx_ufunc->uf_va_type;
180 }
181 return OK;
182 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100183
Bram Moolenaar2fd4cd72020-05-03 22:30:49 +0200184 if (cctx->ctx_outer != NULL)
185 {
186 // Lookup the name for an argument of the outer function.
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200187 if (arg_exists(name, len, idxp, type, gen_load_outer, cctx->ctx_outer)
Bram Moolenaar2fd4cd72020-05-03 22:30:49 +0200188 == OK)
189 {
Bram Moolenaar44ec21c2021-02-12 21:50:57 +0100190 if (gen_load_outer != NULL)
191 ++*gen_load_outer;
Bram Moolenaar2fd4cd72020-05-03 22:30:49 +0200192 return OK;
193 }
194 }
195
196 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100197}
198
199/*
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200200 * Lookup a script-local variable in the current script, possibly defined in a
201 * block that contains the function "cctx->ctx_ufunc".
Bram Moolenaar7a3b8022022-02-14 19:53:03 +0000202 * "cctx" is NULL at the script level, "cstack" is NULL in a function.
Bram Moolenaar18062fc2021-03-05 21:35:47 +0100203 * If "len" is <= 0 "name" must be NUL terminated.
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200204 * Return NULL when not found.
205 */
206 static sallvar_T *
Bram Moolenaardce24412022-02-08 20:35:30 +0000207find_script_var(char_u *name, size_t len, cctx_T *cctx, cstack_T *cstack)
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200208{
209 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
210 hashitem_T *hi;
211 int cc;
212 sallvar_T *sav;
213 ufunc_T *ufunc;
214
215 // Find the list of all script variables with the right name.
216 if (len > 0)
217 {
218 cc = name[len];
219 name[len] = NUL;
220 }
221 hi = hash_find(&si->sn_all_vars.dv_hashtab, name);
222 if (len > 0)
223 name[len] = cc;
224 if (HASHITEM_EMPTY(hi))
225 return NULL;
226
227 sav = HI2SAV(hi);
Bram Moolenaar3c77b6a2021-07-25 18:07:00 +0200228 if (sav->sav_block_id == 0)
229 // variable defined in the top script scope is always visible
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200230 return sav;
231
Bram Moolenaar3c77b6a2021-07-25 18:07:00 +0200232 if (cctx == NULL)
233 {
Bram Moolenaar766ae5b2022-09-14 00:30:51 +0100234 if (cstack == NULL)
235 return NULL;
236
Bram Moolenaardce24412022-02-08 20:35:30 +0000237 // Not in a function scope, find variable with block ID equal to or
Bram Moolenaar7a3b8022022-02-14 19:53:03 +0000238 // smaller than the current block id. Use "cstack" to go up the block
239 // scopes.
Bram Moolenaar3c77b6a2021-07-25 18:07:00 +0200240 while (sav != NULL)
241 {
Bram Moolenaar7a3b8022022-02-14 19:53:03 +0000242 int idx;
Bram Moolenaardce24412022-02-08 20:35:30 +0000243
Bram Moolenaar7a3b8022022-02-14 19:53:03 +0000244 for (idx = cstack->cs_idx; idx >= 0; --idx)
245 if (cstack->cs_block_id[idx] == sav->sav_block_id)
Bram Moolenaardce24412022-02-08 20:35:30 +0000246 break;
Bram Moolenaar7a3b8022022-02-14 19:53:03 +0000247 if (idx >= 0)
Bram Moolenaar3c77b6a2021-07-25 18:07:00 +0200248 break;
249 sav = sav->sav_next;
250 }
251 return sav;
252 }
253
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200254 // Go over the variables with this name and find one that was visible
255 // from the function.
256 ufunc = cctx->ctx_ufunc;
257 while (sav != NULL)
258 {
259 int idx;
260
261 // Go over the blocks that this function was defined in. If the
262 // variable block ID matches it was visible to the function.
263 for (idx = 0; idx < ufunc->uf_block_depth; ++idx)
264 if (ufunc->uf_block_ids[idx] == sav->sav_block_id)
265 return sav;
266 sav = sav->sav_next;
267 }
268
Bram Moolenaar58493cf2022-01-06 12:23:30 +0000269 // Not found, variable was not visible.
270 return NULL;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200271}
272
273/*
Bram Moolenaar766ae5b2022-09-14 00:30:51 +0100274 * If "name" can be found in the current script set it's "block_id".
275 */
276 void
277update_script_var_block_id(char_u *name, int block_id)
278{
279 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
280 hashitem_T *hi;
281 sallvar_T *sav;
282
283 hi = hash_find(&si->sn_all_vars.dv_hashtab, name);
284 if (HASHITEM_EMPTY(hi))
285 return;
286 sav = HI2SAV(hi);
287 sav->sav_block_id = block_id;
288}
289
290/*
Bram Moolenaar8e7d6222020-12-18 19:49:56 +0100291 * Return TRUE if the script context is Vim9 script.
Bram Moolenaar84367732020-08-23 15:21:55 +0200292 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +0000293 int
Yegappan Lakshmanana23a11b2023-02-21 14:27:41 +0000294script_is_vim9(void)
Bram Moolenaar84367732020-08-23 15:21:55 +0200295{
296 return SCRIPT_ITEM(current_sctx.sc_sid)->sn_version == SCRIPT_VERSION_VIM9;
297}
298
299/*
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200300 * Lookup a variable (without s: prefix) in the current script.
Bram Moolenaar7a3b8022022-02-14 19:53:03 +0000301 * "cctx" is NULL at the script level, "cstack" is NULL in a function.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100302 * Returns OK or FAIL.
303 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +0000304 int
Bram Moolenaardce24412022-02-08 20:35:30 +0000305script_var_exists(char_u *name, size_t len, cctx_T *cctx, cstack_T *cstack)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100306{
Bram Moolenaar9c4f5522020-09-25 21:47:28 +0200307 if (current_sctx.sc_sid <= 0)
308 return FAIL;
Bram Moolenaar15e5e532021-04-07 21:21:13 +0200309 if (script_is_vim9())
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200310 {
311 // Check script variables that were visible where the function was
312 // defined.
Bram Moolenaardce24412022-02-08 20:35:30 +0000313 if (find_script_var(name, len, cctx, cstack) != NULL)
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200314 return OK;
315 }
316 else
317 {
318 hashtab_T *ht = &SCRIPT_VARS(current_sctx.sc_sid);
319 dictitem_T *di;
320 int cc;
321
322 // Check script variables that are currently visible
323 cc = name[len];
324 name[len] = NUL;
325 di = find_var_in_ht(ht, 0, name, TRUE);
326 name[len] = cc;
327 if (di != NULL)
328 return OK;
329 }
330
331 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100332}
333
Bram Moolenaar5269bd22020-03-09 19:25:27 +0100334/*
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +0200335 * Returns the index of a class method or class variable with name "name"
336 * accessible in the currently compiled function.
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +0200337 * If "cl_ret" is not NULL set it to the class.
338 * Otherwise return -1.
339 */
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +0200340 static int
341cctx_class_midx(
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +0200342 cctx_T *cctx,
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +0200343 int is_method,
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +0200344 char_u *name,
345 size_t len,
346 class_T **cl_ret)
347{
348 if (cctx == NULL || cctx->ctx_ufunc == NULL
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +0200349 || cctx->ctx_ufunc->uf_class == NULL
350 || cctx->ctx_ufunc->uf_defclass == NULL)
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +0200351 return -1;
352
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +0200353 // Search for the class method or variable in the class where the calling
354 // function is defined.
355 class_T *cl = cctx->ctx_ufunc->uf_defclass;
356 int m_idx = is_method ? class_method_idx(cl, name, len)
357 : class_member_idx(cl, name, len);
358 if (m_idx < 0)
359 {
360 cl = cl->class_extends;
361 while (cl != NULL)
362 {
363 m_idx = is_method ? class_method_idx(cl, name, len)
364 : class_member_idx(cl, name, len);
365 if (m_idx >= 0)
366 break;
367 cl = cl->class_extends;
368 }
369 }
370
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +0200371 if (m_idx >= 0)
372 {
373 if (cl_ret != NULL)
374 *cl_ret = cl;
375 }
376
377 return m_idx;
378}
379
380/*
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +0200381 * Returns the index of a class method with name "name" accessible in the
382 * currently compiled function. Returns -1 if not found. The class where the
383 * method is defined is returned in "cl_ret".
384 */
385 int
386cctx_class_method_idx(
387 cctx_T *cctx,
388 char_u *name,
389 size_t len,
390 class_T **cl_ret)
391{
392 return cctx_class_midx(cctx, TRUE, name, len, cl_ret);
393}
394
395/*
396 * Returns the index of a class variable with name "name" accessible in the
397 * currently compiled function. Returns -1 if not found. The class where the
398 * variable is defined is returned in "cl_ret".
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +0200399 */
400 int
401cctx_class_member_idx(
402 cctx_T *cctx,
403 char_u *name,
404 size_t len,
405 class_T **cl_ret)
406{
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +0200407 return cctx_class_midx(cctx, FALSE, name, len, cl_ret);
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +0200408}
409
410/*
Bram Moolenaare0890d62021-02-17 14:52:14 +0100411 * Return TRUE if "name" is a local variable, argument, script variable or
Bram Moolenaarb1e32ac2023-02-21 12:38:51 +0000412 * imported. Also if "name" is "this" and in a class method.
Bram Moolenaare0890d62021-02-17 14:52:14 +0100413 */
414 static int
415variable_exists(char_u *name, size_t len, cctx_T *cctx)
416{
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100417 return (cctx != NULL
418 && (lookup_local(name, len, NULL, cctx) == OK
Bram Moolenaar00b28d62022-12-08 15:32:33 +0000419 || arg_exists(name, len, NULL, NULL, NULL, cctx) == OK
420 || (len == 4
421 && cctx->ctx_ufunc != NULL
Bram Moolenaar574950d2023-01-03 19:08:50 +0000422 && (cctx->ctx_ufunc->uf_flags & (FC_OBJECT|FC_NEW))
Bram Moolenaar00b28d62022-12-08 15:32:33 +0000423 && STRNCMP(name, "this", 4) == 0)))
Bram Moolenaardce24412022-02-08 20:35:30 +0000424 || script_var_exists(name, len, cctx, NULL) == OK
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +0200425 || cctx_class_member_idx(cctx, name, len, NULL) >= 0
Bram Moolenaar4b1d9632022-02-13 21:51:08 +0000426 || find_imported(name, len, FALSE) != NULL;
Bram Moolenaare0890d62021-02-17 14:52:14 +0100427}
428
429/*
Bram Moolenaar6914e872021-03-06 21:01:09 +0100430 * Return TRUE if "name" is a local variable, argument, script variable,
Bram Moolenaar97f8c102022-04-02 19:43:57 +0100431 * imported or function. Or commands are being skipped, a declaration may have
432 * been skipped then.
Bram Moolenaar6914e872021-03-06 21:01:09 +0100433 */
434 static int
Bram Moolenaar77b10ff2021-03-14 13:21:35 +0100435item_exists(char_u *name, size_t len, int cmd UNUSED, cctx_T *cctx)
Bram Moolenaar6914e872021-03-06 21:01:09 +0100436{
Bram Moolenaar0631bb42022-02-13 21:20:21 +0000437 return variable_exists(name, len, cctx);
Bram Moolenaar6914e872021-03-06 21:01:09 +0100438}
439
440/*
Bram Moolenaar5269bd22020-03-09 19:25:27 +0100441 * Check if "p[len]" is already defined, either in script "import_sid" or in
Bram Moolenaar7a3b8022022-02-14 19:53:03 +0000442 * compilation context "cctx".
443 * "cctx" is NULL at the script level, "cstack" is NULL in a function.
Bram Moolenaar0f769812020-09-12 18:32:34 +0200444 * Does not check the global namespace.
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100445 * If "is_arg" is TRUE the error message is for an argument name.
Bram Moolenaar5269bd22020-03-09 19:25:27 +0100446 * Return FAIL and give an error if it defined.
447 */
448 int
Bram Moolenaardce24412022-02-08 20:35:30 +0000449check_defined(
450 char_u *p,
451 size_t len,
452 cctx_T *cctx,
453 cstack_T *cstack,
454 int is_arg)
Bram Moolenaar5269bd22020-03-09 19:25:27 +0100455{
Bram Moolenaar0f769812020-09-12 18:32:34 +0200456 int c = p[len];
457 ufunc_T *ufunc = NULL;
Bram Moolenaarad486a02020-08-01 23:22:18 +0200458
Bram Moolenaarda479c72021-04-10 21:01:38 +0200459 // underscore argument is OK
460 if (len == 1 && *p == '_')
461 return OK;
462
Bram Moolenaardce24412022-02-08 20:35:30 +0000463 if (script_var_exists(p, len, cctx, cstack) == OK)
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100464 {
465 if (is_arg)
466 semsg(_(e_argument_already_declared_in_script_str), p);
467 else
468 semsg(_(e_variable_already_declared_in_script_str), p);
469 return FAIL;
470 }
471
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +0200472 if (cctx_class_member_idx(cctx, p, len, NULL) >= 0)
Bram Moolenaar6acf7572023-01-01 19:53:30 +0000473 {
474 if (is_arg)
475 semsg(_(e_argument_already_declared_in_class_str), p);
476 else
477 semsg(_(e_variable_already_declared_in_class_str), p);
478 return FAIL;
479 }
480
Bram Moolenaarad486a02020-08-01 23:22:18 +0200481 p[len] = NUL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100482 if ((cctx != NULL
Bram Moolenaar709664c2020-12-12 14:33:41 +0100483 && (lookup_local(p, len, NULL, cctx) == OK
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200484 || arg_exists(p, len, NULL, NULL, NULL, cctx) == OK))
Bram Moolenaar4b1d9632022-02-13 21:51:08 +0000485 || find_imported(p, len, FALSE) != NULL
Bram Moolenaaracc4b562022-01-24 13:54:45 +0000486 || (ufunc = find_func_even_dead(p, 0)) != NULL)
Bram Moolenaar5269bd22020-03-09 19:25:27 +0100487 {
Bram Moolenaar0f769812020-09-12 18:32:34 +0200488 // A local or script-local function can shadow a global function.
Bram Moolenaar577dc932021-06-27 15:35:40 +0200489 if (ufunc == NULL || ((ufunc->uf_flags & FC_DEAD) == 0
490 && (!func_is_global(ufunc)
491 || (p[0] == 'g' && p[1] == ':'))))
Bram Moolenaar0f769812020-09-12 18:32:34 +0200492 {
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100493 if (is_arg)
494 semsg(_(e_argument_name_shadows_existing_variable_str), p);
495 else
496 semsg(_(e_name_already_defined_str), p);
Bram Moolenaar0f769812020-09-12 18:32:34 +0200497 p[len] = c;
Bram Moolenaar0f769812020-09-12 18:32:34 +0200498 return FAIL;
499 }
Bram Moolenaar5269bd22020-03-09 19:25:27 +0100500 }
Bram Moolenaarad486a02020-08-01 23:22:18 +0200501 p[len] = c;
Bram Moolenaar5269bd22020-03-09 19:25:27 +0100502 return OK;
503}
504
Bram Moolenaar65b95452020-07-19 14:03:09 +0200505
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100506/*
Bram Moolenaar334a8b42020-10-19 16:07:42 +0200507 * Return TRUE if "actual" could be "expected" and a runtime typecheck is to be
508 * used. Return FALSE if the types will never match.
509 */
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +0200510 static int
Bram Moolenaar334a8b42020-10-19 16:07:42 +0200511use_typecheck(type_T *actual, type_T *expected)
512{
513 if (actual->tt_type == VAR_ANY
514 || actual->tt_type == VAR_UNKNOWN
515 || (actual->tt_type == VAR_FUNC
516 && (expected->tt_type == VAR_FUNC
517 || expected->tt_type == VAR_PARTIAL)
Bram Moolenaarfa46ead2021-12-22 13:18:39 +0000518 && (actual->tt_member == &t_any
519 || actual->tt_member == &t_unknown
520 || actual->tt_argcount < 0)
521 && (actual->tt_member == &t_unknown ||
522 (actual->tt_member == &t_void)
Bram Moolenaar328eac22021-01-07 19:23:08 +0100523 == (expected->tt_member == &t_void))))
Bram Moolenaar334a8b42020-10-19 16:07:42 +0200524 return TRUE;
LemonBoy50d48542024-07-04 17:03:17 +0200525 if (actual->tt_type == VAR_OBJECT && expected->tt_type == VAR_OBJECT)
526 return TRUE;
Bram Moolenaar334a8b42020-10-19 16:07:42 +0200527 if ((actual->tt_type == VAR_LIST || actual->tt_type == VAR_DICT)
528 && actual->tt_type == expected->tt_type)
529 // This takes care of a nested list or dict.
530 return use_typecheck(actual->tt_member, expected->tt_member);
531 return FALSE;
532}
533
534/*
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +0200535 * Check that
Bram Moolenaar5e654232020-09-16 15:22:00 +0200536 * - "actual" matches "expected" type or
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +0200537 * - "actual" is a type that can be "expected" type: add a runtime check; or
538 * - return FAIL.
Bram Moolenaar334a8b42020-10-19 16:07:42 +0200539 * If "actual_is_const" is TRUE then the type won't change at runtime, do not
540 * generate a TYPECHECK.
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +0200541 */
Bram Moolenaara1c51952022-02-02 16:20:26 +0000542 int
Bram Moolenaar4270d8b2021-08-07 16:30:42 +0200543need_type_where(
544 type_T *actual,
545 type_T *expected,
Bram Moolenaarc6951a72022-12-29 20:56:24 +0000546 int number_ok, // expect VAR_FLOAT but VAR_NUMBER is OK
Bram Moolenaar4270d8b2021-08-07 16:30:42 +0200547 int offset,
548 where_T where,
549 cctx_T *cctx,
550 int silent,
551 int actual_is_const)
552{
Bram Moolenaar44a89772021-12-18 12:31:33 +0000553 int ret;
554
Ernie Raele75fde62023-12-21 17:18:54 +0100555 if (expected->tt_type != VAR_CLASS && expected->tt_type != VAR_TYPEALIAS)
556 {
557 if (check_type_is_value(actual) == FAIL)
558 return FAIL;
559 }
560
Bram Moolenaar4270d8b2021-08-07 16:30:42 +0200561 if (expected == &t_bool && actual != &t_bool
562 && (actual->tt_flags & TTFLAG_BOOL_OK))
563 {
564 // Using "0", "1" or the result of an expression with "&&" or "||" as a
565 // boolean is OK but requires a conversion.
566 generate_2BOOL(cctx, FALSE, offset);
567 return OK;
568 }
569
Bram Moolenaar44a89772021-12-18 12:31:33 +0000570 ret = check_type_maybe(expected, actual, FALSE, where);
571 if (ret == OK)
Bram Moolenaar4270d8b2021-08-07 16:30:42 +0200572 return OK;
573
Bram Moolenaar8acb9cc2022-03-08 13:18:55 +0000574 // If actual a constant a runtime check makes no sense. If it's
575 // null_function it is OK.
576 if (actual_is_const && ret == MAYBE && actual == &t_func_unknown)
577 return OK;
578
Bram Moolenaar4270d8b2021-08-07 16:30:42 +0200579 // If the actual type can be the expected type add a runtime check.
Bram Moolenaarfa46ead2021-12-22 13:18:39 +0000580 if (!actual_is_const && ret == MAYBE && use_typecheck(actual, expected))
Bram Moolenaar4270d8b2021-08-07 16:30:42 +0200581 {
Bram Moolenaarc6951a72022-12-29 20:56:24 +0000582 generate_TYPECHECK(cctx, expected, number_ok, offset,
LemonBoyc5d27442023-08-19 13:02:35 +0200583 where.wt_kind == WT_VARIABLE, where.wt_index);
Bram Moolenaar4270d8b2021-08-07 16:30:42 +0200584 return OK;
585 }
586
587 if (!silent)
588 type_mismatch_where(expected, actual, where);
589 return FAIL;
590}
591
Bram Moolenaar351ead02021-01-16 16:07:01 +0100592 int
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +0200593need_type(
594 type_T *actual,
595 type_T *expected,
Bram Moolenaarc6951a72022-12-29 20:56:24 +0000596 int number_ok, // when expected is float number is also OK
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +0200597 int offset,
Bram Moolenaar351ead02021-01-16 16:07:01 +0100598 int arg_idx,
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +0200599 cctx_T *cctx,
Bram Moolenaar334a8b42020-10-19 16:07:42 +0200600 int silent,
601 int actual_is_const)
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +0200602{
Bram Moolenaar7a3fe3e2021-07-22 14:58:47 +0200603 where_T where = WHERE_INIT;
Bram Moolenaarf785aa12021-02-11 21:19:34 +0100604
LemonBoyc5d27442023-08-19 13:02:35 +0200605 if (arg_idx > 0)
606 {
607 where.wt_index = arg_idx;
608 where.wt_kind = WT_ARGUMENT;
609 }
Bram Moolenaarc6951a72022-12-29 20:56:24 +0000610 return need_type_where(actual, expected, number_ok, offset, where,
Bram Moolenaar4270d8b2021-08-07 16:30:42 +0200611 cctx, silent, actual_is_const);
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +0200612}
613
614/*
Bram Moolenaarfa103972022-09-29 19:14:42 +0100615 * Set type of variable "lvar" to "type". If the variable is a constant then
616 * the type gets TTFLAG_CONST.
617 */
618 static void
619set_var_type(lvar_T *lvar, type_T *type_arg, cctx_T *cctx)
620{
621 type_T *type = type_arg;
622
Bram Moolenaar6586a012022-09-30 11:04:50 +0100623 if (lvar->lv_const == ASSIGN_CONST && (type->tt_flags & TTFLAG_CONST) == 0)
Bram Moolenaarfa103972022-09-29 19:14:42 +0100624 {
625 if (type->tt_flags & TTFLAG_STATIC)
626 // entry in static_types[] is followed by const type
627 type = type + 1;
628 else
629 {
630 type = copy_type(type, cctx->ctx_type_list);
631 type->tt_flags |= TTFLAG_CONST;
632 }
633 }
634 lvar->lv_type = type;
635}
636
637/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100638 * Reserve space for a local variable.
Bram Moolenaar6586a012022-09-30 11:04:50 +0100639 * "assign" can be ASSIGN_VAR for :var, ASSIGN_CONST for :const and
640 * ASSIGN_FINAL for :final.
Bram Moolenaarb84a3812020-05-01 15:44:29 +0200641 * Return the variable or NULL if it failed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100642 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +0000643 lvar_T *
Bram Moolenaare8211a32020-10-09 22:04:29 +0200644reserve_local(
645 cctx_T *cctx,
646 char_u *name,
647 size_t len,
Bram Moolenaar6586a012022-09-30 11:04:50 +0100648 int assign,
Bram Moolenaare8211a32020-10-09 22:04:29 +0200649 type_T *type)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100650{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100651 lvar_T *lvar;
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +0200652 dfunc_T *dfunc;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100653
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200654 if (arg_exists(name, len, NULL, NULL, NULL, cctx) == OK)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100655 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200656 emsg_namelen(_(e_str_is_used_as_argument), name, (int)len);
Bram Moolenaarb84a3812020-05-01 15:44:29 +0200657 return NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100658 }
659
Bram Moolenaar35578162021-08-02 19:10:38 +0200660 if (GA_GROW_FAILS(&cctx->ctx_locals, 1))
Bram Moolenaarb84a3812020-05-01 15:44:29 +0200661 return NULL;
662 lvar = ((lvar_T *)cctx->ctx_locals.ga_data) + cctx->ctx_locals.ga_len++;
Bram Moolenaare8211a32020-10-09 22:04:29 +0200663 CLEAR_POINTER(lvar);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100664
Bram Moolenaarb84a3812020-05-01 15:44:29 +0200665 // Every local variable uses the next entry on the stack. We could re-use
666 // the last ones when leaving a scope, but then variables used in a closure
667 // might get overwritten. To keep things simple do not re-use stack
668 // entries. This is less efficient, but memory is cheap these days.
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +0200669 dfunc = ((dfunc_T *)def_functions.ga_data) + cctx->ctx_ufunc->uf_dfunc_idx;
670 lvar->lv_idx = dfunc->df_var_names.ga_len;
Bram Moolenaarb84a3812020-05-01 15:44:29 +0200671
Bram Moolenaar71ccd032020-06-12 22:59:11 +0200672 lvar->lv_name = vim_strnsave(name, len == 0 ? STRLEN(name) : len);
Bram Moolenaar6586a012022-09-30 11:04:50 +0100673 lvar->lv_const = assign;
Bram Moolenaarfa103972022-09-29 19:14:42 +0100674 if (type == &t_unknown || type == &t_any)
675 // type not known yet, may be inferred from RHS
676 lvar->lv_type = type;
677 else
678 // may use TTFLAG_CONST
679 set_var_type(lvar, type, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100680
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +0200681 // Remember the name for debugging.
Bram Moolenaar35578162021-08-02 19:10:38 +0200682 if (GA_GROW_FAILS(&dfunc->df_var_names, 1))
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +0200683 return NULL;
684 ((char_u **)dfunc->df_var_names.ga_data)[lvar->lv_idx] =
685 vim_strsave(lvar->lv_name);
686 ++dfunc->df_var_names.ga_len;
687
Bram Moolenaarb84a3812020-05-01 15:44:29 +0200688 return lvar;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100689}
690
691/*
Bram Moolenaar08251752021-01-11 21:20:18 +0100692 * If "check_writable" is ASSIGN_CONST give an error if the variable was
693 * defined with :final or :const, if "check_writable" is ASSIGN_FINAL give an
694 * error if the variable was defined with :const.
695 */
696 static int
697check_item_writable(svar_T *sv, int check_writable, char_u *name)
698{
699 if ((check_writable == ASSIGN_CONST && sv->sv_const != 0)
700 || (check_writable == ASSIGN_FINAL
701 && sv->sv_const == ASSIGN_CONST))
702 {
Bram Moolenaard8e44472021-07-21 22:20:33 +0200703 semsg(_(e_cannot_change_readonly_variable_str), name);
Bram Moolenaar08251752021-01-11 21:20:18 +0100704 return FAIL;
705 }
706 return OK;
707}
708
709/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100710 * Find "name" in script-local items of script "sid".
Bram Moolenaar08251752021-01-11 21:20:18 +0100711 * Pass "check_writable" to check_item_writable().
Bram Moolenaar7a3b8022022-02-14 19:53:03 +0000712 * "cctx" is NULL at the script level, "cstack" is NULL in a function.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100713 * Returns the index in "sn_var_vals" if found.
714 * If found but not in "sn_var_vals" returns -1.
Bram Moolenaar08251752021-01-11 21:20:18 +0100715 * If not found or the variable is not writable returns -2.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100716 */
717 int
Bram Moolenaarb6a138e2022-02-08 21:17:22 +0000718get_script_item_idx(
719 int sid,
720 char_u *name,
721 int check_writable,
722 cctx_T *cctx,
723 cstack_T *cstack)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100724{
725 hashtab_T *ht;
726 dictitem_T *di;
Bram Moolenaar21b9e972020-01-26 19:26:46 +0100727 scriptitem_T *si = SCRIPT_ITEM(sid);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200728 svar_T *sv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100729 int idx;
730
Bram Moolenaare3d46852020-08-29 13:39:17 +0200731 if (!SCRIPT_ID_VALID(sid))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100732 return -1;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200733 if (sid == current_sctx.sc_sid)
734 {
Bram Moolenaarb6a138e2022-02-08 21:17:22 +0000735 sallvar_T *sav = find_script_var(name, 0, cctx, cstack);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200736
737 if (sav == NULL)
738 return -2;
739 idx = sav->sav_var_vals_idx;
740 sv = ((svar_T *)si->sn_var_vals.ga_data) + idx;
Bram Moolenaar08251752021-01-11 21:20:18 +0100741 if (check_item_writable(sv, check_writable, name) == FAIL)
742 return -2;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200743 return idx;
744 }
745
746 // First look the name up in the hashtable.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100747 ht = &SCRIPT_VARS(sid);
748 di = find_var_in_ht(ht, 0, name, TRUE);
749 if (di == NULL)
Bram Moolenaar577bd852022-01-10 18:42:52 +0000750 {
751 if (si->sn_autoload_prefix != NULL)
752 {
753 hashitem_T *hi;
754
755 // A variable exported from an autoload script is in the global
756 // variables, we can find it in the all_vars table.
757 hi = hash_find(&si->sn_all_vars.dv_hashtab, name);
758 if (!HASHITEM_EMPTY(hi))
759 return HI2SAV(hi)->sav_var_vals_idx;
760 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100761 return -2;
Bram Moolenaar577bd852022-01-10 18:42:52 +0000762 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100763
764 // Now find the svar_T index in sn_var_vals.
765 for (idx = 0; idx < si->sn_var_vals.ga_len; ++idx)
766 {
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200767 sv = ((svar_T *)si->sn_var_vals.ga_data) + idx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100768 if (sv->sv_tv == &di->di_tv)
769 {
Bram Moolenaar08251752021-01-11 21:20:18 +0100770 if (check_item_writable(sv, check_writable, name) == FAIL)
771 return -2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100772 return idx;
773 }
774 }
775 return -1;
776}
777
Yegappan Lakshmanan782b43d2022-01-08 18:43:40 +0000778 static imported_T *
779find_imported_in_script(char_u *name, size_t len, int sid)
780{
781 scriptitem_T *si;
782 int idx;
783
784 if (!SCRIPT_ID_VALID(sid))
785 return NULL;
786 si = SCRIPT_ITEM(sid);
787 for (idx = 0; idx < si->sn_imports.ga_len; ++idx)
788 {
789 imported_T *import = ((imported_T *)si->sn_imports.ga_data) + idx;
790
791 if (len == 0 ? STRCMP(name, import->imp_name) == 0
792 : STRLEN(import->imp_name) == len
793 && STRNCMP(name, import->imp_name, len) == 0)
794 return import;
795 }
796 return NULL;
797}
798
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100799/*
Bram Moolenaar4b1d9632022-02-13 21:51:08 +0000800 * Find "name" in imported items of the current script.
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +0100801 * If "len" is 0 use any length that works.
Bram Moolenaardc4451d2022-01-09 21:36:37 +0000802 * If "load" is TRUE and the script was not loaded yet, load it now.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100803 */
804 imported_T *
Bram Moolenaar4b1d9632022-02-13 21:51:08 +0000805find_imported(char_u *name, size_t len, int load)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100806{
Bram Moolenaare3d46852020-08-29 13:39:17 +0200807 if (!SCRIPT_ID_VALID(current_sctx.sc_sid))
Bram Moolenaar8e6cbb72020-07-01 14:38:12 +0200808 return NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100809
Bram Moolenaarb775e722022-11-22 18:12:44 +0000810 // Skip over "s:" before "s:something" to find the import name.
811 int off = name[0] == 's' && name[1] == ':' ? 2 : 0;
812
813 imported_T *ret = find_imported_in_script(name + off, len - off,
814 current_sctx.sc_sid);
Bram Moolenaarb697dc22022-01-22 11:27:29 +0000815 if (ret != NULL && load && (ret->imp_flags & IMP_FLAGS_AUTOLOAD))
Bram Moolenaardc4451d2022-01-09 21:36:37 +0000816 {
Bram Moolenaar753885b2022-08-24 16:30:36 +0100817 scid_T actual_sid = 0;
Bram Moolenaar6809ff92022-07-26 15:10:56 +0100818 int save_emsg_off = emsg_off;
819
820 // "emsg_off" will be set when evaluating an expression silently, but
821 // we do want to know about errors in a script. Also because it then
822 // aborts when an error is encountered.
823 emsg_off = FALSE;
Bram Moolenaar17d36cb2022-01-12 11:46:40 +0000824
Bram Moolenaardc4451d2022-01-09 21:36:37 +0000825 // script found before but not loaded yet
Bram Moolenaarb697dc22022-01-22 11:27:29 +0000826 ret->imp_flags &= ~IMP_FLAGS_AUTOLOAD;
Bram Moolenaardc4451d2022-01-09 21:36:37 +0000827 (void)do_source(SCRIPT_ITEM(ret->imp_sid)->sn_name, FALSE,
Bram Moolenaar753885b2022-08-24 16:30:36 +0100828 DOSO_NONE, &actual_sid);
829 // If the script is a symlink it may be sourced with another name, may
830 // need to adjust the script ID for that.
831 if (actual_sid != 0)
832 ret->imp_sid = actual_sid;
Bram Moolenaar6809ff92022-07-26 15:10:56 +0100833
834 emsg_off = save_emsg_off;
Bram Moolenaardc4451d2022-01-09 21:36:37 +0000835 }
836 return ret;
Bram Moolenaarefa94442020-08-08 22:16:00 +0200837}
838
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100839/*
Hirohito Higashibf7c88d2025-02-13 21:04:07 +0100840 * Find "name" in imported items of extended base class of the class to which
841 * the context :def function belongs.
842 */
843 imported_T *
844find_imported_from_extends(cctx_T *cctx, char_u *name, size_t len, int load)
845{
Hirohito Higashibf7c88d2025-02-13 21:04:07 +0100846 if (cctx == NULL || cctx->ctx_ufunc == NULL
847 || cctx->ctx_ufunc->uf_class == NULL)
848 return NULL;
849
Yegappan Lakshmananb5f463c2025-02-16 16:25:24 +0100850 class_T *cl_extends = cctx->ctx_ufunc->uf_class->class_extends;
851 if (cl_extends == NULL
852 || cl_extends->class_class_function_count_child <= 0)
Hirohito Higashibf7c88d2025-02-13 21:04:07 +0100853 return NULL;
Hirohito Higashibf7c88d2025-02-13 21:04:07 +0100854
Yegappan Lakshmananb5f463c2025-02-16 16:25:24 +0100855 sctx_T current_sctx_save = current_sctx;
856 current_sctx = cl_extends->class_class_functions[0]->uf_script_ctx;
857 imported_T *ret = find_imported(name, len, load);
858 current_sctx = current_sctx_save;
Hirohito Higashibf7c88d2025-02-13 21:04:07 +0100859
Yegappan Lakshmananb5f463c2025-02-16 16:25:24 +0100860 return ret;
Hirohito Higashibf7c88d2025-02-13 21:04:07 +0100861}
862
863/*
Bram Moolenaardc7c3662021-12-20 15:04:29 +0000864 * Called when checking for a following operator at "arg". When the rest of
865 * the line is empty or only a comment, peek the next line. If there is a next
866 * line return a pointer to it and set "nextp".
867 * Otherwise skip over white space.
868 */
869 char_u *
870may_peek_next_line(cctx_T *cctx, char_u *arg, char_u **nextp)
871{
872 char_u *p = skipwhite(arg);
873
874 *nextp = NULL;
875 if (*p == NUL || (VIM_ISWHITE(*arg) && vim9_comment_start(p)))
876 {
877 *nextp = peek_next_line_from_context(cctx);
878 if (*nextp != NULL)
879 return *nextp;
880 }
881 return p;
882}
883
884/*
Bram Moolenaar23c55272020-06-21 16:58:13 +0200885 * Return a pointer to the next line that isn't empty or only contains a
886 * comment. Skips over white space.
887 * Returns NULL if there is none.
888 */
Bram Moolenaar7a4b8982020-07-08 17:36:21 +0200889 char_u *
890peek_next_line_from_context(cctx_T *cctx)
Bram Moolenaar23c55272020-06-21 16:58:13 +0200891{
892 int lnum = cctx->ctx_lnum;
893
894 while (++lnum < cctx->ctx_ufunc->uf_lines.ga_len)
895 {
896 char_u *line = ((char_u **)cctx->ctx_ufunc->uf_lines.ga_data)[lnum];
Bram Moolenaaracd4c5e2020-06-22 19:39:03 +0200897 char_u *p;
Bram Moolenaar23c55272020-06-21 16:58:13 +0200898
Bram Moolenaarba60cc42020-08-12 19:15:33 +0200899 // ignore NULLs inserted for continuation lines
900 if (line != NULL)
901 {
902 p = skipwhite(line);
Bram Moolenaar4b3e1962021-03-18 21:37:55 +0100903 if (vim9_bad_comment(p))
904 return NULL;
Bram Moolenaarba60cc42020-08-12 19:15:33 +0200905 if (*p != NUL && !vim9_comment_start(p))
906 return p;
907 }
Bram Moolenaar23c55272020-06-21 16:58:13 +0200908 }
909 return NULL;
910}
911
912/*
Bram Moolenaare6085c52020-04-12 20:19:16 +0200913 * Get the next line of the function from "cctx".
Bram Moolenaar23c55272020-06-21 16:58:13 +0200914 * Skips over empty lines. Skips over comment lines if "skip_comment" is TRUE.
Bram Moolenaare6085c52020-04-12 20:19:16 +0200915 * Returns NULL when at the end.
916 */
Bram Moolenaar7a4b8982020-07-08 17:36:21 +0200917 char_u *
Bram Moolenaar23c55272020-06-21 16:58:13 +0200918next_line_from_context(cctx_T *cctx, int skip_comment)
Bram Moolenaare6085c52020-04-12 20:19:16 +0200919{
Bram Moolenaar7a092242020-04-16 22:10:49 +0200920 char_u *line;
Bram Moolenaare6085c52020-04-12 20:19:16 +0200921
922 do
923 {
924 ++cctx->ctx_lnum;
925 if (cctx->ctx_lnum >= cctx->ctx_ufunc->uf_lines.ga_len)
Bram Moolenaar7a092242020-04-16 22:10:49 +0200926 {
927 line = NULL;
Bram Moolenaare6085c52020-04-12 20:19:16 +0200928 break;
Bram Moolenaar7a092242020-04-16 22:10:49 +0200929 }
Bram Moolenaare6085c52020-04-12 20:19:16 +0200930 line = ((char_u **)cctx->ctx_ufunc->uf_lines.ga_data)[cctx->ctx_lnum];
Bram Moolenaar7a092242020-04-16 22:10:49 +0200931 cctx->ctx_line_start = line;
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200932 SOURCING_LNUM = cctx->ctx_lnum + 1;
Bram Moolenaar23c55272020-06-21 16:58:13 +0200933 } while (line == NULL || *skipwhite(line) == NUL
Bram Moolenaar2dd0a2c2020-08-08 15:10:27 +0200934 || (skip_comment && vim9_comment_start(skipwhite(line))));
Bram Moolenaare6085c52020-04-12 20:19:16 +0200935 return line;
936}
937
938/*
Bram Moolenaar5afd0812021-01-03 18:33:13 +0100939 * Skip over white space at "whitep" and assign to "*arg".
Bram Moolenaar9c7e6dd2020-04-12 20:55:20 +0200940 * If "*arg" is at the end of the line, advance to the next line.
Bram Moolenaar2c330432020-04-13 14:41:35 +0200941 * Also when "whitep" points to white space and "*arg" is on a "#".
Bram Moolenaar9c7e6dd2020-04-12 20:55:20 +0200942 * Return FAIL if beyond the last line, "*arg" is unmodified then.
943 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +0000944 int
Bram Moolenaar2c330432020-04-13 14:41:35 +0200945may_get_next_line(char_u *whitep, char_u **arg, cctx_T *cctx)
Bram Moolenaar9c7e6dd2020-04-12 20:55:20 +0200946{
Bram Moolenaar5afd0812021-01-03 18:33:13 +0100947 *arg = skipwhite(whitep);
Bram Moolenaar4b3e1962021-03-18 21:37:55 +0100948 if (vim9_bad_comment(*arg))
949 return FAIL;
Bram Moolenaarf5be8cd2020-07-17 20:36:00 +0200950 if (**arg == NUL || (VIM_ISWHITE(*whitep) && vim9_comment_start(*arg)))
Bram Moolenaar9c7e6dd2020-04-12 20:55:20 +0200951 {
Bram Moolenaar23c55272020-06-21 16:58:13 +0200952 char_u *next = next_line_from_context(cctx, TRUE);
Bram Moolenaar9c7e6dd2020-04-12 20:55:20 +0200953
954 if (next == NULL)
955 return FAIL;
956 *arg = skipwhite(next);
957 }
958 return OK;
959}
960
Bram Moolenaara7eedf32020-07-10 21:50:41 +0200961/*
962 * Idem, and give an error when failed.
963 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +0000964 int
Bram Moolenaara7eedf32020-07-10 21:50:41 +0200965may_get_next_line_error(char_u *whitep, char_u **arg, cctx_T *cctx)
966{
967 if (may_get_next_line(whitep, arg, cctx) == FAIL)
968 {
Bram Moolenaar8ff16e02020-12-07 21:49:52 +0100969 SOURCING_LNUM = cctx->ctx_lnum + 1;
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200970 emsg(_(e_line_incomplete));
Bram Moolenaara7eedf32020-07-10 21:50:41 +0200971 return FAIL;
972 }
973 return OK;
974}
975
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100976/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200977 * Get a line from the compilation context, compatible with exarg_T getline().
978 * Return a pointer to the line in allocated memory.
979 * Return NULL for end-of-file or some error.
980 */
981 static char_u *
982exarg_getline(
983 int c UNUSED,
984 void *cookie,
985 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +0200986 getline_opt_T options UNUSED)
Bram Moolenaar04b12692020-05-04 23:24:44 +0200987{
988 cctx_T *cctx = (cctx_T *)cookie;
Bram Moolenaar66250c92020-08-20 15:02:42 +0200989 char_u *p;
Bram Moolenaar04b12692020-05-04 23:24:44 +0200990
Bram Moolenaar66250c92020-08-20 15:02:42 +0200991 for (;;)
Bram Moolenaar04b12692020-05-04 23:24:44 +0200992 {
Bram Moolenaar2914a202020-09-27 18:24:03 +0200993 if (cctx->ctx_lnum >= cctx->ctx_ufunc->uf_lines.ga_len - 1)
Bram Moolenaar66250c92020-08-20 15:02:42 +0200994 return NULL;
995 ++cctx->ctx_lnum;
996 p = ((char_u **)cctx->ctx_ufunc->uf_lines.ga_data)[cctx->ctx_lnum];
997 // Comment lines result in NULL pointers, skip them.
998 if (p != NULL)
999 return vim_strsave(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02001000 }
Bram Moolenaar04b12692020-05-04 23:24:44 +02001001}
1002
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001003 void
1004fill_exarg_from_cctx(exarg_T *eap, cctx_T *cctx)
1005{
Zoltan Arpadffy6fdb6282023-12-19 20:53:07 +01001006 eap->ea_getline = exarg_getline;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001007 eap->cookie = cctx;
Bram Moolenaar4f3321f2022-03-13 13:12:27 +00001008 eap->skip = cctx->ctx_skip == SKIP_YES;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001009}
1010
Bram Moolenaar04b12692020-05-04 23:24:44 +02001011/*
Bram Moolenaardc7c3662021-12-20 15:04:29 +00001012 * Return TRUE if "ufunc" should be compiled, taking into account whether
1013 * "profile" indicates profiling is to be done.
1014 */
1015 int
1016func_needs_compiling(ufunc_T *ufunc, compiletype_T compile_type)
1017{
1018 switch (ufunc->uf_def_status)
1019 {
1020 case UF_TO_BE_COMPILED:
1021 return TRUE;
1022
1023 case UF_COMPILED:
1024 {
1025 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
1026 + ufunc->uf_dfunc_idx;
1027
1028 switch (compile_type)
1029 {
1030 case CT_PROFILE:
1031#ifdef FEAT_PROFILE
1032 return dfunc->df_instr_prof == NULL;
1033#endif
1034 case CT_NONE:
1035 return dfunc->df_instr == NULL;
1036 case CT_DEBUG:
1037 return dfunc->df_instr_debug == NULL;
1038 }
1039 }
1040
1041 case UF_NOT_COMPILED:
1042 case UF_COMPILE_ERROR:
1043 case UF_COMPILING:
1044 break;
1045 }
1046 return FALSE;
1047}
1048
1049/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02001050 * Compile a nested :def command.
1051 */
1052 static char_u *
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00001053compile_nested_function(exarg_T *eap, cctx_T *cctx, garray_T *lines_to_free)
Bram Moolenaar04b12692020-05-04 23:24:44 +02001054{
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001055 int is_global = *eap->arg == 'g' && eap->arg[1] == ':';
Bram Moolenaar04b12692020-05-04 23:24:44 +02001056 char_u *name_start = eap->arg;
Bram Moolenaarbcbf4132020-08-01 22:35:13 +02001057 char_u *name_end = to_name_end(eap->arg, TRUE);
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001058 int off;
1059 char_u *func_name;
Bram Moolenaareef21022020-08-01 22:16:43 +02001060 char_u *lambda_name;
John Marriottb32800f2025-02-01 15:25:34 +01001061 size_t lambda_namelen;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001062 ufunc_T *ufunc;
Bram Moolenaar58a52f22020-12-22 18:56:55 +01001063 int r = FAIL;
Bram Moolenaarffcfddc2021-07-11 20:22:30 +02001064 compiletype_T compile_type;
Yegappan Lakshmanana76fbe62023-09-27 18:51:43 +02001065 int funcref_isn_idx = -1;
Bram Moolenaar1889f492022-08-16 19:34:44 +01001066 lvar_T *lvar = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001067
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +02001068 if (eap->forceit)
Bram Moolenaar8b848ca2020-09-10 22:28:01 +02001069 {
1070 emsg(_(e_cannot_use_bang_with_nested_def));
1071 return NULL;
1072 }
1073
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01001074 if (*name_start == '/')
1075 {
1076 name_end = skip_regexp(name_start + 1, '/', TRUE);
1077 if (*name_end == '/')
1078 ++name_end;
Bram Moolenaar63b91732021-08-05 20:40:03 +02001079 set_nextcmd(eap, name_end);
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01001080 }
1081 if (name_end == name_start || *skipwhite(name_end) != '(')
1082 {
1083 if (!ends_excmd2(name_start, name_end))
1084 {
Bram Moolenaardea5ab02022-02-23 22:12:02 +00001085 if (*skipwhite(name_end) == '.')
1086 semsg(_(e_cannot_define_dict_func_in_vim9_script_str),
1087 eap->cmd);
1088 else
1089 semsg(_(e_invalid_command_str), eap->cmd);
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01001090 return NULL;
1091 }
1092
1093 // "def" or "def Name": list functions
1094 if (generate_DEF(cctx, name_start, name_end - name_start) == FAIL)
1095 return NULL;
1096 return eap->nextcmd == NULL ? (char_u *)"" : eap->nextcmd;
1097 }
1098
Bram Moolenaarbcbf4132020-08-01 22:35:13 +02001099 // Only g:Func() can use a namespace.
1100 if (name_start[1] == ':' && !is_global)
1101 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02001102 semsg(_(e_namespace_not_supported_str), name_start);
Bram Moolenaarbcbf4132020-08-01 22:35:13 +02001103 return NULL;
1104 }
Bram Moolenaar4f3321f2022-03-13 13:12:27 +00001105 if (cctx->ctx_skip != SKIP_YES
1106 && check_defined(name_start, name_end - name_start, cctx,
Bram Moolenaardce24412022-02-08 20:35:30 +00001107 NULL, FALSE) == FAIL)
Bram Moolenaareef21022020-08-01 22:16:43 +02001108 return NULL;
Bram Moolenaarf681cfb2022-02-07 20:30:57 +00001109 if (!ASCII_ISUPPER(is_global ? name_start[2] : name_start[0]))
1110 {
Bram Moolenaar3787f262022-02-07 21:54:01 +00001111 semsg(_(e_function_name_must_start_with_capital_str), name_start);
Bram Moolenaarf681cfb2022-02-07 20:30:57 +00001112 return NULL;
1113 }
Bram Moolenaareef21022020-08-01 22:16:43 +02001114
Bram Moolenaar04b12692020-05-04 23:24:44 +02001115 eap->arg = name_end;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001116 fill_exarg_from_cctx(eap, cctx);
1117
Bram Moolenaar04b12692020-05-04 23:24:44 +02001118 eap->forceit = FALSE;
Bram Moolenaar38453522021-11-28 22:00:12 +00001119 // We use the special <Lamba>99 name, but it's not really a lambda.
John Marriottb32800f2025-02-01 15:25:34 +01001120 lambda_name = get_lambda_name();
1121 lambda_namelen = get_lambda_name_len();
1122 lambda_name = vim_strnsave(lambda_name, lambda_namelen);
Bram Moolenaar58a52f22020-12-22 18:56:55 +01001123 if (lambda_name == NULL)
1124 return NULL;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001125
1126 // This may free the current line, make a copy of the name.
1127 off = is_global ? 2 : 0;
1128 func_name = vim_strnsave(name_start + off, name_end - name_start - off);
1129 if (func_name == NULL)
1130 {
1131 r = FAIL;
1132 goto theend;
1133 }
1134
Bram Moolenaar39c82ea2023-01-02 13:08:01 +00001135 // Make sure "KeyTyped" is not set, it may cause indent to be written.
1136 int save_KeyTyped = KeyTyped;
1137 KeyTyped = FALSE;
1138
h-eastb895b0f2023-09-24 15:46:31 +02001139 ufunc = define_function(eap, lambda_name, lines_to_free, 0, NULL, 0);
Bram Moolenaar39c82ea2023-01-02 13:08:01 +00001140
1141 KeyTyped = save_KeyTyped;
1142
Bram Moolenaar822ba242020-05-24 23:00:18 +02001143 if (ufunc == NULL)
Bram Moolenaar58a52f22020-12-22 18:56:55 +01001144 {
1145 r = eap->skip ? OK : FAIL;
1146 goto theend;
1147 }
Bram Moolenaar7473a842021-12-28 17:55:26 +00001148 if (eap->nextcmd != NULL)
1149 {
1150 semsg(_(e_text_found_after_str_str),
1151 eap->cmdidx == CMD_def ? "enddef" : "endfunction", eap->nextcmd);
1152 r = FAIL;
Bram Moolenaard2939812021-12-30 17:09:05 +00001153 func_ptr_unref(ufunc);
Bram Moolenaar7473a842021-12-28 17:55:26 +00001154 goto theend;
1155 }
Bram Moolenaar8863bda2021-03-17 18:42:08 +01001156
1157 // copy over the block scope IDs before compiling
1158 if (!is_global && cctx->ctx_ufunc->uf_block_depth > 0)
1159 {
1160 int block_depth = cctx->ctx_ufunc->uf_block_depth;
1161
1162 ufunc->uf_block_ids = ALLOC_MULT(int, block_depth);
1163 if (ufunc->uf_block_ids != NULL)
1164 {
1165 mch_memmove(ufunc->uf_block_ids, cctx->ctx_ufunc->uf_block_ids,
1166 sizeof(int) * block_depth);
1167 ufunc->uf_block_depth = block_depth;
1168 }
1169 }
1170
Bram Moolenaara915fa02022-03-23 11:29:15 +00001171 // Define the funcref before compiling, so that it is found by any
1172 // recursive call.
1173 if (is_global)
1174 {
Bram Moolenaar65449bd2022-09-19 16:02:43 +01001175 r = generate_NEWFUNC(cctx, lambda_name, func_name);
Bram Moolenaara915fa02022-03-23 11:29:15 +00001176 func_name = NULL;
1177 lambda_name = NULL;
1178 }
1179 else
1180 {
1181 // Define a local variable for the function reference.
Bram Moolenaar1889f492022-08-16 19:34:44 +01001182 lvar = reserve_local(cctx, func_name, name_end - name_start,
Bram Moolenaar6586a012022-09-30 11:04:50 +01001183 ASSIGN_CONST, ufunc->uf_func_type);
Bram Moolenaara915fa02022-03-23 11:29:15 +00001184 if (lvar == NULL)
1185 goto theend;
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02001186 if (generate_FUNCREF(cctx, ufunc, NULL, FALSE, 0, &funcref_isn_idx) == FAIL)
Bram Moolenaara915fa02022-03-23 11:29:15 +00001187 goto theend;
1188 r = generate_STORE(cctx, ISN_STORE, lvar->lv_idx, NULL);
1189 }
1190
Bram Moolenaar139575d2022-03-15 19:29:30 +00001191 compile_type = get_compile_type(ufunc);
Bram Moolenaarffcfddc2021-07-11 20:22:30 +02001192#ifdef FEAT_PROFILE
1193 // If the outer function is profiled, also compile the nested function for
1194 // profiling.
1195 if (cctx->ctx_compile_type == CT_PROFILE)
1196 compile_type = CT_PROFILE;
1197#endif
1198 if (func_needs_compiling(ufunc, compile_type)
1199 && compile_def_function(ufunc, TRUE, compile_type, cctx) == FAIL)
Bram Moolenaar4ee711f2020-09-23 18:51:11 +02001200 {
1201 func_ptr_unref(ufunc);
Bram Moolenaar1889f492022-08-16 19:34:44 +01001202 if (lvar != NULL)
1203 // Now the local variable can't be used.
1204 *lvar->lv_name = '/'; // impossible value
Bram Moolenaar58a52f22020-12-22 18:56:55 +01001205 goto theend;
Bram Moolenaar4ee711f2020-09-23 18:51:11 +02001206 }
Bram Moolenaar04b12692020-05-04 23:24:44 +02001207
Bram Moolenaar648594e2021-07-11 17:55:01 +02001208#ifdef FEAT_PROFILE
1209 // When the outer function is compiled for profiling, the nested function
1210 // may be called without profiling. Compile it here in the right context.
Bram Moolenaarffcfddc2021-07-11 20:22:30 +02001211 if (compile_type == CT_PROFILE && func_needs_compiling(ufunc, CT_NONE))
Bram Moolenaar648594e2021-07-11 17:55:01 +02001212 compile_def_function(ufunc, FALSE, CT_NONE, cctx);
1213#endif
1214
Bram Moolenaara915fa02022-03-23 11:29:15 +00001215 // If a FUNCREF instruction was generated, set the index after compiling.
Yegappan Lakshmanana76fbe62023-09-27 18:51:43 +02001216 if (funcref_isn_idx != -1 && ufunc->uf_def_status == UF_COMPILED)
1217 {
1218 isn_T *funcref_isn = ((isn_T *)cctx->ctx_instr.ga_data) +
1219 funcref_isn_idx;
Bram Moolenaara915fa02022-03-23 11:29:15 +00001220 funcref_isn->isn_arg.funcref.fr_dfunc_idx = ufunc->uf_dfunc_idx;
Yegappan Lakshmanana76fbe62023-09-27 18:51:43 +02001221 }
Bram Moolenaar58a52f22020-12-22 18:56:55 +01001222
1223theend:
1224 vim_free(lambda_name);
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001225 vim_free(func_name);
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001226 return r == FAIL ? NULL : (char_u *)"";
Bram Moolenaar04b12692020-05-04 23:24:44 +02001227}
1228
1229/*
Bram Moolenaar0abc2872022-05-10 13:24:30 +01001230 * Compile one Vim expression {expr} in string "p".
1231 * "p" points to the opening "{".
1232 * Return a pointer to the character after "}", NULL for an error.
1233 */
1234 char_u *
1235compile_one_expr_in_str(char_u *p, cctx_T *cctx)
1236{
1237 char_u *block_start;
1238 char_u *block_end;
1239
1240 // Skip the opening {.
1241 block_start = skipwhite(p + 1);
1242 block_end = block_start;
1243 if (*block_start != NUL && skip_expr(&block_end, NULL) == FAIL)
1244 return NULL;
1245 block_end = skipwhite(block_end);
1246 // The block must be closed by a }.
1247 if (*block_end != '}')
1248 {
1249 semsg(_(e_missing_close_curly_str), p);
1250 return NULL;
1251 }
1252 if (compile_expr0(&block_start, cctx) == FAIL)
1253 return NULL;
Yegappan Lakshmananbce51d92024-04-15 19:19:52 +02001254 may_generate_2STRING(-1, TOSTRING_INTERPOLATE, cctx);
Bram Moolenaar0abc2872022-05-10 13:24:30 +01001255
1256 return block_end + 1;
1257}
1258
1259/*
LemonBoy2eaef102022-05-06 13:14:50 +01001260 * Compile a string "str" (either containing a literal string or a mix of
1261 * literal strings and Vim expressions of the form `{expr}`). This is used
1262 * when compiling a heredoc assignment to a variable or an interpolated string
1263 * in a Vim9 def function. Vim9 instructions are generated to push strings,
1264 * evaluate expressions, concatenate them and create a list of lines. When
1265 * "evalstr" is TRUE, Vim expressions in "str" are evaluated.
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01001266 */
1267 int
LemonBoy2eaef102022-05-06 13:14:50 +01001268compile_all_expr_in_str(char_u *str, int evalstr, cctx_T *cctx)
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01001269{
LemonBoy2eaef102022-05-06 13:14:50 +01001270 char_u *p = str;
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01001271 char_u *val;
LemonBoy2eaef102022-05-06 13:14:50 +01001272 int count = 0;
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01001273
1274 if (cctx->ctx_skip == SKIP_YES)
1275 return OK;
1276
LemonBoy2eaef102022-05-06 13:14:50 +01001277 if (!evalstr || *str == NUL)
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01001278 {
LemonBoy2eaef102022-05-06 13:14:50 +01001279 // Literal string, possibly empty.
1280 val = *str != NUL ? vim_strsave(str) : NULL;
1281 return generate_PUSHS(cctx, &val);
1282 }
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01001283
LemonBoy2eaef102022-05-06 13:14:50 +01001284 // Push all the string pieces to the stack, followed by a ISN_CONCAT.
1285 while (*p != NUL)
1286 {
1287 char_u *lit_start;
LemonBoy2eaef102022-05-06 13:14:50 +01001288 int escaped_brace = FALSE;
1289
1290 // Look for a block start.
1291 lit_start = p;
1292 while (*p != '{' && *p != '}' && *p != NUL)
1293 ++p;
1294
1295 if (*p != NUL && *p == p[1])
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01001296 {
LemonBoy2eaef102022-05-06 13:14:50 +01001297 // Escaped brace, unescape and continue.
1298 // Include the brace in the literal string.
1299 ++p;
1300 escaped_brace = TRUE;
1301 }
1302 else if (*p == '}')
1303 {
1304 semsg(_(e_stray_closing_curly_str), str);
1305 return FAIL;
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01001306 }
LemonBoy372bcce2022-04-25 12:43:20 +01001307
LemonBoy2eaef102022-05-06 13:14:50 +01001308 // Append the literal part.
1309 if (p != lit_start)
1310 {
1311 val = vim_strnsave(lit_start, (size_t)(p - lit_start));
1312 if (generate_PUSHS(cctx, &val) == FAIL)
1313 return FAIL;
1314 ++count;
1315 }
1316
1317 if (*p == NUL)
1318 break;
1319
1320 if (escaped_brace)
1321 {
1322 // Skip the second brace.
1323 ++p;
1324 continue;
1325 }
1326
Bram Moolenaar0abc2872022-05-10 13:24:30 +01001327 p = compile_one_expr_in_str(p, cctx);
1328 if (p == NULL)
LemonBoy2eaef102022-05-06 13:14:50 +01001329 return FAIL;
LemonBoy2eaef102022-05-06 13:14:50 +01001330 ++count;
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01001331 }
LemonBoy2eaef102022-05-06 13:14:50 +01001332
1333 // Small optimization, if there's only a single piece skip the ISN_CONCAT.
Bram Moolenaar0abc2872022-05-10 13:24:30 +01001334 if (count > 1)
LemonBoy2eaef102022-05-06 13:14:50 +01001335 return generate_CONCAT(cctx, count);
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01001336
1337 return OK;
1338}
1339
1340/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001341 * Return the length of an assignment operator, or zero if there isn't one.
1342 */
1343 int
1344assignment_len(char_u *p, int *heredoc)
1345{
1346 if (*p == '=')
1347 {
1348 if (p[1] == '<' && p[2] == '<')
1349 {
1350 *heredoc = TRUE;
1351 return 3;
1352 }
1353 return 1;
1354 }
1355 if (vim_strchr((char_u *)"+-*/%", *p) != NULL && p[1] == '=')
1356 return 2;
1357 if (STRNCMP(p, "..=", 3) == 0)
1358 return 3;
1359 return 0;
1360}
1361
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001362/*
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001363 * Generate the load instruction for "name".
1364 */
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02001365 static int
Bram Moolenaard505d172022-12-18 21:42:55 +00001366generate_loadvar(cctx_T *cctx, lhs_T *lhs)
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001367{
Bram Moolenaard505d172022-12-18 21:42:55 +00001368 char_u *name = lhs->lhs_name;
1369 type_T *type = lhs->lhs_type;
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02001370 int res = OK;
Bram Moolenaard505d172022-12-18 21:42:55 +00001371
1372 switch (lhs->lhs_dest)
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001373 {
1374 case dest_option:
Bram Moolenaardcb53be2021-12-09 14:23:43 +00001375 case dest_func_option:
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001376 generate_LOAD(cctx, ISN_LOADOPT, 0, name, type);
1377 break;
1378 case dest_global:
Bram Moolenaar03290b82020-12-19 16:30:44 +01001379 if (vim_strchr(name, AUTOLOAD_CHAR) == NULL)
Bram Moolenaar2e17fef2022-03-18 19:44:48 +00001380 {
1381 if (name[2] == NUL)
1382 generate_instr_type(cctx, ISN_LOADGDICT, &t_dict_any);
1383 else
1384 generate_LOAD(cctx, ISN_LOADG, 0, name + 2, type);
1385 }
Bram Moolenaar03290b82020-12-19 16:30:44 +01001386 else
1387 generate_LOAD(cctx, ISN_LOADAUTO, 0, name, type);
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001388 break;
1389 case dest_buffer:
1390 generate_LOAD(cctx, ISN_LOADB, 0, name + 2, type);
1391 break;
1392 case dest_window:
1393 generate_LOAD(cctx, ISN_LOADW, 0, name + 2, type);
1394 break;
1395 case dest_tab:
1396 generate_LOAD(cctx, ISN_LOADT, 0, name + 2, type);
1397 break;
1398 case dest_script:
Ernie Rael3f821d62024-04-24 20:07:50 +02001399 case dest_script_v9:
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02001400 res = compile_load_scriptvar(cctx,
Hirohito Higashibf7c88d2025-02-13 21:04:07 +01001401 name + (name[1] == ':' ? 2 : 0), NULL, NULL, NULL);
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001402 break;
1403 case dest_env:
1404 // Include $ in the name here
1405 generate_LOAD(cctx, ISN_LOADENV, 0, name, type);
1406 break;
1407 case dest_reg:
1408 generate_LOAD(cctx, ISN_LOADREG, name[1], NULL, &t_string);
1409 break;
1410 case dest_vimvar:
Bram Moolenaarc3caa7f2022-05-25 19:15:10 +01001411 generate_LOADV(cctx, name + 2);
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001412 break;
1413 case dest_local:
Bram Moolenaar4875d6a2022-08-17 15:55:51 +01001414 if (cctx->ctx_skip != SKIP_YES)
1415 {
Bram Moolenaard505d172022-12-18 21:42:55 +00001416 lvar_T *lvar = lhs->lhs_lvar;
Bram Moolenaar4875d6a2022-08-17 15:55:51 +01001417 if (lvar->lv_from_outer > 0)
1418 generate_LOADOUTER(cctx, lvar->lv_idx, lvar->lv_from_outer,
Bram Moolenaar65449bd2022-09-19 16:02:43 +01001419 lvar->lv_loop_depth, lvar->lv_loop_idx, type);
Bram Moolenaar4875d6a2022-08-17 15:55:51 +01001420 else
1421 generate_LOAD(cctx, ISN_LOAD, lvar->lv_idx, NULL, type);
1422 }
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001423 break;
Bram Moolenaard505d172022-12-18 21:42:55 +00001424 case dest_class_member:
1425 generate_CLASSMEMBER(cctx, TRUE, lhs->lhs_class,
1426 lhs->lhs_classmember_idx);
1427 break;
Bram Moolenaardc234ca2020-11-28 18:52:33 +01001428 case dest_expr:
1429 // list or dict value should already be on the stack.
1430 break;
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001431 }
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02001432
1433 return res;
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001434}
1435
Bram Moolenaardc234ca2020-11-28 18:52:33 +01001436/*
1437 * Skip over "[expr]" or ".member".
1438 * Does not check for any errors.
1439 */
1440 static char_u *
1441skip_index(char_u *start)
1442{
1443 char_u *p = start;
1444
1445 if (*p == '[')
1446 {
1447 p = skipwhite(p + 1);
1448 (void)skip_expr(&p, NULL);
1449 p = skipwhite(p);
1450 if (*p == ']')
1451 return p + 1;
1452 return p;
1453 }
1454 // if (*p == '.')
1455 return to_name_end(p + 1, TRUE);
1456}
1457
Bram Moolenaare55b1c02020-06-21 15:52:59 +02001458 void
1459vim9_declare_error(char_u *name)
1460{
1461 char *scope = "";
1462
1463 switch (*name)
1464 {
Bram Moolenaar7fe87552020-06-21 20:38:28 +02001465 case 'g': scope = _("global"); break;
1466 case 'b': scope = _("buffer"); break;
1467 case 'w': scope = _("window"); break;
1468 case 't': scope = _("tab"); break;
1469 case 'v': scope = "v:"; break;
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00001470 case '$': semsg(_(e_cannot_declare_an_environment_variable_str), name);
Bram Moolenaarc2ee44c2020-08-02 16:59:00 +02001471 return;
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00001472 case '&': semsg(_(e_cannot_declare_an_option_str), name);
Bram Moolenaarc2ee44c2020-08-02 16:59:00 +02001473 return;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001474 case '@': semsg(_(e_cannot_declare_a_register_str), name);
Bram Moolenaarc2ee44c2020-08-02 16:59:00 +02001475 return;
Bram Moolenaar7fe87552020-06-21 20:38:28 +02001476 default: return;
Bram Moolenaare55b1c02020-06-21 15:52:59 +02001477 }
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00001478 semsg(_(e_cannot_declare_a_scope_variable_str), scope, name);
Bram Moolenaare55b1c02020-06-21 15:52:59 +02001479}
1480
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001481/*
Bram Moolenaar3558afe2022-10-13 16:12:57 +01001482 * Return TRUE if "name" is a valid register to use.
1483 * Return FALSE and give an error message if not.
1484 */
1485 static int
1486valid_dest_reg(int name)
1487{
1488 if ((name == '@' || valid_yank_reg(name, FALSE)) && name != '.')
1489 return TRUE;
1490 emsg_invreg(name);
1491 return FAIL;
1492}
1493
1494/*
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001495 * For one assignment figure out the type of destination. Return it in "dest".
1496 * When not recognized "dest" is not set.
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001497 * For an option "option_scope" is set.
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001498 * For a v:var "vimvaridx" is set.
1499 * "type" is set to the destination type if known, unchanted otherwise.
1500 * Return FAIL if an error message was given.
1501 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +00001502 int
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001503get_var_dest(
1504 char_u *name,
1505 assign_dest_T *dest,
Bram Moolenaar97f8c102022-04-02 19:43:57 +01001506 cmdidx_T cmdidx,
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001507 int *option_scope,
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001508 int *vimvaridx,
1509 type_T **type,
1510 cctx_T *cctx)
1511{
1512 char_u *p;
1513
1514 if (*name == '&')
1515 {
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001516 int cc;
1517 long numval;
1518 getoption_T opt_type;
Bram Moolenaardcb53be2021-12-09 14:23:43 +00001519 int opt_p_flags;
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001520
1521 *dest = dest_option;
1522 if (cmdidx == CMD_final || cmdidx == CMD_const)
1523 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00001524 emsg(_(e_cannot_lock_option));
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001525 return FAIL;
1526 }
1527 p = name;
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001528 p = find_option_end(&p, option_scope);
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001529 if (p == NULL)
1530 {
1531 // cannot happen?
Bram Moolenaar108010a2021-06-27 22:03:33 +02001532 emsg(_(e_unexpected_characters_in_assignment));
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001533 return FAIL;
1534 }
1535 cc = *p;
1536 *p = NUL;
1537 opt_type = get_option_value(skip_option_env_lead(name),
Bram Moolenaardcb53be2021-12-09 14:23:43 +00001538 &numval, NULL, &opt_p_flags, *option_scope);
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001539 *p = cc;
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001540 switch (opt_type)
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001541 {
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001542 case gov_unknown:
Bram Moolenaare1242042021-12-16 20:56:57 +00001543 semsg(_(e_unknown_option_str), name);
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001544 return FAIL;
1545 case gov_string:
1546 case gov_hidden_string:
Bram Moolenaardcb53be2021-12-09 14:23:43 +00001547 if (opt_p_flags & P_FUNC)
1548 {
1549 // might be a Funcref, check the type later
1550 *type = &t_any;
1551 *dest = dest_func_option;
1552 }
1553 else
1554 {
1555 *type = &t_string;
1556 }
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001557 break;
1558 case gov_bool:
1559 case gov_hidden_bool:
1560 *type = &t_bool;
1561 break;
1562 case gov_number:
1563 case gov_hidden_number:
1564 *type = &t_number;
1565 break;
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001566 }
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001567 }
1568 else if (*name == '$')
1569 {
1570 *dest = dest_env;
1571 *type = &t_string;
1572 }
1573 else if (*name == '@')
1574 {
Bram Moolenaar3558afe2022-10-13 16:12:57 +01001575 if (!valid_dest_reg(name[1]))
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001576 return FAIL;
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001577 *dest = dest_reg;
Bram Moolenaar74f4a962021-06-17 21:03:07 +02001578 *type = name[1] == '#' ? &t_number_or_string : &t_string;
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001579 }
1580 else if (STRNCMP(name, "g:", 2) == 0)
1581 {
1582 *dest = dest_global;
1583 }
1584 else if (STRNCMP(name, "b:", 2) == 0)
1585 {
1586 *dest = dest_buffer;
1587 }
1588 else if (STRNCMP(name, "w:", 2) == 0)
1589 {
1590 *dest = dest_window;
1591 }
1592 else if (STRNCMP(name, "t:", 2) == 0)
1593 {
1594 *dest = dest_tab;
1595 }
1596 else if (STRNCMP(name, "v:", 2) == 0)
1597 {
1598 typval_T *vtv;
1599 int di_flags;
1600
1601 *vimvaridx = find_vim_var(name + 2, &di_flags);
1602 if (*vimvaridx < 0)
1603 {
1604 semsg(_(e_variable_not_found_str), name);
1605 return FAIL;
1606 }
1607 // We use the current value of "sandbox" here, is that OK?
1608 if (var_check_ro(di_flags, name, FALSE))
1609 return FAIL;
1610 *dest = dest_vimvar;
1611 vtv = get_vim_var_tv(*vimvaridx);
1612 *type = typval2type_vimvar(vtv, cctx->ctx_type_list);
1613 }
1614 return OK;
1615}
1616
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02001617 static int
Bram Moolenaar97f8c102022-04-02 19:43:57 +01001618is_decl_command(cmdidx_T cmdidx)
Bram Moolenaar752fc692021-01-04 21:57:11 +01001619{
1620 return cmdidx == CMD_let || cmdidx == CMD_var
1621 || cmdidx == CMD_final || cmdidx == CMD_const;
1622}
1623
1624/*
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02001625 * Returns TRUE if the class or object variable in "lhs" is modifiable.
1626 * "var_start" points to the start of the variable name and "lhs->lhs_varlen"
1627 * has the total length. Note that the "lhs" can be nested an object reference
1628 * (e.g. a.b.c.d.var).
1629 */
1630 static int
1631lhs_class_member_modifiable(lhs_T *lhs, char_u *var_start, cctx_T *cctx)
1632{
1633 size_t varlen = lhs->lhs_varlen;
1634 class_T *cl = lhs->lhs_type->tt_class;
1635 int is_object = lhs->lhs_type->tt_type == VAR_OBJECT;
1636 char_u *name = var_start + varlen + 1;
1637 size_t namelen = lhs->lhs_end - var_start - varlen - 1;
1638 ocmember_T *m;
1639
1640 m = member_lookup(cl, lhs->lhs_type->tt_type, name, namelen, NULL);
1641 if (m == NULL)
1642 {
1643 member_not_found_msg(cl, lhs->lhs_type->tt_type, name, namelen);
1644 return FALSE;
1645 }
1646
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01001647 if (IS_ENUM(cl))
1648 {
1649 semsg(_(e_enumvalue_str_cannot_be_modified), cl->class_name,
1650 m->ocm_name);
1651 return FALSE;
1652 }
1653
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02001654 // If it is private member variable, then accessing it outside the
1655 // class is not allowed.
1656 // If it is a read only class variable, then it can be modified
1657 // only inside the class where it is defined.
1658 if ((m->ocm_access != VIM_ACCESS_ALL) &&
1659 ((is_object && !inside_class(cctx, cl))
1660 || (!is_object && cctx->ctx_ufunc->uf_class != cl)))
1661 {
1662 char *msg = (m->ocm_access == VIM_ACCESS_PRIVATE)
Ernie Rael03042a22023-11-11 08:53:32 +01001663 ? e_cannot_access_protected_variable_str
RestorerZ7fe8f432023-09-24 23:21:24 +02001664 : e_variable_is_not_writable_str;
Ernie Raele6c9aa52023-10-06 19:55:52 +02001665 emsg_var_cl_define(msg, m->ocm_name, 0, cl);
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02001666 return FALSE;
1667 }
1668
1669 return TRUE;
1670}
1671
1672/*
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001673 * Initialize "lhs" with default values
Bram Moolenaar752fc692021-01-04 21:57:11 +01001674 */
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001675 static void
1676lhs_init_defaults(lhs_T *lhs)
Bram Moolenaar752fc692021-01-04 21:57:11 +01001677{
Bram Moolenaar752fc692021-01-04 21:57:11 +01001678 CLEAR_POINTER(lhs);
1679 lhs->lhs_dest = dest_local;
1680 lhs->lhs_vimvaridx = -1;
1681 lhs->lhs_scriptvar_idx = -1;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001682 lhs->lhs_member_idx = -1;
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001683}
Bram Moolenaar752fc692021-01-04 21:57:11 +01001684
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001685/*
1686 * When compiling a LHS variable name, find the end of the destination and the
1687 * end of the variable name.
1688 */
1689 static int
1690lhs_find_var_end(
1691 lhs_T *lhs,
1692 char_u *var_start,
1693 int is_decl,
1694 char_u **var_endp)
1695{
1696 char_u *var_end = *var_endp;
1697
1698 // "lhs_dest_end" is the end of the destination, including "[expr]" or
Bram Moolenaar752fc692021-01-04 21:57:11 +01001699 // ".name".
1700 // "var_end" is the end of the variable/option/etc. name.
1701 lhs->lhs_dest_end = skip_var_one(var_start, FALSE);
1702 if (*var_start == '@')
Bram Moolenaar3558afe2022-10-13 16:12:57 +01001703 {
1704 if (!valid_dest_reg(var_start[1]))
1705 return FAIL;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001706 var_end = var_start + 2;
Bram Moolenaar3558afe2022-10-13 16:12:57 +01001707 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01001708 else
1709 {
1710 // skip over the leading "&", "&l:", "&g:" and "$"
1711 var_end = skip_option_env_lead(var_start);
1712 var_end = to_name_end(var_end, TRUE);
1713 }
1714
1715 // "a: type" is declaring variable "a" with a type, not dict "a:".
1716 if (is_decl && lhs->lhs_dest_end == var_start + 2
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001717 && lhs->lhs_dest_end[-1] == ':')
Bram Moolenaar752fc692021-01-04 21:57:11 +01001718 --lhs->lhs_dest_end;
1719 if (is_decl && var_end == var_start + 2 && var_end[-1] == ':')
1720 --var_end;
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001721
Bram Moolenaarab36e6a2021-11-30 16:14:49 +00001722 lhs->lhs_end = lhs->lhs_dest_end;
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001723 *var_endp = var_end;
1724
1725 return OK;
1726}
1727
1728/*
1729 * Set various fields in "lhs"
1730 */
1731 static int
1732lhs_init(
1733 lhs_T *lhs,
1734 char_u *var_start,
1735 int is_decl,
1736 int heredoc,
1737 char_u **var_endp)
1738{
1739 char_u *var_end = *var_endp;
1740
1741 lhs_init_defaults(lhs);
1742
1743 // Find the end of the variable and the destination
1744 if (lhs_find_var_end(lhs, var_start, is_decl, &var_end) == FAIL)
1745 return FAIL;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001746
1747 // compute the length of the destination without "[expr]" or ".name"
1748 lhs->lhs_varlen = var_end - var_start;
Bram Moolenaar753bcf82021-04-21 14:24:24 +02001749 lhs->lhs_varlen_total = lhs->lhs_varlen;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001750 lhs->lhs_name = vim_strnsave(var_start, lhs->lhs_varlen);
1751 if (lhs->lhs_name == NULL)
1752 return FAIL;
Bram Moolenaar08251752021-01-11 21:20:18 +01001753
1754 if (lhs->lhs_dest_end > var_start + lhs->lhs_varlen)
1755 // Something follows after the variable: "var[idx]" or "var.key".
1756 lhs->lhs_has_index = TRUE;
1757
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001758 lhs->lhs_type = heredoc ? &t_list_string : &t_any;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001759
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001760 *var_endp = var_end;
1761
1762 return OK;
1763}
1764
1765/*
1766 * Compile a LHS class variable name.
1767 */
1768 static int
1769compile_lhs_class_variable(
1770 cctx_T *cctx,
1771 lhs_T *lhs,
1772 class_T *defcl,
1773 int is_decl)
1774{
1775 if (cctx->ctx_ufunc->uf_defclass != defcl)
Bram Moolenaar752fc692021-01-04 21:57:11 +01001776 {
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001777 // A class variable can be accessed without the class name
1778 // only inside a class.
1779 semsg(_(e_class_variable_str_accessible_only_inside_class_str),
1780 lhs->lhs_name, defcl->class_name);
1781 return FAIL;
1782 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01001783
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001784 if (is_decl)
1785 {
1786 semsg(_(e_variable_already_declared_in_class_str), lhs->lhs_name);
1787 return FAIL;
1788 }
1789
1790 ocmember_T *m = &defcl->class_class_members[lhs->lhs_classmember_idx];
1791 if (oc_var_check_ro(defcl, m))
1792 return FAIL;
1793
1794 lhs->lhs_dest = dest_class_member;
1795 // The class variable is defined either in the current class or
1796 // in one of the parent class in the hierarchy.
1797 lhs->lhs_class = defcl;
1798 lhs->lhs_type = oc_member_type_by_idx(defcl, FALSE,
1799 lhs->lhs_classmember_idx);
1800
1801 return OK;
1802}
1803
1804/*
1805 * Compile an imported LHS variable
1806 */
1807 static int
1808compile_lhs_import_var(
1809 lhs_T *lhs,
1810 imported_T *import,
1811 char_u *var_start,
1812 char_u **var_endp,
1813 char_u **rawnamep)
1814{
1815 char_u *var_end = *var_endp;
1816 char_u *dot = vim_strchr(var_start, '.');
1817 char_u *p;
1818
1819 // for an import the name is what comes after the dot
1820 if (dot == NULL)
1821 {
1822 semsg(_(e_no_dot_after_imported_name_str), var_start);
1823 return FAIL;
1824 }
1825
1826 p = skipwhite(dot + 1);
1827 var_end = to_name_end(p, TRUE);
1828 if (var_end == p)
1829 {
1830 semsg(_(e_missing_name_after_imported_name_str), var_start);
1831 return FAIL;
1832 }
1833
1834 vim_free(lhs->lhs_name);
1835 lhs->lhs_varlen = var_end - p;
1836 lhs->lhs_name = vim_strnsave(p, lhs->lhs_varlen);
1837 if (lhs->lhs_name == NULL)
1838 return FAIL;
1839 *rawnamep = lhs->lhs_name;
1840 lhs->lhs_scriptvar_sid = import->imp_sid;
1841
1842 // TODO: where do we check this name is exported?
1843
1844 // Check if something follows: "exp.var[idx]" or
1845 // "exp.var.key".
1846 lhs->lhs_has_index = lhs->lhs_dest_end > skipwhite(var_end);
1847
1848 *var_endp = var_end;
1849
1850 return OK;
1851}
1852
1853/*
1854 * Process a script-local variable when compiling a LHS variable name.
1855 */
1856 static int
1857compile_lhs_script_var(
1858 cctx_T *cctx,
1859 lhs_T *lhs,
1860 char_u *var_start,
1861 char_u *var_end,
1862 int is_decl)
1863{
1864 int script_namespace = FALSE;
1865 int script_var = FALSE;
1866 imported_T *import;
1867 char_u *var_name;
Yegappan Lakshmanan084529c2024-12-24 09:50:01 +01001868 size_t var_name_len;
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001869
1870 if (lhs->lhs_varlen > 1 && STRNCMP(var_start, "s:", 2) == 0)
1871 script_namespace = TRUE;
1872
1873 if (script_namespace)
1874 {
1875 var_name = var_start + 2;
1876 var_name_len = lhs->lhs_varlen - 2;
1877 }
1878 else
1879 {
1880 var_name = var_start;
1881 var_name_len = lhs->lhs_varlen;
1882 }
1883
1884 if (script_var_exists(var_name, var_name_len, cctx, NULL) == OK)
1885 script_var = TRUE;
1886
1887 import = find_imported(var_start, lhs->lhs_varlen, FALSE);
1888
1889 if (script_namespace || script_var || import != NULL)
1890 {
1891 char_u *rawname = lhs->lhs_name + (lhs->lhs_name[1] == ':' ? 2 : 0);
1892
1893 if (script_namespace && current_script_is_vim9())
Bram Moolenaar752fc692021-01-04 21:57:11 +01001894 {
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001895 semsg(_(e_cannot_use_s_colon_in_vim9_script_str), var_start);
1896 return FAIL;
1897 }
1898
1899 if (is_decl)
1900 {
1901 if (script_namespace)
1902 semsg(_(e_cannot_declare_script_variable_in_function_str),
1903 lhs->lhs_name);
1904 else
1905 semsg(_(e_variable_already_declared_in_script_str),
1906 lhs->lhs_name);
1907 return FAIL;
1908 }
1909 else if (cctx->ctx_ufunc->uf_script_ctx_version == SCRIPT_VERSION_VIM9
1910 && script_namespace
1911 && !script_var && import == NULL)
1912 {
1913 semsg(_(e_unknown_variable_str), lhs->lhs_name);
1914 return FAIL;
1915 }
1916
1917 lhs->lhs_dest = current_script_is_vim9() ? dest_script_v9 :
1918 dest_script;
1919
1920 // existing script-local variables should have a type
1921 lhs->lhs_scriptvar_sid = current_sctx.sc_sid;
1922 if (import != NULL)
1923 {
1924 if (compile_lhs_import_var(lhs, import, var_start, &var_end,
1925 &rawname) == FAIL)
1926 return FAIL;
1927 }
1928
1929 if (SCRIPT_ID_VALID(lhs->lhs_scriptvar_sid))
1930 {
1931 // Check writable only when no index follows.
1932 lhs->lhs_scriptvar_idx = get_script_item_idx(
1933 lhs->lhs_scriptvar_sid, rawname,
1934 lhs->lhs_has_index ? ASSIGN_FINAL :
1935 ASSIGN_CONST, cctx, NULL);
1936 if (lhs->lhs_scriptvar_idx >= 0)
1937 {
1938 scriptitem_T *si = SCRIPT_ITEM(lhs->lhs_scriptvar_sid);
1939 svar_T *sv = ((svar_T *)si->sn_var_vals.ga_data)
1940 + lhs->lhs_scriptvar_idx;
1941
1942 lhs->lhs_type = sv->sv_type;
1943 }
1944 }
1945
1946 return OK;
1947 }
1948
1949 return check_defined(var_start, lhs->lhs_varlen, cctx, NULL, FALSE);
1950}
1951
1952/*
1953 * Compile the LHS destination.
1954 */
1955 static int
1956compile_lhs_var_dest(
1957 cctx_T *cctx,
1958 lhs_T *lhs,
1959 int cmdidx,
1960 char_u *var_start,
1961 char_u *var_end,
1962 int is_decl)
1963{
1964 int declare_error = FALSE;
1965
1966 if (get_var_dest(lhs->lhs_name, &lhs->lhs_dest, cmdidx,
1967 &lhs->lhs_opt_flags, &lhs->lhs_vimvaridx,
1968 &lhs->lhs_type, cctx) == FAIL)
1969 return FAIL;
1970
1971 if (lhs->lhs_dest != dest_local && cmdidx != CMD_const
1972 && cmdidx != CMD_final)
1973 {
1974 // Specific kind of variable recognized.
1975 declare_error = is_decl;
1976 }
1977 else
1978 {
1979 class_T *defcl;
1980
1981 // No specific kind of variable recognized, just a name.
1982 if (check_reserved_name(lhs->lhs_name, lhs->lhs_has_index
1983 && *var_end == '.') == FAIL)
1984 return FAIL;
1985
1986 if (lookup_local(var_start, lhs->lhs_varlen, &lhs->lhs_local_lvar,
1987 cctx) == OK)
1988 {
1989 lhs->lhs_lvar = &lhs->lhs_local_lvar;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001990 }
1991 else
1992 {
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001993 CLEAR_FIELD(lhs->lhs_arg_lvar);
1994 if (arg_exists(var_start, lhs->lhs_varlen,
1995 &lhs->lhs_arg_lvar.lv_idx, &lhs->lhs_arg_lvar.lv_type,
1996 &lhs->lhs_arg_lvar.lv_from_outer, cctx) == OK)
Bram Moolenaar752fc692021-01-04 21:57:11 +01001997 {
1998 if (is_decl)
1999 {
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01002000 semsg(_(e_str_is_used_as_argument), lhs->lhs_name);
Bram Moolenaar752fc692021-01-04 21:57:11 +01002001 return FAIL;
2002 }
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01002003 lhs->lhs_lvar = &lhs->lhs_arg_lvar;
Bram Moolenaar752fc692021-01-04 21:57:11 +01002004 }
2005 }
2006
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01002007 if (lhs->lhs_lvar != NULL)
Bram Moolenaar752fc692021-01-04 21:57:11 +01002008 {
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01002009 if (is_decl)
2010 {
2011 // if we come here with what looks like an assignment like
2012 // .= but which has been rejected by assignment_len() from
2013 // may_compile_assignment give a better error message
2014 char_u *p = skipwhite(lhs->lhs_end);
2015 if (p[0] == '.' && p[1] == '=')
2016 emsg(_(e_dot_equal_not_supported_with_script_version_two));
2017 else if (p[0] == ':')
2018 // type specified in a non-var assignment
2019 semsg(_(e_trailing_characters_str), p);
2020 else
2021 semsg(_(e_variable_already_declared_str), lhs->lhs_name);
2022 return FAIL;
2023 }
2024 }
2025 else if ((lhs->lhs_classmember_idx = cctx_class_member_idx(
2026 cctx, var_start, lhs->lhs_varlen, &defcl)) >= 0)
2027 {
2028 if (compile_lhs_class_variable(cctx, lhs, defcl, is_decl)
2029 == FAIL)
2030 return FAIL;
2031 }
2032 else
2033 {
2034 if (compile_lhs_script_var(cctx, lhs, var_start, var_end,
2035 is_decl) == FAIL)
2036 return FAIL;
2037 }
2038 }
2039
2040 if (declare_error)
2041 {
2042 vim9_declare_error(lhs->lhs_name);
2043 return FAIL;
2044 }
2045
2046 return OK;
2047}
2048
2049/*
2050 * When compiling a LHS variable name, for a class or an object, set the LHS
2051 * member type.
2052 */
2053 static int
2054compile_lhs_set_oc_member_type(
2055 cctx_T *cctx,
2056 lhs_T *lhs,
2057 char_u *var_start)
2058{
2059 class_T *cl = lhs->lhs_type->tt_class;
2060 int is_object = lhs->lhs_type->tt_type == VAR_OBJECT;
2061 char_u *name = var_start + lhs->lhs_varlen + 1;
2062 size_t namelen = lhs->lhs_end - var_start - lhs->lhs_varlen - 1;
2063
2064 ocmember_T *m = member_lookup(cl, lhs->lhs_type->tt_type,
2065 name, namelen, &lhs->lhs_member_idx);
2066 if (m == NULL)
2067 {
2068 member_not_found_msg(cl, lhs->lhs_type->tt_type, name, namelen);
2069 return FAIL;
2070 }
2071
2072 if (IS_ENUM(cl))
2073 {
2074 if (!inside_class(cctx, cl))
2075 {
2076 semsg(_(e_enumvalue_str_cannot_be_modified),
2077 cl->class_name, m->ocm_name);
Bram Moolenaar752fc692021-01-04 21:57:11 +01002078 return FAIL;
2079 }
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01002080 if (lhs->lhs_type->tt_type == VAR_OBJECT &&
2081 lhs->lhs_member_idx < 2)
2082 {
2083 char *msg = lhs->lhs_member_idx == 0 ?
2084 e_enum_str_name_cannot_be_modified :
2085 e_enum_str_ordinal_cannot_be_modified;
2086 semsg(_(msg), cl->class_name);
2087 return FAIL;
2088 }
2089 }
2090
2091 // If it is private member variable, then accessing it outside the
2092 // class is not allowed.
2093 // If it is a read only class variable, then it can be modified
2094 // only inside the class where it is defined.
2095 if ((m->ocm_access != VIM_ACCESS_ALL) &&
2096 ((is_object && !inside_class(cctx, cl))
2097 || (!is_object && cctx->ctx_ufunc->uf_class != cl)))
2098 {
2099 char *msg = (m->ocm_access == VIM_ACCESS_PRIVATE)
2100 ? e_cannot_access_protected_variable_str
2101 : e_variable_is_not_writable_str;
2102 emsg_var_cl_define(msg, m->ocm_name, 0, cl);
2103 return FAIL;
2104 }
2105
2106 if (!IS_CONSTRUCTOR_METHOD(cctx->ctx_ufunc)
2107 && oc_var_check_ro(cl, m))
2108 return FAIL;
2109
2110 lhs->lhs_member_type = m->ocm_type;
2111
2112 return OK;
2113}
2114
2115/*
2116 * When compiling a LHS variable, set the LHS variable type.
2117 */
2118 static int
2119compile_lhs_set_type(cctx_T *cctx, lhs_T *lhs, char_u *var_end, int is_decl)
2120{
2121 if (is_decl && *skipwhite(var_end) == ':')
2122 {
2123 char_u *p;
2124
2125 // parse optional type: "let var: type = expr"
2126 if (VIM_ISWHITE(*var_end))
2127 {
2128 semsg(_(e_no_white_space_allowed_before_colon_str), var_end);
2129 return FAIL;
2130 }
2131
2132 if (!VIM_ISWHITE(var_end[1]))
2133 {
2134 semsg(_(e_white_space_required_after_str_str), ":", var_end);
2135 return FAIL;
2136 }
2137
2138 p = skipwhite(var_end + 1);
2139 lhs->lhs_type = parse_type(&p, cctx->ctx_type_list, TRUE);
2140 if (lhs->lhs_type == NULL)
2141 return FAIL;
2142
2143 lhs->lhs_has_type = TRUE;
2144 lhs->lhs_end = p;
2145 }
2146 else if (lhs->lhs_lvar != NULL)
2147 lhs->lhs_type = lhs->lhs_lvar->lv_type;
2148
2149 return OK;
2150}
2151
2152/*
2153 * Returns TRUE if "lhs" is a concatenable string.
2154 */
2155 static int
2156lhs_concatenable(lhs_T *lhs)
2157{
2158 return lhs->lhs_dest == dest_global
2159 || lhs->lhs_has_index
2160 || lhs->lhs_type->tt_type == VAR_STRING
2161 || lhs->lhs_type->tt_type == VAR_ANY;
2162}
2163
2164/*
2165 * Create a new local variable when compiling a LHS variable.
2166 */
2167 static int
2168compile_lhs_new_local_var(
2169 cctx_T *cctx,
2170 lhs_T *lhs,
2171 char_u *var_start,
2172 int cmdidx,
2173 int oplen,
2174 int is_decl,
2175 int has_cmd,
2176 int heredoc)
2177{
2178 if (oplen > 1 && !heredoc)
2179 {
2180 // +=, /=, etc. require an existing variable
2181 semsg(_(e_cannot_use_operator_on_new_variable_str), lhs->lhs_name);
2182 return FAIL;
2183 }
2184
2185 if (!is_decl || (lhs->lhs_has_index && !has_cmd
2186 && cctx->ctx_skip != SKIP_YES))
2187 {
2188 semsg(_(e_unknown_variable_str), lhs->lhs_name);
2189 return FAIL;
2190 }
2191
2192 // Check the name is valid for a funcref.
2193 if (lhs->lhs_type->tt_type == VAR_FUNC
2194 || lhs->lhs_type->tt_type == VAR_PARTIAL)
2195 {
2196 if (var_wrong_func_name(lhs->lhs_name, TRUE))
2197 return FAIL;
2198 }
2199
2200 // New local variable.
2201 int assign;
2202 switch (cmdidx)
2203 {
2204 case CMD_final:
2205 assign = ASSIGN_FINAL; break;
2206 case CMD_const:
2207 assign = ASSIGN_CONST; break;
2208 default:
2209 assign = ASSIGN_VAR; break;
2210 }
2211
2212 lhs->lhs_lvar = reserve_local(cctx, var_start, lhs->lhs_varlen, assign,
2213 lhs->lhs_type);
2214 if (lhs->lhs_lvar == NULL)
2215 return FAIL;
2216
2217 lhs->lhs_new_local = TRUE;
2218
2219 return OK;
2220}
2221
2222/*
2223 * When compiling a LHS variable name, set the LHS member type.
2224 */
2225 static int
2226compile_lhs_set_member_type(
2227 cctx_T *cctx,
2228 lhs_T *lhs,
2229 char_u *var_start,
2230 int is_decl,
2231 int has_cmd)
2232{
2233 lhs->lhs_member_type = lhs->lhs_type;
2234
2235 if (!lhs->lhs_has_index)
2236 return OK;
2237
2238 char_u *after = var_start + lhs->lhs_varlen;
2239 char_u *p;
2240
2241 // Something follows after the variable: "var[idx]" or "var.key".
2242 if (is_decl && cctx->ctx_skip != SKIP_YES)
2243 {
2244 if (has_cmd)
2245 emsg(_(e_cannot_use_index_when_declaring_variable));
2246 else
2247 semsg(_(e_unknown_variable_str), lhs->lhs_name);
2248 return FAIL;
2249 }
2250
2251 // Now: var_start[lhs->lhs_varlen] is '[' or '.'
2252 // Only the last index is used below, if there are others
2253 // before it generate code for the expression. Thus for
2254 // "ll[1][2]" the expression is "ll[1]" and "[2]" is the index.
2255 for (;;)
2256 {
2257 p = skip_index(after);
2258 if (*p != '[' && *p != '.')
2259 {
2260 lhs->lhs_varlen_total = p - var_start;
2261 break;
2262 }
2263 after = p;
2264 }
2265 if (after > var_start + lhs->lhs_varlen)
2266 {
2267 lhs->lhs_varlen = after - var_start;
2268 lhs->lhs_dest = dest_expr;
2269 // We don't know the type before evaluating the expression,
2270 // use "any" until then.
2271 lhs->lhs_type = &t_any;
2272 }
2273
2274 int use_class = lhs->lhs_type != NULL
2275 && (lhs->lhs_type->tt_type == VAR_CLASS
2276 || lhs->lhs_type->tt_type == VAR_OBJECT);
2277
2278 if (lhs->lhs_type == NULL
2279 || (use_class ? lhs->lhs_type->tt_class == NULL
2280 : lhs->lhs_type->tt_member == NULL))
2281 {
2282 lhs->lhs_member_type = &t_any;
2283 }
2284 else if (use_class)
2285 {
2286 // for an object or class member get the type of the member
2287 if (compile_lhs_set_oc_member_type(cctx, lhs, var_start) == FAIL)
2288 return FAIL;
2289 }
2290 else
2291 lhs->lhs_member_type = lhs->lhs_type->tt_member;
2292
2293 return OK;
2294}
2295
2296/*
2297 * Figure out the LHS type and other properties for an assignment or one item
2298 * of ":unlet" with an index.
2299 * Returns OK or FAIL.
2300 */
2301 int
2302compile_lhs(
2303 char_u *var_start,
2304 lhs_T *lhs,
2305 cmdidx_T cmdidx,
2306 int heredoc,
2307 int has_cmd, // "var" before "var_start"
2308 int oplen,
2309 cctx_T *cctx)
2310{
Yegappan Lakshmanan59c88802024-12-19 20:00:31 +01002311 char_u *var_end = NULL;
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01002312 int is_decl = is_decl_command(cmdidx);
2313
2314 if (lhs_init(lhs, var_start, is_decl, heredoc, &var_end) == FAIL)
2315 return FAIL;
2316
2317 if (cctx->ctx_skip != SKIP_YES)
2318 {
2319 // compile the LHS destination
2320 if (compile_lhs_var_dest(cctx, lhs, cmdidx, var_start, var_end,
2321 is_decl) == FAIL)
2322 return FAIL;
Bram Moolenaar752fc692021-01-04 21:57:11 +01002323 }
2324
Bram Moolenaarab36e6a2021-11-30 16:14:49 +00002325 // handle "a:name" as a name, not index "name" in "a"
Bram Moolenaar752fc692021-01-04 21:57:11 +01002326 if (lhs->lhs_varlen > 1 || var_start[lhs->lhs_varlen] != ':')
2327 var_end = lhs->lhs_dest_end;
2328
Bram Moolenaardcb53be2021-12-09 14:23:43 +00002329 if (lhs->lhs_dest != dest_option && lhs->lhs_dest != dest_func_option)
Bram Moolenaar752fc692021-01-04 21:57:11 +01002330 {
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01002331 // set the LHS variable type
2332 if (compile_lhs_set_type(cctx, lhs, var_end, is_decl) == FAIL)
2333 return FAIL;
Bram Moolenaar752fc692021-01-04 21:57:11 +01002334 }
2335
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01002336 if (oplen == 3 && !heredoc && !lhs_concatenable(lhs))
Bram Moolenaar752fc692021-01-04 21:57:11 +01002337 {
2338 emsg(_(e_can_only_concatenate_to_string));
2339 return FAIL;
2340 }
2341
2342 if (lhs->lhs_lvar == NULL && lhs->lhs_dest == dest_local
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01002343 && cctx->ctx_skip != SKIP_YES)
Bram Moolenaar752fc692021-01-04 21:57:11 +01002344 {
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01002345 if (compile_lhs_new_local_var(cctx, lhs, var_start, cmdidx, oplen,
2346 is_decl, has_cmd, heredoc) == FAIL)
Bram Moolenaar752fc692021-01-04 21:57:11 +01002347 return FAIL;
Bram Moolenaar752fc692021-01-04 21:57:11 +01002348 }
2349
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01002350 if (compile_lhs_set_member_type(cctx, lhs, var_start, is_decl, has_cmd)
2351 == FAIL)
2352 return FAIL;
Bram Moolenaarc750d912021-11-29 22:02:12 +00002353
Bram Moolenaar752fc692021-01-04 21:57:11 +01002354 return OK;
2355}
2356
2357/*
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002358 * Figure out the LHS and check a few errors.
2359 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +00002360 int
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002361compile_assign_lhs(
Bram Moolenaar97f8c102022-04-02 19:43:57 +01002362 char_u *var_start,
2363 lhs_T *lhs,
2364 cmdidx_T cmdidx,
2365 int is_decl,
2366 int heredoc,
2367 int has_cmd, // "var" before "var_start"
2368 int oplen,
2369 cctx_T *cctx)
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002370{
Bram Moolenaar97f8c102022-04-02 19:43:57 +01002371 if (compile_lhs(var_start, lhs, cmdidx, heredoc, has_cmd, oplen, cctx)
2372 == FAIL)
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002373 return FAIL;
2374
2375 if (!lhs->lhs_has_index && lhs->lhs_lvar == &lhs->lhs_arg_lvar)
2376 {
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00002377 semsg(_(e_cannot_assign_to_argument_str), lhs->lhs_name);
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002378 return FAIL;
2379 }
2380 if (!is_decl && lhs->lhs_lvar != NULL
Bram Moolenaar6586a012022-09-30 11:04:50 +01002381 && lhs->lhs_lvar->lv_const != ASSIGN_VAR
2382 && !lhs->lhs_has_index)
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002383 {
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00002384 semsg(_(e_cannot_assign_to_constant_str), lhs->lhs_name);
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002385 return FAIL;
2386 }
2387 return OK;
2388}
2389
2390/*
Bram Moolenaar4f0884d2021-08-11 21:49:23 +02002391 * Return TRUE if "lhs" has a range index: "[expr : expr]".
2392 */
2393 static int
2394has_list_index(char_u *idx_start, cctx_T *cctx)
2395{
2396 char_u *p = idx_start;
2397 int save_skip;
2398
2399 if (*p != '[')
2400 return FALSE;
2401
2402 p = skipwhite(p + 1);
2403 if (*p == ':')
2404 return TRUE;
2405
2406 save_skip = cctx->ctx_skip;
2407 cctx->ctx_skip = SKIP_YES;
2408 (void)compile_expr0(&p, cctx);
2409 cctx->ctx_skip = save_skip;
2410 return *skipwhite(p) == ':';
2411}
2412
2413/*
Bram Moolenaare42939a2021-04-05 17:11:17 +02002414 * For an assignment with an index, compile the "idx" in "var[idx]" or "key" in
2415 * "var.key".
Bram Moolenaar752fc692021-01-04 21:57:11 +01002416 */
2417 static int
Bram Moolenaare42939a2021-04-05 17:11:17 +02002418compile_assign_index(
Bram Moolenaar752fc692021-01-04 21:57:11 +01002419 char_u *var_start,
2420 lhs_T *lhs,
Bram Moolenaare42939a2021-04-05 17:11:17 +02002421 int *range,
Bram Moolenaar752fc692021-01-04 21:57:11 +01002422 cctx_T *cctx)
2423{
Bram Moolenaar752fc692021-01-04 21:57:11 +01002424 size_t varlen = lhs->lhs_varlen;
Bram Moolenaare42939a2021-04-05 17:11:17 +02002425 char_u *p;
2426 int r = OK;
Bram Moolenaar68452172021-04-12 21:21:02 +02002427 int need_white_before = TRUE;
2428 int empty_second;
Bram Moolenaar752fc692021-01-04 21:57:11 +01002429
Bram Moolenaar752fc692021-01-04 21:57:11 +01002430 p = var_start + varlen;
2431 if (*p == '[')
2432 {
2433 p = skipwhite(p + 1);
Bram Moolenaar68452172021-04-12 21:21:02 +02002434 if (*p == ':')
2435 {
2436 // empty first index, push zero
2437 r = generate_PUSHNR(cctx, 0);
2438 need_white_before = FALSE;
2439 }
2440 else
2441 r = compile_expr0(&p, cctx);
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002442
2443 if (r == OK && *skipwhite(p) == ':')
2444 {
2445 // unlet var[idx : idx]
Bram Moolenaar68452172021-04-12 21:21:02 +02002446 // blob[idx : idx] = value
Bram Moolenaare42939a2021-04-05 17:11:17 +02002447 *range = TRUE;
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002448 p = skipwhite(p);
Bram Moolenaar68452172021-04-12 21:21:02 +02002449 empty_second = *skipwhite(p + 1) == ']';
2450 if ((need_white_before && !IS_WHITE_OR_NUL(p[-1]))
2451 || (!empty_second && !IS_WHITE_OR_NUL(p[1])))
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002452 {
2453 semsg(_(e_white_space_required_before_and_after_str_at_str),
2454 ":", p);
2455 return FAIL;
2456 }
2457 p = skipwhite(p + 1);
Bram Moolenaar68452172021-04-12 21:21:02 +02002458 if (*p == ']')
2459 // empty second index, push "none"
2460 r = generate_PUSHSPEC(cctx, VVAL_NONE);
2461 else
2462 r = compile_expr0(&p, cctx);
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002463 }
2464
Bram Moolenaar752fc692021-01-04 21:57:11 +01002465 if (r == OK && *skipwhite(p) != ']')
2466 {
2467 // this should not happen
Bram Moolenaare1242042021-12-16 20:56:57 +00002468 emsg(_(e_missing_closing_square_brace));
Bram Moolenaar752fc692021-01-04 21:57:11 +01002469 r = FAIL;
2470 }
2471 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002472 else if (lhs->lhs_member_idx >= 0)
2473 {
2474 // object member index
2475 r = generate_PUSHNR(cctx, lhs->lhs_member_idx);
2476 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01002477 else // if (*p == '.')
2478 {
2479 char_u *key_end = to_name_end(p + 1, TRUE);
2480 char_u *key = vim_strnsave(p + 1, key_end - p - 1);
2481
Zdenek Dohnal9fe17d42021-08-04 22:30:52 +02002482 r = generate_PUSHS(cctx, &key);
Bram Moolenaar752fc692021-01-04 21:57:11 +01002483 }
Bram Moolenaare42939a2021-04-05 17:11:17 +02002484 return r;
2485}
2486
2487/*
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002488 * For a LHS with an index, load the variable to be indexed.
2489 */
2490 static int
2491compile_load_lhs(
2492 lhs_T *lhs,
2493 char_u *var_start,
2494 type_T *rhs_type,
2495 cctx_T *cctx)
2496{
2497 if (lhs->lhs_dest == dest_expr)
2498 {
2499 size_t varlen = lhs->lhs_varlen;
2500 int c = var_start[varlen];
Bram Moolenaare97976b2021-08-01 13:17:17 +02002501 int lines_len = cctx->ctx_ufunc->uf_lines.ga_len;
Bram Moolenaare97976b2021-08-01 13:17:17 +02002502 int res;
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002503
Bram Moolenaare97976b2021-08-01 13:17:17 +02002504 // Evaluate "ll[expr]" of "ll[expr][idx]". End the line with a NUL and
2505 // limit the lines array length to avoid skipping to a following line.
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002506 var_start[varlen] = NUL;
Bram Moolenaare97976b2021-08-01 13:17:17 +02002507 cctx->ctx_ufunc->uf_lines.ga_len = cctx->ctx_lnum + 1;
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002508 char_u *p = var_start;
Bram Moolenaare97976b2021-08-01 13:17:17 +02002509 res = compile_expr0(&p, cctx);
2510 var_start[varlen] = c;
2511 cctx->ctx_ufunc->uf_lines.ga_len = lines_len;
2512 if (res == FAIL || p != var_start + varlen)
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002513 {
2514 // this should not happen
Bram Moolenaare97976b2021-08-01 13:17:17 +02002515 if (res != FAIL)
Bram Moolenaare1242042021-12-16 20:56:57 +00002516 emsg(_(e_missing_closing_square_brace));
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002517 return FAIL;
2518 }
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002519
Bram Moolenaar078a4612022-01-04 15:17:03 +00002520 lhs->lhs_type = cctx->ctx_type_stack.ga_len == 0 ? &t_void
2521 : get_type_on_stack(cctx, 0);
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02002522
Yegappan Lakshmanan54d7f182025-02-10 21:35:07 +01002523 if (lhs->lhs_type->tt_type == VAR_CLASS
2524 || lhs->lhs_type->tt_type == VAR_OBJECT)
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02002525 {
Yegappan Lakshmanan54d7f182025-02-10 21:35:07 +01002526 // Check whether the class or object variable is modifiable
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02002527 if (!lhs_class_member_modifiable(lhs, var_start, cctx))
2528 return FAIL;
2529 }
2530
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002531 // Now we can properly check the type. The variable is indexed, thus
2532 // we need the member type. For a class or object we don't know the
2533 // type yet, it depends on what member is used.
Yegappan Lakshmananc229a6a2023-10-26 23:05:07 +02002534 // The top item in the stack is the Dict, followed by the key and then
2535 // the type of the value.
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002536 vartype_T vartype = lhs->lhs_type->tt_type;
2537 type_T *member_type = lhs->lhs_type->tt_member;
2538 if (rhs_type != NULL && member_type != NULL
2539 && vartype != VAR_OBJECT && vartype != VAR_CLASS
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002540 && rhs_type != &t_void
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002541 && need_type(rhs_type, member_type, FALSE,
Yegappan Lakshmananc229a6a2023-10-26 23:05:07 +02002542 -3, 0, cctx, FALSE, FALSE) == FAIL)
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002543 return FAIL;
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02002544
2545 return OK;
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002546 }
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02002547
2548 return generate_loadvar(cctx, lhs);
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002549}
2550
2551/*
Bram Moolenaara369c3d2021-04-21 16:00:10 +02002552 * Produce code for loading "lhs" and also take care of an index.
2553 * Return OK/FAIL.
2554 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +00002555 int
Bram Moolenaara369c3d2021-04-21 16:00:10 +02002556compile_load_lhs_with_index(lhs_T *lhs, char_u *var_start, cctx_T *cctx)
2557{
Bram Moolenaar4cae8452023-01-15 15:51:48 +00002558 if (lhs->lhs_type->tt_type == VAR_OBJECT)
2559 {
Bram Moolenaar22363c62023-04-24 17:15:25 +01002560 // "this.value": load "this" object and get the value at index for an
2561 // object or class member get the type of the member.
2562 // Also for "obj.value".
Yegappan Lakshmananff6f0d52023-12-21 16:46:18 +01002563 char_u *dot = vim_strchr(var_start, '.');
2564 if (dot == NULL)
2565 {
2566 semsg(_(e_missing_dot_after_object_str), lhs->lhs_name);
2567 return FAIL;
2568 }
Bram Moolenaar22363c62023-04-24 17:15:25 +01002569
Yegappan Lakshmananeb91e242023-08-31 18:10:46 +02002570 class_T *cl = lhs->lhs_type->tt_class;
Yegappan Lakshmanan1ea42882023-10-11 21:43:52 +02002571 type_T *type = oc_member_type(cl, TRUE, dot + 1,
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02002572 lhs->lhs_end, &lhs->lhs_member_idx);
Bram Moolenaar4cae8452023-01-15 15:51:48 +00002573 if (lhs->lhs_member_idx < 0)
2574 return FAIL;
2575
Bram Moolenaar22363c62023-04-24 17:15:25 +01002576 if (dot - var_start == 4 && STRNCMP(var_start, "this", 4) == 0)
2577 {
2578 // load "this"
Yegappan Lakshmanand990bf02024-03-22 19:56:17 +01002579 lvar_T *lvar = lhs->lhs_lvar;
2580 int rc;
2581
2582 if (lvar->lv_from_outer > 0)
2583 rc = generate_LOADOUTER(cctx, lvar->lv_idx,
2584 lvar->lv_from_outer, lvar->lv_loop_depth,
2585 lvar->lv_loop_idx, type);
2586 else
2587 rc = generate_LOAD(cctx, ISN_LOAD, lvar->lv_idx, NULL, type);
2588
2589 if (rc == FAIL)
Bram Moolenaar22363c62023-04-24 17:15:25 +01002590 return FAIL;
2591 }
2592 else
2593 {
2594 // load object variable or argument
2595 if (compile_load_lhs(lhs, var_start, lhs->lhs_type, cctx) == FAIL)
2596 return FAIL;
2597 }
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002598 if (IS_INTERFACE(cl))
Yegappan Lakshmanan5a05d372023-09-29 19:43:11 +02002599 return generate_GET_ITF_MEMBER(cctx, cl, lhs->lhs_member_idx, type);
2600 return generate_GET_OBJ_MEMBER(cctx, lhs->lhs_member_idx, type);
Bram Moolenaar4cae8452023-01-15 15:51:48 +00002601 }
Yegappan Lakshmanan1ea42882023-10-11 21:43:52 +02002602 else if (lhs->lhs_type->tt_type == VAR_CLASS)
2603 {
2604 // "<classname>.value": load class variable "classname.value"
Yegappan Lakshmananff6f0d52023-12-21 16:46:18 +01002605 char_u *dot = vim_strchr(var_start, '.');
2606 if (dot == NULL)
2607 {
2608 check_type_is_value(lhs->lhs_type);
2609 return FAIL;
2610 }
Yegappan Lakshmanan1ea42882023-10-11 21:43:52 +02002611
2612 class_T *cl = lhs->lhs_type->tt_class;
2613 ocmember_T *m = class_member_lookup(cl, dot + 1,
2614 lhs->lhs_end - dot - 1,
2615 &lhs->lhs_member_idx);
2616 if (m == NULL)
2617 return FAIL;
2618
2619 return generate_CLASSMEMBER(cctx, TRUE, cl, lhs->lhs_member_idx);
2620 }
Bram Moolenaar4cae8452023-01-15 15:51:48 +00002621
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02002622 if (compile_load_lhs(lhs, var_start, NULL, cctx) == FAIL)
2623 return FAIL;
Bram Moolenaara369c3d2021-04-21 16:00:10 +02002624
2625 if (lhs->lhs_has_index)
2626 {
2627 int range = FALSE;
2628
2629 // Get member from list or dict. First compile the
2630 // index value.
2631 if (compile_assign_index(var_start, lhs, &range, cctx) == FAIL)
2632 return FAIL;
2633 if (range)
2634 {
2635 semsg(_(e_cannot_use_range_with_assignment_operator_str),
2636 var_start);
2637 return FAIL;
2638 }
2639
2640 // Get the member.
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02002641 if (compile_member(FALSE, NULL, cctx) == FAIL)
Bram Moolenaara369c3d2021-04-21 16:00:10 +02002642 return FAIL;
2643 }
2644 return OK;
2645}
2646
2647/*
Bram Moolenaare42939a2021-04-05 17:11:17 +02002648 * Assignment to a list or dict member, or ":unlet" for the item, using the
2649 * information in "lhs".
2650 * Returns OK or FAIL.
2651 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +00002652 int
Bram Moolenaare42939a2021-04-05 17:11:17 +02002653compile_assign_unlet(
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002654 char_u *var_start,
2655 lhs_T *lhs,
2656 int is_assign,
2657 type_T *rhs_type,
2658 cctx_T *cctx)
Bram Moolenaare42939a2021-04-05 17:11:17 +02002659{
Bram Moolenaare42939a2021-04-05 17:11:17 +02002660 vartype_T dest_type;
Bram Moolenaare42939a2021-04-05 17:11:17 +02002661 int range = FALSE;
2662
Bram Moolenaar68452172021-04-12 21:21:02 +02002663 if (compile_assign_index(var_start, lhs, &range, cctx) == FAIL)
Bram Moolenaar752fc692021-01-04 21:57:11 +01002664 return FAIL;
Bram Moolenaar4f0884d2021-08-11 21:49:23 +02002665 if (is_assign && range
2666 && lhs->lhs_type->tt_type != VAR_LIST
2667 && lhs->lhs_type != &t_blob
2668 && lhs->lhs_type != &t_any)
Bram Moolenaar68452172021-04-12 21:21:02 +02002669 {
2670 semsg(_(e_cannot_use_range_with_assignment_str), var_start);
2671 return FAIL;
2672 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01002673
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002674 if (lhs->lhs_type == NULL || lhs->lhs_type == &t_any)
Bram Moolenaar752fc692021-01-04 21:57:11 +01002675 {
2676 // Index on variable of unknown type: check at runtime.
2677 dest_type = VAR_ANY;
2678 }
2679 else
2680 {
2681 dest_type = lhs->lhs_type->tt_type;
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002682 if (dest_type == VAR_DICT && range)
2683 {
zeertzjq276410e2023-05-07 21:59:33 +01002684 emsg(_(e_cannot_use_range_with_dictionary));
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002685 return FAIL;
2686 }
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02002687 if (dest_type == VAR_DICT
Yegappan Lakshmananbce51d92024-04-15 19:19:52 +02002688 && may_generate_2STRING(-1, TOSTRING_NONE, cctx) == FAIL)
Bram Moolenaar752fc692021-01-04 21:57:11 +01002689 return FAIL;
Bram Moolenaar51e93322021-04-17 20:44:56 +02002690 if (dest_type == VAR_LIST || dest_type == VAR_BLOB)
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002691 {
Bram Moolenaar51e93322021-04-17 20:44:56 +02002692 type_T *type;
2693
2694 if (range)
2695 {
Bram Moolenaar078a4612022-01-04 15:17:03 +00002696 type = get_type_on_stack(cctx, 1);
Bram Moolenaarc6951a72022-12-29 20:56:24 +00002697 if (need_type(type, &t_number, FALSE,
Bram Moolenaar2995e5c2022-03-18 21:41:47 +00002698 -2, 0, cctx, FALSE, FALSE) == FAIL)
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002699 return FAIL;
Bram Moolenaar51e93322021-04-17 20:44:56 +02002700 }
Bram Moolenaar078a4612022-01-04 15:17:03 +00002701 type = get_type_on_stack(cctx, 0);
Bram Moolenaar53ba6ca2022-03-10 19:23:28 +00002702 if ((dest_type != VAR_BLOB && type->tt_type != VAR_SPECIAL)
Bram Moolenaarc6951a72022-12-29 20:56:24 +00002703 && need_type(type, &t_number, FALSE,
Bram Moolenaar51e93322021-04-17 20:44:56 +02002704 -1, 0, cctx, FALSE, FALSE) == FAIL)
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002705 return FAIL;
2706 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01002707 }
2708
Bram Moolenaar4875d6a2022-08-17 15:55:51 +01002709 if (cctx->ctx_skip == SKIP_YES)
2710 return OK;
2711
Bram Moolenaar22363c62023-04-24 17:15:25 +01002712 // Load the dict, list or object. On the stack we then have:
Bram Moolenaar752fc692021-01-04 21:57:11 +01002713 // - value (for assignment, not for :unlet)
2714 // - index
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002715 // - for [a : b] second index
Bram Moolenaar752fc692021-01-04 21:57:11 +01002716 // - variable
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002717 if (compile_load_lhs(lhs, var_start, rhs_type, cctx) == FAIL)
2718 return FAIL;
Bram Moolenaar752fc692021-01-04 21:57:11 +01002719
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002720 if (dest_type == VAR_LIST
2721 || dest_type == VAR_DICT
2722 || dest_type == VAR_BLOB
2723 || dest_type == VAR_CLASS
2724 || dest_type == VAR_OBJECT
2725 || dest_type == VAR_ANY)
Bram Moolenaar752fc692021-01-04 21:57:11 +01002726 {
2727 if (is_assign)
2728 {
Bram Moolenaar68452172021-04-12 21:21:02 +02002729 if (range)
2730 {
2731 if (generate_instr_drop(cctx, ISN_STORERANGE, 4) == NULL)
2732 return FAIL;
2733 }
2734 else
2735 {
2736 isn_T *isn = generate_instr_drop(cctx, ISN_STOREINDEX, 3);
Bram Moolenaar752fc692021-01-04 21:57:11 +01002737
Bram Moolenaar68452172021-04-12 21:21:02 +02002738 if (isn == NULL)
2739 return FAIL;
Bram Moolenaarf7d1c6e2023-01-16 20:47:57 +00002740 isn->isn_arg.storeindex.si_vartype = dest_type;
2741 isn->isn_arg.storeindex.si_class = NULL;
2742
2743 if (dest_type == VAR_OBJECT)
2744 {
Bram Moolenaarb1e32ac2023-02-21 12:38:51 +00002745 class_T *cl = lhs->lhs_type->tt_class;
Bram Moolenaarf7d1c6e2023-01-16 20:47:57 +00002746
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002747 if (IS_INTERFACE(cl))
Bram Moolenaarf7d1c6e2023-01-16 20:47:57 +00002748 {
2749 // "this.value": load "this" object and get the value
2750 // at index for an object or class member get the type
2751 // of the member
2752 isn->isn_arg.storeindex.si_class = cl;
2753 ++cl->class_refcount;
2754 }
2755 }
Bram Moolenaar68452172021-04-12 21:21:02 +02002756 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01002757 }
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002758 else if (range)
2759 {
2760 if (generate_instr_drop(cctx, ISN_UNLETRANGE, 3) == NULL)
2761 return FAIL;
2762 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01002763 else
2764 {
2765 if (generate_instr_drop(cctx, ISN_UNLETINDEX, 2) == NULL)
2766 return FAIL;
2767 }
2768 }
2769 else
2770 {
2771 emsg(_(e_indexable_type_required));
2772 return FAIL;
2773 }
2774
2775 return OK;
2776}
2777
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01002778/*
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00002779 * Generate an instruction to push the default value for "vartype".
2780 * if "dest_local" is TRUE then for some types no instruction is generated.
2781 * "skip_store" is set to TRUE if no PUSH instruction is generated.
2782 * Returns OK or FAIL.
2783 */
2784 static int
2785push_default_value(
2786 cctx_T *cctx,
2787 vartype_T vartype,
2788 int dest_is_local,
2789 int *skip_store)
2790{
2791 int r = OK;
2792
2793 switch (vartype)
2794 {
2795 case VAR_BOOL:
2796 r = generate_PUSHBOOL(cctx, VVAL_FALSE);
2797 break;
2798 case VAR_FLOAT:
2799 r = generate_PUSHF(cctx, 0.0);
2800 break;
2801 case VAR_STRING:
2802 r = generate_PUSHS(cctx, NULL);
2803 break;
2804 case VAR_BLOB:
2805 r = generate_PUSHBLOB(cctx, blob_alloc());
2806 break;
2807 case VAR_FUNC:
2808 r = generate_PUSHFUNC(cctx, NULL, &t_func_void, TRUE);
2809 break;
2810 case VAR_LIST:
2811 r = generate_NEWLIST(cctx, 0, FALSE);
2812 break;
2813 case VAR_DICT:
2814 r = generate_NEWDICT(cctx, 0, FALSE);
2815 break;
2816 case VAR_JOB:
2817 r = generate_PUSHJOB(cctx);
2818 break;
2819 case VAR_CHANNEL:
2820 r = generate_PUSHCHANNEL(cctx);
2821 break;
Ernie Rael5c018be2023-08-27 18:40:26 +02002822 case VAR_OBJECT:
2823 r = generate_PUSHOBJ(cctx);
2824 break;
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00002825 case VAR_NUMBER:
2826 case VAR_UNKNOWN:
2827 case VAR_ANY:
2828 case VAR_PARTIAL:
2829 case VAR_VOID:
2830 case VAR_INSTR:
2831 case VAR_CLASS:
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02002832 case VAR_TYPEALIAS:
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00002833 case VAR_SPECIAL: // cannot happen
2834 // This is skipped for local variables, they are always
2835 // initialized to zero. But in a "for" or "while" loop
2836 // the value may have been changed.
2837 if (dest_is_local && !inside_loop_scope(cctx))
2838 *skip_store = TRUE;
2839 else
2840 r = generate_PUSHNR(cctx, 0);
2841 break;
2842 }
2843 return r;
2844}
2845
2846/*
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002847 * Compile assignment context. Used when compiling an assignment statement.
2848 */
2849typedef struct cac_S cac_T;
2850struct cac_S
2851{
2852 cmdidx_T cac_cmdidx; // assignment command
2853 char_u *cac_nextc; // next character to parse
2854 lhs_T cac_lhs; // lhs of the assignment
2855 type_T *cac_rhs_type; // rhs type of an assignment
2856 char_u *cac_op; // assignment operator
2857 int cac_oplen; // assignment operator length
2858 char_u *cac_var_start; // start of the variable names
2859 char_u *cac_var_end; // end of the variable names
2860 int cac_var_count; // number of variables in assignment
2861 int cac_var_idx; // variable index in a list
2862 int cac_semicolon; // semicolon in [var1, var2; var3]
2863 garray_T *cac_instr;
2864 int cac_instr_count;
2865 int cac_incdec;
2866 int cac_did_generate_slice;
2867 int cac_is_decl;
2868 int cac_is_const;
2869 int cac_start_lnum;
2870 type_T *cac_inferred_type;
2871 int cac_skip_store;
2872};
2873
2874/*
2875 * Initialize the compile assignment context.
2876 */
2877 static void
2878compile_assign_context_init(cac_T *cac, cctx_T *cctx, int cmdidx, char_u *arg)
2879{
2880 CLEAR_FIELD(*cac);
2881 cac->cac_cmdidx = cmdidx;
2882 cac->cac_instr = &cctx->ctx_instr;
2883 cac->cac_rhs_type = &t_any;
2884 cac->cac_is_decl = is_decl_command(cmdidx);
2885 cac->cac_start_lnum = SOURCING_LNUM;
2886 cac->cac_instr_count = -1;
2887 cac->cac_var_end = arg;
2888}
2889
2890/*
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01002891 * Compile an object member variable assignment in the arguments passed to a
2892 * class new() method.
2893 *
2894 * Instruction format:
2895 *
2896 * ifargisset <n> this.<varname> = <value>
2897 *
2898 * where <n> is the index of the default argument.
2899 *
2900 * Generates the ISN_JUMP_IF_ARG_NOT_SET instruction to skip the assignment if
2901 * the value is passed as an argument to the new() method call.
2902 *
2903 * Returns OK on success.
2904 */
2905 static int
2906compile_assign_obj_new_arg(char_u **argp, cctx_T *cctx)
2907{
2908 char_u *arg = *argp;
2909
2910 arg += 11; // skip "ifargisset"
2911 int def_arg_idx = getdigits(&arg);
2912 arg = skipwhite(arg);
2913
2914 // Use a JUMP_IF_ARG_NOT_SET instruction to skip if the value was not
2915 // given and the default value is "v:none".
2916 int stack_offset = STACK_FRAME_SIZE +
2917 (cctx->ctx_ufunc->uf_va_name != NULL ? 1 : 0);
2918 int def_arg_count = cctx->ctx_ufunc->uf_def_args.ga_len;
2919 int arg_offset = def_arg_idx - def_arg_count - stack_offset;
2920
2921 if (generate_JUMP_IF_ARG(cctx, ISN_JUMP_IF_ARG_NOT_SET,
2922 arg_offset) == FAIL)
2923 return FAIL;
2924
2925 *argp = arg;
2926 return OK;
2927}
2928
2929/*
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002930 * Translate the increment (++) and decrement (--) operators to the
2931 * corresponding compound operators (+= or -=).
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01002932 *
2933 * Returns OK on success and FAIL on syntax error.
2934 */
2935 static int
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002936translate_incdec_op(exarg_T *eap, cac_T *cac)
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01002937{
2938 if (VIM_ISWHITE(eap->cmd[2]))
2939 {
2940 semsg(_(e_no_white_space_allowed_after_str_str),
2941 eap->cmdidx == CMD_increment ? "++" : "--", eap->cmd);
2942 return FAIL;
2943 }
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002944 cac->cac_op = (char_u *)(eap->cmdidx == CMD_increment ? "+=" : "-=");
2945 cac->cac_oplen = 2;
2946 cac->cac_incdec = TRUE;
2947
2948 return OK;
2949}
2950
2951/*
2952 * Process the operator in an assignment statement.
2953 */
2954 static int
2955compile_assign_process_operator(
2956 exarg_T *eap,
2957 char_u *arg,
2958 cac_T *cac,
2959 int *heredoc,
2960 char_u **retstr)
2961{
2962 *retstr = NULL;
2963
2964 if (eap->cmdidx == CMD_increment || eap->cmdidx == CMD_decrement)
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002965 // Change an unary operator to a compound operator
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01002966 return translate_incdec_op(eap, cac);
2967
2968 char_u *sp = cac->cac_nextc;
2969 cac->cac_nextc = skipwhite(cac->cac_nextc);
2970 cac->cac_op = cac->cac_nextc;
2971 cac->cac_oplen = assignment_len(cac->cac_nextc, heredoc);
2972
2973 if (cac->cac_var_count > 0 && cac->cac_oplen == 0)
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002974 {
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01002975 // can be something like "[1, 2]->func()"
2976 *retstr = arg;
2977 return FAIL;
2978 }
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002979
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01002980 // need white space before and after the operator
2981 if (cac->cac_oplen > 0 && (!VIM_ISWHITE(*sp)
2982 || !IS_WHITE_OR_NUL(cac->cac_op[cac->cac_oplen])))
2983 {
2984 error_white_both(cac->cac_op, cac->cac_oplen);
2985 return FAIL;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002986 }
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01002987
2988 return OK;
2989}
2990
2991/*
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01002992 * Find the start of an assignment statement.
2993 */
2994 static char_u *
2995compile_assign_compute_start(char_u *arg, int var_count)
2996{
2997 if (var_count > 0)
2998 // [var1, var2] = [val1, val2]
2999 // skip over the "["
3000 return skipwhite(arg + 1);
3001
3002 return arg;
3003}
3004
3005/*
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01003006 * Parse a heredoc assignment starting at "p". Returns a pointer to the
3007 * beginning of the heredoc content.
3008 */
3009 static char_u *
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003010parse_heredoc_assignment(exarg_T *eap, cctx_T *cctx, cac_T *cac)
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01003011{
3012 // [let] varname =<< [trim] {end}
3013 eap->ea_getline = exarg_getline;
3014 eap->cookie = cctx;
3015
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003016 list_T *l = heredoc_get(eap, cac->cac_nextc + 3, FALSE, TRUE);
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01003017 if (l == NULL)
3018 return NULL;
3019
3020 list_free(l);
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003021 cac->cac_nextc += STRLEN(cac->cac_nextc);
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01003022
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003023 return cac->cac_nextc;
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01003024}
3025
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003026/*
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003027 * Check the type of a RHS expression in a list assignment statement.
3028 * The RHS expression is already compiled. So the type is on the stack.
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003029 */
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003030 static int
3031compile_assign_list_check_rhs_type(cctx_T *cctx, cac_T *cac)
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01003032{
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003033 type_T *stacktype;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003034
3035 stacktype = cctx->ctx_type_stack.ga_len == 0 ? &t_void
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01003036 : get_type_on_stack(cctx, 0);
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003037 if (stacktype->tt_type == VAR_VOID)
3038 {
3039 emsg(_(e_cannot_use_void_value));
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003040 return FAIL;
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01003041 }
3042
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003043 if (need_type(stacktype, &t_list_any, FALSE, -1, 0, cctx,
3044 FALSE, FALSE) == FAIL)
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003045 return FAIL;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003046
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003047 if (stacktype->tt_member != NULL)
3048 cac->cac_rhs_type = stacktype->tt_member;
3049
3050 return OK;
3051}
3052
3053/*
3054 * In a list assignment statement, if a constant list was used, check the
3055 * length. Returns OK if the length check succeeds. Returns FAIL otherwise.
3056 */
3057 static int
3058compile_assign_list_check_length(cctx_T *cctx, cac_T *cac)
3059{
3060 int needed_list_len;
3061 int did_check = FALSE;
3062
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003063 needed_list_len = cac->cac_semicolon
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003064 ? cac->cac_var_count - 1
3065 : cac->cac_var_count;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003066 if (cac->cac_instr->ga_len > 0)
3067 {
3068 isn_T *isn = ((isn_T *)cac->cac_instr->ga_data) +
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003069 cac->cac_instr->ga_len - 1;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003070
3071 if (isn->isn_type == ISN_NEWLIST)
3072 {
3073 did_check = TRUE;
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003074 if (cac->cac_semicolon ?
3075 isn->isn_arg.number < needed_list_len
3076 : isn->isn_arg.number != needed_list_len)
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003077 {
3078 semsg(_(e_expected_nr_items_but_got_nr),
3079 needed_list_len, (int)isn->isn_arg.number);
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003080 return FAIL;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003081 }
3082 }
3083 }
3084
3085 if (!did_check)
3086 generate_CHECKLEN(cctx, needed_list_len, cac->cac_semicolon);
3087
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003088 return OK;
3089}
3090
3091/*
3092 * Evaluate the expression for "[var, var] = expr" assignment.
3093 * A line break may follow the assignment operator "=".
3094 */
3095 static char_u *
3096compile_assign_list_expr(cctx_T *cctx, cac_T *cac)
3097{
3098 char_u *whitep;
3099
3100 whitep = cac->cac_op + cac->cac_oplen;
3101
3102 if (may_get_next_line_error(whitep, &cac->cac_nextc, cctx) == FAIL)
3103 return NULL;
3104
3105 // compile RHS expression
3106 if (compile_expr0(&cac->cac_nextc, cctx) == FAIL)
3107 return NULL;
3108
3109 if (cctx->ctx_skip == SKIP_YES)
3110 // no need to parse more when skipping
3111 return cac->cac_nextc;
3112
3113 if (compile_assign_list_check_rhs_type(cctx, cac) == FAIL)
3114 return NULL;
3115
3116 // If a constant list was used we can check the length right here.
3117 if (compile_assign_list_check_length(cctx, cac) == FAIL)
3118 return FAIL;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003119
3120 return cac->cac_nextc;
3121}
3122
3123/*
3124 * Find and return the end of a heredoc or a list of variables assignment
3125 * statement. For a single variable assignment statement, returns the current
3126 * end.
3127 * Returns NULL on failure.
3128 */
3129 static char_u *
3130compile_assign_compute_end(
3131 exarg_T *eap,
3132 cctx_T *cctx,
3133 cac_T *cac,
3134 int heredoc)
3135{
3136 if (heredoc)
3137 {
3138 cac->cac_nextc = parse_heredoc_assignment(eap, cctx, cac);
3139 return cac->cac_nextc;
3140 }
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003141
3142 if (cac->cac_var_count > 0)
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003143 {
3144 // for "[var, var] = expr" evaluate the expression. The list of
3145 // variables are processed later.
3146 // A line break may follow the "=".
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003147 cac->cac_nextc = compile_assign_list_expr(cctx, cac);
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003148 return cac->cac_nextc;
3149 }
3150
3151 return cac->cac_var_end;
3152}
3153
3154/*
3155 * For "var = expr" evaluate the expression.
3156 */
3157 static int
3158compile_assign_single_eval_expr(cctx_T *cctx, cac_T *cac)
3159{
3160 int ret = OK;
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003161 char_u *whitep;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003162 lhs_T *lhs = &cac->cac_lhs;
3163
3164 // Compile the expression.
3165 if (cac->cac_incdec)
3166 return generate_PUSHNR(cctx, 1);
3167
3168 // Temporarily hide the new local variable here, it is
3169 // not available to this expression.
3170 if (lhs->lhs_new_local)
3171 --cctx->ctx_locals.ga_len;
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003172 whitep = cac->cac_op + cac->cac_oplen;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003173
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003174 if (may_get_next_line_error(whitep, &cac->cac_nextc, cctx) == FAIL)
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003175 {
3176 if (lhs->lhs_new_local)
3177 ++cctx->ctx_locals.ga_len;
3178 return FAIL;
3179 }
3180
3181 ret = compile_expr0_ext(&cac->cac_nextc, cctx, &cac->cac_is_const);
3182 if (lhs->lhs_new_local)
3183 ++cctx->ctx_locals.ga_len;
3184
3185 return ret;
3186}
3187
3188/*
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003189 * When compiling an assignment, set the LHS type to the RHS type.
3190 */
3191 static int
3192compile_assign_set_lhs_type_from_rhs(
3193 cctx_T *cctx,
3194 cac_T *cac,
3195 lhs_T *lhs,
3196 type_T *rhs_type)
3197{
3198 if (rhs_type->tt_type == VAR_VOID)
3199 {
3200 emsg(_(e_cannot_use_void_value));
3201 return FAIL;
3202 }
3203
3204 type_T *type;
3205
3206 // An empty list or dict has a &t_unknown member, for a variable that
3207 // implies &t_any.
3208 if (rhs_type == &t_list_empty)
3209 type = &t_list_any;
3210 else if (rhs_type == &t_dict_empty)
3211 type = &t_dict_any;
3212 else if (rhs_type == &t_unknown)
3213 type = &t_any;
3214 else
3215 {
3216 type = rhs_type;
3217 cac->cac_inferred_type = rhs_type;
3218 }
3219
3220 set_var_type(lhs->lhs_lvar, type, cctx);
3221
3222 return OK;
3223}
3224
3225/*
3226 * Returns TRUE if the "rhs_type" can be assigned to the "lhs" variable.
3227 * Used when compiling an assignment statement.
3228 */
3229 static int
3230compile_assign_valid_rhs_type(
3231 cctx_T *cctx,
3232 cac_T *cac,
3233 lhs_T *lhs,
3234 type_T *rhs_type)
3235{
3236 type_T *use_type = lhs->lhs_lvar->lv_type;
3237 where_T where = WHERE_INIT;
3238
3239 // Without operator check type here, otherwise below.
3240 // Use the line number of the assignment.
3241 SOURCING_LNUM = cac->cac_start_lnum;
3242 if (cac->cac_var_count > 0)
3243 {
3244 where.wt_index = cac->cac_var_idx + 1;
3245 where.wt_kind = WT_VARIABLE;
3246 }
3247
3248 // If assigning to a list or dict member, use the member type.
3249 // Not for "list[:] =".
3250 if (lhs->lhs_has_index &&
3251 !has_list_index(cac->cac_var_start + lhs->lhs_varlen, cctx))
3252 use_type = lhs->lhs_member_type;
3253
3254 if (need_type_where(rhs_type, use_type, FALSE, -1, where, cctx, FALSE,
3255 cac->cac_is_const) == FAIL)
3256 return FALSE;
3257
3258 return TRUE;
3259}
3260
3261/*
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003262 * Compare the LHS type with the RHS type in an assignment.
3263 */
3264 static int
3265compile_assign_check_type(cctx_T *cctx, cac_T *cac)
3266{
3267 lhs_T *lhs = &cac->cac_lhs;
3268 type_T *rhs_type;
3269
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003270 rhs_type = cctx->ctx_type_stack.ga_len == 0
3271 ? &t_void
3272 : get_type_on_stack(cctx, 0);
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003273 cac->cac_rhs_type = rhs_type;
3274
3275 if (check_type_is_value(rhs_type) == FAIL)
3276 return FAIL;
3277
3278 if (lhs->lhs_lvar != NULL && (cac->cac_is_decl || !lhs->lhs_has_type))
3279 {
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003280 if (rhs_type->tt_type == VAR_FUNC
3281 || rhs_type->tt_type == VAR_PARTIAL)
3282 {
3283 // Make sure the variable name can be used as a funcref
3284 if (!lhs->lhs_has_index
3285 && var_wrong_func_name(lhs->lhs_name, TRUE))
3286 return FAIL;
3287 }
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003288
3289 if (lhs->lhs_new_local && !lhs->lhs_has_type)
3290 {
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003291 // The LHS variable doesn't have a type. Set it to the RHS type.
3292 if (compile_assign_set_lhs_type_from_rhs(cctx, cac, lhs, rhs_type)
3293 == FAIL)
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003294 return FAIL;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003295 }
3296 else if (*cac->cac_op == '=')
3297 {
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003298 if (!compile_assign_valid_rhs_type(cctx, cac, lhs, rhs_type))
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003299 return FAIL;
3300 }
3301 }
3302 else
3303 {
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003304 // Assigning to a register using @r = "abc"
3305
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003306 type_T *lhs_type = lhs->lhs_member_type;
3307
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003308 // Special case: assigning to @# can use a number or a string.
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003309 // Also: can assign a number to a float.
3310 if ((lhs_type == &t_number_or_string || lhs_type == &t_float)
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003311 && rhs_type->tt_type == VAR_NUMBER)
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003312 lhs_type = &t_number;
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003313
3314 if (*cac->cac_nextc != '=')
3315 {
3316 if (need_type(rhs_type, lhs_type, FALSE, -1, 0, cctx, FALSE,
3317 FALSE) == FAIL)
3318 return FAIL;
3319 }
3320 }
3321
3322 return OK;
3323}
3324
3325/*
3326 * Compile the RHS expression in an assignment statement and generate the
3327 * instructions.
3328 */
3329 static int
3330compile_assign_rhs_expr(cctx_T *cctx, cac_T *cac)
3331{
3332 cac->cac_is_const = FALSE;
3333
3334 // for "+=", "*=", "..=" etc. first load the current value
3335 if (*cac->cac_op != '='
3336 && compile_load_lhs_with_index(&cac->cac_lhs, cac->cac_var_start,
3337 cctx) == FAIL)
3338 return FAIL;
3339
3340 // For "var = expr" evaluate the expression.
3341 if (cac->cac_var_count == 0)
3342 {
3343 int ret;
3344
3345 // Compile the expression.
3346 cac->cac_instr_count = cac->cac_instr->ga_len;
3347 ret = compile_assign_single_eval_expr(cctx, cac);
3348 if (ret == FAIL)
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003349 return FAIL;
3350 }
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003351 else if (cac->cac_semicolon && cac->cac_var_idx == cac->cac_var_count - 1)
3352 {
3353 // For "[var; var] = expr" get the rest of the list
3354 cac->cac_did_generate_slice = TRUE;
3355 if (generate_SLICE(cctx, cac->cac_var_count - 1) == FAIL)
3356 return FAIL;
3357 }
3358 else
3359 {
3360 // For "[var, var] = expr" get the "var_idx" item from the
3361 // list.
3362 int with_op = *cac->cac_op != '=';
3363 if (generate_GETITEM(cctx, cac->cac_var_idx, with_op) == FAIL)
3364 return FAIL;
3365 }
3366
3367 if (compile_assign_check_type(cctx, cac) == FAIL)
3368 return FAIL;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003369
3370 return OK;
3371}
3372
3373/*
3374 * Compile the RHS expression in an assignment
3375 */
3376 static int
3377compile_assign_rhs(cctx_T *cctx, cac_T *cac)
3378{
3379 lhs_T *lhs = &cac->cac_lhs;
3380
3381 if (cctx->ctx_skip == SKIP_YES)
3382 {
3383 if (cac->cac_oplen > 0 && cac->cac_var_count == 0)
3384 {
3385 // skip over the "=" and the expression
3386 cac->cac_nextc = skipwhite(cac->cac_op + cac->cac_oplen);
3387 (void)compile_expr0(&cac->cac_nextc, cctx);
3388 }
3389 return OK;
3390 }
3391
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003392 // If RHS is specified, then generate instructions for RHS expression
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003393 if (cac->cac_oplen > 0)
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003394 return compile_assign_rhs_expr(cctx, cac);
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003395
3396 if (cac->cac_cmdidx == CMD_final)
3397 {
3398 emsg(_(e_final_requires_a_value));
3399 return FAIL;
3400 }
3401
3402 if (cac->cac_cmdidx == CMD_const)
3403 {
3404 emsg(_(e_const_requires_a_value));
3405 return FAIL;
3406 }
3407
3408 if (!lhs->lhs_has_type || lhs->lhs_dest == dest_option
3409 || lhs->lhs_dest == dest_func_option)
3410 {
3411 emsg(_(e_type_or_initialization_required));
3412 return FAIL;
3413 }
3414
3415 // variables are always initialized
3416 if (GA_GROW_FAILS(cac->cac_instr, 1))
3417 return FAIL;
3418
3419 cac->cac_instr_count = cac->cac_instr->ga_len;
3420
3421 return push_default_value(cctx, lhs->lhs_member_type->tt_type,
3422 lhs->lhs_dest == dest_local,
3423 &cac->cac_skip_store);
3424}
3425
3426/*
3427 * Compile a compound op assignment statement (+=, -=, *=, %=, etc.)
3428 */
3429 static int
3430compile_assign_compound_op(cctx_T *cctx, cac_T *cac)
3431{
3432 lhs_T *lhs = &cac->cac_lhs;
3433 type_T *expected;
3434 type_T *stacktype = NULL;
3435
3436 if (*cac->cac_op == '.')
3437 {
3438 if (may_generate_2STRING(-1, TOSTRING_NONE, cctx) == FAIL)
3439 return FAIL;
3440 }
3441 else
3442 {
3443 expected = lhs->lhs_member_type;
3444 stacktype = get_type_on_stack(cctx, 0);
3445 if (
3446 // If variable is float operation with number is OK.
3447 !(expected == &t_float && (stacktype == &t_number
3448 || stacktype == &t_number_bool))
3449 && need_type(stacktype, expected, TRUE, -1, 0, cctx,
3450 FALSE, FALSE) == FAIL)
3451 return FAIL;
3452 }
3453
3454 if (*cac->cac_op == '.')
3455 {
3456 if (generate_CONCAT(cctx, 2) == FAIL)
3457 return FAIL;
3458 }
3459 else if (*cac->cac_op == '+')
3460 {
3461 if (generate_add_instr(cctx,
3462 operator_type(lhs->lhs_member_type, stacktype),
3463 lhs->lhs_member_type, stacktype,
3464 EXPR_APPEND) == FAIL)
3465 return FAIL;
3466 }
3467 else if (generate_two_op(cctx, cac->cac_op) == FAIL)
3468 return FAIL;
3469
3470 return OK;
3471}
3472
3473/*
3474 * Generate the STORE and SETTYPE instructions for an assignment statement.
3475 */
3476 static int
3477compile_assign_generate_store(cctx_T *cctx, cac_T *cac)
3478{
3479 lhs_T *lhs = &cac->cac_lhs;
3480 int save_lnum;
3481
3482 // Use the line number of the assignment for store instruction.
3483 save_lnum = cctx->ctx_lnum;
3484 cctx->ctx_lnum = cac->cac_start_lnum - 1;
3485
3486 if (lhs->lhs_has_index)
3487 {
3488 // Use the info in "lhs" to store the value at the index in the
3489 // list, dict or object.
3490 if (compile_assign_unlet(cac->cac_var_start, &cac->cac_lhs,
3491 TRUE, cac->cac_rhs_type, cctx) == FAIL)
3492 {
3493 cctx->ctx_lnum = save_lnum;
3494 return FAIL;
3495 }
3496 }
3497 else
3498 {
3499 if (cac->cac_is_decl && cac->cac_cmdidx == CMD_const &&
3500 (lhs->lhs_dest == dest_script
3501 || lhs->lhs_dest == dest_script_v9
3502 || lhs->lhs_dest == dest_global
3503 || lhs->lhs_dest == dest_local))
3504 // ":const var": lock the value, but not referenced variables
3505 generate_LOCKCONST(cctx);
3506
3507 type_T *inferred_type = cac->cac_inferred_type;
3508
3509 if ((lhs->lhs_type->tt_type == VAR_DICT
3510 || lhs->lhs_type->tt_type == VAR_LIST)
3511 && lhs->lhs_type->tt_member != NULL
3512 && lhs->lhs_type->tt_member != &t_any
3513 && lhs->lhs_type->tt_member != &t_unknown)
3514 // Set the type in the list or dict, so that it can be checked,
3515 // also in legacy script.
3516 generate_SETTYPE(cctx, lhs->lhs_type);
3517 else if (inferred_type != NULL
3518 && (inferred_type->tt_type == VAR_DICT
3519 || inferred_type->tt_type == VAR_LIST)
3520 && inferred_type->tt_member != NULL
3521 && inferred_type->tt_member != &t_unknown
3522 && inferred_type->tt_member != &t_any)
3523 // Set the type in the list or dict, so that it can be checked,
3524 // also in legacy script.
3525 generate_SETTYPE(cctx, inferred_type);
3526
3527 if (!cac->cac_skip_store &&
3528 generate_store_lhs(cctx, &cac->cac_lhs,
3529 cac->cac_instr_count,
3530 cac->cac_is_decl) == FAIL)
3531 {
3532 cctx->ctx_lnum = save_lnum;
3533 return FAIL;
3534 }
3535 }
3536
3537 cctx->ctx_lnum = save_lnum;
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003538
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003539 return OK;
3540}
3541
3542/*
3543 * Process the variable(s) in an assignment statement
3544 */
3545 static int
3546compile_assign_process_variables(
3547 cctx_T *cctx,
3548 cac_T *cac,
3549 int cmdidx,
3550 int heredoc,
3551 int has_cmd,
3552 int has_argisset_prefix,
3553 int jump_instr_idx)
3554{
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003555 /*
3556 * Loop over variables in "[var, var] = expr".
3557 * For "name = expr" and "var name: type" this is done only once.
3558 */
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003559 for (cac->cac_var_idx = 0; cac->cac_var_idx == 0 ||
3560 cac->cac_var_idx < cac->cac_var_count; cac->cac_var_idx++)
3561 {
3562 if (cac->cac_var_start[0] == '_'
3563 && !eval_isnamec(cac->cac_var_start[1]))
3564 {
3565 // Ignore underscore in "[a, _, b] = list".
3566 if (cac->cac_var_count > 0)
3567 {
3568 cac->cac_var_start = skipwhite(cac->cac_var_start + 2);
3569 continue;
3570 }
3571 emsg(_(e_cannot_use_underscore_here));
3572 return FAIL;
3573 }
3574 vim_free(cac->cac_lhs.lhs_name);
3575
3576 /*
3577 * Figure out the LHS type and other properties.
3578 */
3579 if (compile_assign_lhs(cac->cac_var_start, &cac->cac_lhs, cmdidx,
3580 cac->cac_is_decl, heredoc, has_cmd,
3581 cac->cac_oplen, cctx) == FAIL)
3582 return FAIL;
3583
3584 // Compile the RHS expression
3585 if (heredoc)
3586 {
3587 SOURCING_LNUM = cac->cac_start_lnum;
3588 if (cac->cac_lhs.lhs_has_type
3589 && need_type(&t_list_string, cac->cac_lhs.lhs_type,
3590 FALSE, -1, 0, cctx, FALSE, FALSE) == FAIL)
3591 return FAIL;
3592 }
3593 else
3594 {
3595 if (compile_assign_rhs(cctx, cac) == FAIL)
3596 return FAIL;
3597 if (cac->cac_var_count == 0)
3598 cac->cac_var_end = cac->cac_nextc;
3599 }
3600
3601 // no need to parse more when skipping
3602 if (cctx->ctx_skip == SKIP_YES)
3603 break;
3604
3605 if (cac->cac_oplen > 0 && *cac->cac_op != '=')
3606 {
3607 if (compile_assign_compound_op(cctx, cac) == FAIL)
3608 return FAIL;
3609 }
3610
3611 // generate the store instructions
3612 if (compile_assign_generate_store(cctx, cac) == FAIL)
3613 return FAIL;
3614
3615 if (cac->cac_var_idx + 1 < cac->cac_var_count)
3616 cac->cac_var_start = skipwhite(cac->cac_lhs.lhs_end + 1);
3617
3618 if (has_argisset_prefix)
3619 {
3620 // set instruction index in JUMP_IF_ARG_SET to here
3621 isn_T *isn = ((isn_T *)cac->cac_instr->ga_data) + jump_instr_idx;
3622 isn->isn_arg.jumparg.jump_where = cac->cac_instr->ga_len;
3623 }
3624 }
3625
3626 return OK;
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01003627}
3628
3629/*
Bram Moolenaar47a519a2020-06-14 23:05:10 +02003630 * Compile declaration and assignment:
Bram Moolenaar30fd8202020-09-26 15:09:30 +02003631 * "let name"
3632 * "var name = expr"
3633 * "final name = expr"
3634 * "const name = expr"
3635 * "name = expr"
3636 * "arg" points to "name".
Bram Moolenaarbdc0f1c2021-04-24 19:08:24 +02003637 * "++arg" and "--arg"
Bram Moolenaar47a519a2020-06-14 23:05:10 +02003638 * Return NULL for an error.
3639 * Return "arg" if it does not look like a variable list.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003640 */
3641 static char_u *
Bram Moolenaar65b0d162022-12-13 18:43:22 +00003642compile_assignment(
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003643 char_u *arg_start,
3644 exarg_T *eap,
3645 cmdidx_T cmdidx,
3646 cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003647{
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003648 cac_T cac;
Bram Moolenaar65b0d162022-12-13 18:43:22 +00003649 char_u *arg = arg_start;
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003650 char_u *retstr = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003651 int heredoc = FALSE;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003652 int jump_instr_idx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003653
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003654 compile_assign_context_init(&cac, cctx, cmdidx, arg);
3655
3656 jump_instr_idx = cac.cac_instr->ga_len;
3657
3658 // process object variable initialization in a new() constructor method
3659 int has_argisset_prefix = STRNCMP(arg, "ifargisset ", 11) == 0;
3660 if (has_argisset_prefix &&
3661 compile_assign_obj_new_arg(&arg, cctx) == FAIL)
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01003662 goto theend;
Bram Moolenaar65b0d162022-12-13 18:43:22 +00003663
Bram Moolenaare1d12112022-03-05 11:37:48 +00003664 // Skip over the "varname" or "[varname, varname]" to get to any "=".
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003665 cac.cac_nextc = skip_var_list(arg, TRUE, &cac.cac_var_count,
3666 &cac.cac_semicolon, TRUE);
3667 if (cac.cac_nextc == NULL)
Bram Moolenaar47a519a2020-06-14 23:05:10 +02003668 return *arg == '[' ? arg : NULL;
3669
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003670 if (compile_assign_process_operator(eap, arg, &cac, &heredoc,
3671 &retstr) == FAIL)
3672 return retstr;
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01003673
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003674 // Compute the start of the assignment
3675 cac.cac_var_start = compile_assign_compute_start(arg, cac.cac_var_count);
3676
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003677 // Compute the end of the assignment
3678 cac.cac_var_end = compile_assign_compute_end(eap, cctx, &cac, heredoc);
3679 if (cac.cac_var_end == NULL)
3680 return NULL;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02003681
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003682 int has_cmd = cac.cac_var_start > eap->cmd;
Bram Moolenaar752fc692021-01-04 21:57:11 +01003683
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003684 /* process the variable(s) */
3685 if (compile_assign_process_variables(cctx, &cac, cmdidx, heredoc,
3686 has_cmd, has_argisset_prefix,
3687 jump_instr_idx) == FAIL)
3688 goto theend;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02003689
Bram Moolenaar4d5dfe22021-06-26 13:59:29 +02003690 // For "[var, var] = expr" drop the "expr" value.
3691 // Also for "[var, var; _] = expr".
Yegappan Lakshmanane2038412024-12-14 19:59:24 +01003692 if (cctx->ctx_skip != SKIP_YES && cac.cac_var_count > 0 &&
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003693 (!cac.cac_semicolon || !cac.cac_did_generate_slice))
Bram Moolenaar9af78762020-06-16 11:34:42 +02003694 {
Bram Moolenaarec792292020-12-13 21:26:56 +01003695 if (generate_instr_drop(cctx, ISN_DROP, 1) == NULL)
Bram Moolenaar9af78762020-06-16 11:34:42 +02003696 goto theend;
3697 }
Bram Moolenaar47a519a2020-06-14 23:05:10 +02003698
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003699 retstr = skipwhite(cac.cac_var_end);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003700
3701theend:
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003702 vim_free(cac.cac_lhs.lhs_name);
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003703 return retstr;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003704}
3705
3706/*
Bram Moolenaar17126b12021-01-07 22:03:02 +01003707 * Check for an assignment at "eap->cmd", compile it if found.
3708 * Return NOTDONE if there is none, FAIL for failure, OK if done.
3709 */
3710 static int
3711may_compile_assignment(exarg_T *eap, char_u **line, cctx_T *cctx)
3712{
3713 char_u *pskip;
3714 char_u *p;
3715
3716 // Assuming the command starts with a variable or function name,
3717 // find what follows.
3718 // Skip over "var.member", "var[idx]" and the like.
3719 // Also "&opt = val", "$ENV = val" and "@r = val".
3720 pskip = (*eap->cmd == '&' || *eap->cmd == '$' || *eap->cmd == '@')
3721 ? eap->cmd + 1 : eap->cmd;
3722 p = to_name_end(pskip, TRUE);
3723 if (p > eap->cmd && *p != NUL)
3724 {
3725 char_u *var_end;
3726 int oplen;
3727 int heredoc;
3728
3729 if (eap->cmd[0] == '@')
3730 var_end = eap->cmd + 2;
3731 else
3732 var_end = find_name_end(pskip, NULL, NULL,
3733 FNE_CHECK_START | FNE_INCL_BR);
3734 oplen = assignment_len(skipwhite(var_end), &heredoc);
3735 if (oplen > 0)
3736 {
3737 size_t len = p - eap->cmd;
3738
3739 // Recognize an assignment if we recognize the variable
3740 // name:
Bram Moolenaar17126b12021-01-07 22:03:02 +01003741 // "&opt = expr"
3742 // "$ENV = expr"
3743 // "@r = expr"
Bram Moolenaar2e17fef2022-03-18 19:44:48 +00003744 // "g:var = expr"
3745 // "g:[key] = expr"
3746 // "local = expr" where "local" is a local var.
3747 // "script = expr" where "script" is a script-local var.
3748 // "import = expr" where "import" is an imported var
Bram Moolenaar17126b12021-01-07 22:03:02 +01003749 if (*eap->cmd == '&'
3750 || *eap->cmd == '$'
3751 || *eap->cmd == '@'
3752 || ((len) > 2 && eap->cmd[1] == ':')
Bram Moolenaar2e17fef2022-03-18 19:44:48 +00003753 || STRNCMP(eap->cmd, "g:[", 3) == 0
Bram Moolenaare0890d62021-02-17 14:52:14 +01003754 || variable_exists(eap->cmd, len, cctx))
Bram Moolenaar17126b12021-01-07 22:03:02 +01003755 {
3756 *line = compile_assignment(eap->cmd, eap, CMD_SIZE, cctx);
3757 if (*line == NULL || *line == eap->cmd)
3758 return FAIL;
3759 return OK;
3760 }
3761 }
3762 }
3763
Bram Moolenaar65b0d162022-12-13 18:43:22 +00003764 // might be "[var, var] = expr" or "ifargisset this.member = expr"
3765 if (*eap->cmd == '[' || STRNCMP(eap->cmd, "ifargisset ", 11) == 0)
Bram Moolenaar17126b12021-01-07 22:03:02 +01003766 {
Bram Moolenaar17126b12021-01-07 22:03:02 +01003767 *line = compile_assignment(eap->cmd, eap, CMD_SIZE, cctx);
3768 if (*line == NULL)
3769 return FAIL;
3770 if (*line != eap->cmd)
3771 return OK;
3772 }
3773 return NOTDONE;
3774}
3775
Bram Moolenaar9a015112021-12-31 14:06:45 +00003776/*
3777 * Check if arguments of "ufunc" shadow variables in "cctx".
3778 * Return OK or FAIL.
3779 */
3780 static int
3781check_args_shadowing(ufunc_T *ufunc, cctx_T *cctx)
3782{
3783 int i;
3784 char_u *arg;
3785 int r = OK;
3786
3787 // Make sure arguments are not found when compiling a second time.
3788 ufunc->uf_args_visible = 0;
3789
3790 // Check for arguments shadowing variables from the context.
3791 for (i = 0; i < ufunc->uf_args.ga_len; ++i)
3792 {
3793 arg = ((char_u **)(ufunc->uf_args.ga_data))[i];
Bram Moolenaardce24412022-02-08 20:35:30 +00003794 if (check_defined(arg, STRLEN(arg), cctx, NULL, TRUE) == FAIL)
Bram Moolenaar9a015112021-12-31 14:06:45 +00003795 {
3796 r = FAIL;
3797 break;
3798 }
3799 }
3800 ufunc->uf_args_visible = ufunc->uf_args.ga_len;
3801 return r;
3802}
3803
Bram Moolenaarfcb86b02022-10-07 22:46:24 +01003804#ifdef HAS_MESSAGE_WINDOW
Bram Moolenaar139575d2022-03-15 19:29:30 +00003805/*
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003806 * Get a count before a command. Can only be a number.
3807 * Returns zero if there is no count.
3808 * Returns -1 if there is something wrong.
3809 */
3810 static long
3811get_cmd_count(char_u *line, exarg_T *eap)
3812{
3813 char_u *p;
3814
3815 // skip over colons and white space
3816 for (p = line; *p == ':' || VIM_ISWHITE(*p); ++p)
3817 ;
Keith Thompson184f71c2024-01-04 21:19:04 +01003818 if (!SAFE_isdigit(*p))
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003819 {
Bram Moolenaar2435adf2022-10-21 12:05:46 +01003820 // The command or modifiers must be following. Assume a lower case
3821 // character means there is a modifier.
3822 if (p < eap->cmd && !vim_islower(*p))
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003823 {
3824 emsg(_(e_invalid_range));
3825 return -1;
3826 }
3827 return 0;
3828 }
3829 return atol((char *)p);
3830}
Bram Moolenaarfcb86b02022-10-07 22:46:24 +01003831#endif
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003832
3833/*
Bram Moolenaar139575d2022-03-15 19:29:30 +00003834 * Get the compilation type that should be used for "ufunc".
3835 * Keep in sync with INSTRUCTIONS().
3836 */
3837 compiletype_T
3838get_compile_type(ufunc_T *ufunc)
3839{
3840 // Update uf_has_breakpoint if needed.
3841 update_has_breakpoint(ufunc);
3842
3843 if (debug_break_level > 0 || may_break_in_function(ufunc))
3844 return CT_DEBUG;
3845#ifdef FEAT_PROFILE
3846 if (do_profiling == PROF_YES)
3847 {
Ernie Rael21d32122023-09-02 15:09:18 +02003848 if (!ufunc->uf_profiling && has_profiling(FALSE, ufunc->uf_name, NULL,
3849 &ufunc->uf_hash))
Bram Moolenaar139575d2022-03-15 19:29:30 +00003850 func_do_profile(ufunc);
3851 if (ufunc->uf_profiling)
3852 return CT_PROFILE;
3853 }
3854#endif
3855 return CT_NONE;
3856}
3857
Yegappan Lakshmananf07c10d2024-12-23 10:15:08 +01003858/*
3859 * Free the compiled instructions saved for a def function. This is used when
3860 * compiling a def function and the function was compiled before.
3861 * The index is reused.
3862 */
3863 static void
3864clear_def_function(ufunc_T *ufunc, compiletype_T compile_type)
3865{
3866 isn_T *instr_dest = NULL;
3867 dfunc_T *dfunc;
3868
3869 dfunc = ((dfunc_T *)def_functions.ga_data) + ufunc->uf_dfunc_idx;
3870
3871 switch (compile_type)
3872 {
3873 case CT_PROFILE:
3874#ifdef FEAT_PROFILE
3875 instr_dest = dfunc->df_instr_prof; break;
3876#endif
3877 case CT_NONE: instr_dest = dfunc->df_instr; break;
3878 case CT_DEBUG: instr_dest = dfunc->df_instr_debug; break;
3879 }
3880
3881 if (instr_dest != NULL)
3882 // Was compiled in this mode before: Free old instructions.
3883 delete_def_function_contents(dfunc, FALSE);
3884
3885 ga_clear_strings(&dfunc->df_var_names);
3886 dfunc->df_defer_var_idx = 0;
3887}
Bram Moolenaar7b829262021-10-13 15:04:34 +01003888
3889/*
Bram Moolenaar09689a02020-05-09 22:50:08 +02003890 * Add a function to the list of :def functions.
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003891 * This sets "ufunc->uf_dfunc_idx" but the function isn't compiled yet.
Bram Moolenaar09689a02020-05-09 22:50:08 +02003892 */
Bram Moolenaar822ba242020-05-24 23:00:18 +02003893 static int
Bram Moolenaar09689a02020-05-09 22:50:08 +02003894add_def_function(ufunc_T *ufunc)
3895{
3896 dfunc_T *dfunc;
3897
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003898 if (def_functions.ga_len == 0)
3899 {
3900 // The first position is not used, so that a zero uf_dfunc_idx means it
3901 // wasn't set.
Bram Moolenaar35578162021-08-02 19:10:38 +02003902 if (GA_GROW_FAILS(&def_functions, 1))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003903 return FAIL;
3904 ++def_functions.ga_len;
3905 }
3906
Bram Moolenaar09689a02020-05-09 22:50:08 +02003907 // Add the function to "def_functions".
Bram Moolenaar35578162021-08-02 19:10:38 +02003908 if (GA_GROW_FAILS(&def_functions, 1))
Bram Moolenaar09689a02020-05-09 22:50:08 +02003909 return FAIL;
3910 dfunc = ((dfunc_T *)def_functions.ga_data) + def_functions.ga_len;
3911 CLEAR_POINTER(dfunc);
3912 dfunc->df_idx = def_functions.ga_len;
3913 ufunc->uf_dfunc_idx = dfunc->df_idx;
3914 dfunc->df_ufunc = ufunc;
John Marriottb32800f2025-02-01 15:25:34 +01003915 dfunc->df_name = vim_strnsave(ufunc->uf_name, ufunc->uf_namelen);
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02003916 ga_init2(&dfunc->df_var_names, sizeof(char_u *), 10);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01003917 ++dfunc->df_refcount;
Bram Moolenaar09689a02020-05-09 22:50:08 +02003918 ++def_functions.ga_len;
3919 return OK;
3920}
3921
Yegappan Lakshmananf07c10d2024-12-23 10:15:08 +01003922 static int
3923compile_dfunc_ufunc_init(
3924 ufunc_T *ufunc,
3925 cctx_T *outer_cctx,
3926 compiletype_T compile_type,
3927 int *new_def_function)
3928{
3929 // When using a function that was compiled before: Free old instructions.
3930 // The index is reused. Otherwise add a new entry in "def_functions".
3931 if (ufunc->uf_dfunc_idx > 0)
3932 clear_def_function(ufunc, compile_type);
3933 else
3934 {
3935 if (add_def_function(ufunc) == FAIL)
3936 return FAIL;
3937
3938 *new_def_function = TRUE;
3939 }
3940
3941 if ((ufunc->uf_flags & FC_CLOSURE) && outer_cctx == NULL)
3942 {
3943 semsg(_(e_compiling_closure_without_context_str),
3944 printable_func_name(ufunc));
3945 return FAIL;
3946 }
3947
3948 ufunc->uf_def_status = UF_COMPILING;
3949
3950 return OK;
3951}
3952
3953/*
3954 * Initialize the compilation context for compiling a def function.
3955 */
3956 static void
3957compile_dfunc_cctx_init(
3958 cctx_T *cctx,
3959 cctx_T *outer_cctx,
3960 ufunc_T *ufunc,
3961 compiletype_T compile_type)
3962{
3963 CLEAR_FIELD(*cctx);
3964
3965 cctx->ctx_compile_type = compile_type;
3966 cctx->ctx_ufunc = ufunc;
3967 cctx->ctx_lnum = -1;
3968 cctx->ctx_outer = outer_cctx;
3969 ga_init2(&cctx->ctx_locals, sizeof(lvar_T), 10);
3970 // Each entry on the type stack consists of two type pointers.
3971 ga_init2(&cctx->ctx_type_stack, sizeof(type2_T), 50);
3972 cctx->ctx_type_list = &ufunc->uf_type_list;
3973 ga_init2(&cctx->ctx_instr, sizeof(isn_T), 50);
3974}
3975
Bram Moolenaar09689a02020-05-09 22:50:08 +02003976/*
Yegappan Lakshmananf6c1fb22024-04-25 21:30:56 +02003977 * For an object constructor, generate instruction to setup "this" (the first
3978 * local variable) and to initialize the object variables.
3979 */
3980 static int
3981obj_constructor_prologue(ufunc_T *ufunc, cctx_T *cctx)
3982{
3983 generate_CONSTRUCT(cctx, ufunc->uf_class);
3984
3985 for (int i = 0; i < ufunc->uf_class->class_obj_member_count; ++i)
3986 {
3987 ocmember_T *m = &ufunc->uf_class->class_obj_members[i];
3988
3989 if (i < 2 && IS_ENUM(ufunc->uf_class))
3990 // The first two object variables in an enum are the name
3991 // and the ordinal. These are set by the ISN_CONSTRUCT
3992 // instruction. So don't generate instructions to set
3993 // these variables.
3994 continue;
3995
3996 if (m->ocm_init != NULL)
3997 {
3998 char_u *expr = m->ocm_init;
3999
4000 if (compile_expr0(&expr, cctx) == FAIL)
4001 return FAIL;
4002
4003 if (!ends_excmd2(m->ocm_init, expr))
4004 {
4005 semsg(_(e_trailing_characters_str), expr);
4006 return FAIL;
4007 }
4008
4009 type_T *type = get_type_on_stack(cctx, 0);
4010 if (m->ocm_type->tt_type == VAR_ANY
4011 && !(m->ocm_flags & OCMFLAG_HAS_TYPE)
4012 && type->tt_type != VAR_SPECIAL)
4013 {
4014 // If the member variable type is not yet set, then use
4015 // the initialization expression type.
4016 m->ocm_type = type;
4017 }
LemonBoyf4af3312024-07-04 13:43:12 +02004018 else
Yegappan Lakshmananf6c1fb22024-04-25 21:30:56 +02004019 {
4020 // The type of the member initialization expression is
4021 // determined at run time. Add a runtime type check.
4022 where_T where = WHERE_INIT;
4023 where.wt_kind = WT_MEMBER;
4024 where.wt_func_name = (char *)m->ocm_name;
4025 if (need_type_where(type, m->ocm_type, FALSE, -1,
4026 where, cctx, FALSE, FALSE) == FAIL)
4027 return FAIL;
4028 }
4029 }
4030 else
4031 push_default_value(cctx, m->ocm_type->tt_type, FALSE, NULL);
4032
LemonBoyf4af3312024-07-04 13:43:12 +02004033 if ((m->ocm_type->tt_type == VAR_DICT
4034 || m->ocm_type->tt_type == VAR_LIST)
4035 && m->ocm_type->tt_member != NULL
4036 && m->ocm_type->tt_member != &t_any
4037 && m->ocm_type->tt_member != &t_unknown)
4038 // Set the type in the list or dict, so that it can be checked,
4039 // also in legacy script.
4040 generate_SETTYPE(cctx, m->ocm_type);
4041
Yegappan Lakshmananf6c1fb22024-04-25 21:30:56 +02004042 generate_STORE_THIS(cctx, i);
4043 }
4044
4045 return OK;
4046}
4047
4048/*
4049 * For an object method and an constructor, generate instruction to setup
4050 * "this" (the first local variable). For a constructor, generate instructions
4051 * to initialize the object variables.
4052 */
4053 static int
4054obj_method_prologue(ufunc_T *ufunc, cctx_T *cctx)
4055{
4056 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data) + ufunc->uf_dfunc_idx;
4057
4058 if (GA_GROW_FAILS(&dfunc->df_var_names, 1))
4059 return FAIL;
4060
4061 ((char_u **)dfunc->df_var_names.ga_data)[0] =
4062 vim_strsave((char_u *)"this");
4063 ++dfunc->df_var_names.ga_len;
4064
4065 // In the constructor allocate memory for the object and initialize the
4066 // object members.
4067 if (IS_CONSTRUCTOR_METHOD(ufunc))
4068 return obj_constructor_prologue(ufunc, cctx);
4069
4070 return OK;
4071}
4072
4073/*
4074 * Produce instructions for the default values of optional arguments.
4075 */
4076 static int
4077compile_def_function_default_args(
4078 ufunc_T *ufunc,
Yegappan Lakshmananf07c10d2024-12-23 10:15:08 +01004079 garray_T *instr,
4080 cctx_T *cctx)
Yegappan Lakshmananf6c1fb22024-04-25 21:30:56 +02004081{
4082 int count = ufunc->uf_def_args.ga_len;
4083 int first_def_arg = ufunc->uf_args.ga_len - count;
4084 int i;
4085 int off = STACK_FRAME_SIZE + (ufunc->uf_va_name != NULL ? 1 : 0);
4086 int did_set_arg_type = FALSE;
4087
4088 // Produce instructions for the default values of optional arguments.
4089 SOURCING_LNUM = 0; // line number unknown
4090 for (i = 0; i < count; ++i)
4091 {
4092 char_u *arg = ((char_u **)(ufunc->uf_def_args.ga_data))[i];
4093 if (STRCMP(arg, "v:none") == 0)
4094 // "arg = v:none" means the argument is optional without
4095 // setting a value when the argument is missing.
4096 continue;
4097
4098 type_T *val_type;
4099 int arg_idx = first_def_arg + i;
4100 where_T where = WHERE_INIT;
4101 int jump_instr_idx = instr->ga_len;
4102 isn_T *isn;
4103
4104 // Use a JUMP_IF_ARG_SET instruction to skip if the value was given.
4105 if (generate_JUMP_IF_ARG(cctx, ISN_JUMP_IF_ARG_SET,
4106 i - count - off) == FAIL)
4107 return FAIL;
4108
4109 // Make sure later arguments are not found.
4110 ufunc->uf_args_visible = arg_idx;
4111
4112 int r = compile_expr0(&arg, cctx);
4113 if (r == FAIL)
4114 return FAIL;
4115
4116 // If no type specified use the type of the default value.
4117 // Otherwise check that the default value type matches the
4118 // specified type.
4119 val_type = get_type_on_stack(cctx, 0);
4120 where.wt_index = arg_idx + 1;
4121 where.wt_kind = WT_ARGUMENT;
4122 if (ufunc->uf_arg_types[arg_idx] == &t_unknown)
4123 {
4124 did_set_arg_type = TRUE;
4125 ufunc->uf_arg_types[arg_idx] = val_type;
4126 }
4127 else if (need_type_where(val_type, ufunc->uf_arg_types[arg_idx],
4128 FALSE, -1, where, cctx, FALSE, FALSE) == FAIL)
4129 return FAIL;
4130
4131 if (generate_STORE(cctx, ISN_STORE, i - count - off, NULL) == FAIL)
4132 return FAIL;
4133
4134 // set instruction index in JUMP_IF_ARG_SET to here
4135 isn = ((isn_T *)instr->ga_data) + jump_instr_idx;
4136 isn->isn_arg.jumparg.jump_where = instr->ga_len;
4137 }
4138
4139 if (did_set_arg_type)
4140 set_function_type(ufunc);
4141
4142 return OK;
4143}
4144
4145/*
Yegappan Lakshmanana16f2512024-04-23 20:14:46 +02004146 * Compile def function body. Loop over all the lines in the function and
4147 * generate instructions.
4148 */
4149 static int
4150compile_def_function_body(
Yegappan Lakshmanana16f2512024-04-23 20:14:46 +02004151 int last_func_lnum,
4152 int check_return_type,
4153 garray_T *lines_to_free,
Yegappan Lakshmananf07c10d2024-12-23 10:15:08 +01004154 char **errormsg,
4155 cctx_T *cctx)
Yegappan Lakshmanana16f2512024-04-23 20:14:46 +02004156{
4157 char_u *line = NULL;
4158 char_u *p;
4159 int did_emsg_before = did_emsg;
4160#ifdef FEAT_PROFILE
4161 int prof_lnum = -1;
4162#endif
4163 int debug_lnum = -1;
4164
4165 for (;;)
4166 {
4167 exarg_T ea;
4168 int starts_with_colon = FALSE;
4169 char_u *cmd;
4170 cmdmod_T local_cmdmod;
4171
4172 // Bail out on the first error to avoid a flood of errors and report
4173 // the right line number when inside try/catch.
4174 if (did_emsg_before != did_emsg)
4175 return FAIL;
4176
4177 if (line != NULL && *line == '|')
4178 // the line continues after a '|'
4179 ++line;
4180 else if (line != NULL && *skipwhite(line) != NUL
4181 && !(*line == '#' && (line == cctx->ctx_line_start
4182 || VIM_ISWHITE(line[-1]))))
4183 {
4184 semsg(_(e_trailing_characters_str), line);
4185 return FAIL;
4186 }
4187 else if (line != NULL && vim9_bad_comment(skipwhite(line)))
4188 return FAIL;
4189 else
4190 {
4191 line = next_line_from_context(cctx, FALSE);
4192 if (cctx->ctx_lnum >= last_func_lnum)
4193 {
4194 // beyond the last line
4195#ifdef FEAT_PROFILE
4196 if (cctx->ctx_skip != SKIP_YES)
4197 may_generate_prof_end(cctx, prof_lnum);
4198#endif
4199 break;
4200 }
4201 // Make a copy, splitting off nextcmd and removing trailing spaces
4202 // may change it.
4203 if (line != NULL)
4204 {
4205 line = vim_strsave(line);
4206 if (ga_add_string(lines_to_free, line) == FAIL)
4207 return FAIL;
4208 }
4209 }
4210
4211 CLEAR_FIELD(ea);
4212 ea.cmdlinep = &line;
4213 ea.cmd = skipwhite(line);
4214 ea.skip = cctx->ctx_skip == SKIP_YES;
4215
4216 if (*ea.cmd == '#')
4217 {
4218 // "#" starts a comment, but "#{" is an error
4219 if (vim9_bad_comment(ea.cmd))
4220 return FAIL;
4221 line = (char_u *)"";
4222 continue;
4223 }
4224
4225#ifdef FEAT_PROFILE
4226 if (cctx->ctx_compile_type == CT_PROFILE && cctx->ctx_lnum != prof_lnum
4227 && cctx->ctx_skip != SKIP_YES)
4228 {
4229 may_generate_prof_end(cctx, prof_lnum);
4230
4231 prof_lnum = cctx->ctx_lnum;
4232 generate_instr(cctx, ISN_PROF_START);
4233 }
4234#endif
4235 if (cctx->ctx_compile_type == CT_DEBUG && cctx->ctx_lnum != debug_lnum
4236 && cctx->ctx_skip != SKIP_YES)
4237 {
4238 debug_lnum = cctx->ctx_lnum;
4239 generate_instr_debug(cctx);
4240 }
4241 cctx->ctx_prev_lnum = cctx->ctx_lnum + 1;
4242
4243 // Some things can be recognized by the first character.
4244 switch (*ea.cmd)
4245 {
4246 case '}':
4247 {
4248 // "}" ends a block scope
4249 scopetype_T stype = cctx->ctx_scope == NULL
4250 ? NO_SCOPE : cctx->ctx_scope->se_type;
4251
4252 if (stype == BLOCK_SCOPE)
4253 {
4254 compile_endblock(cctx);
4255 line = ea.cmd;
4256 }
4257 else
4258 {
4259 emsg(_(e_using_rcurly_outside_if_block_scope));
4260 return FAIL;
4261 }
4262 if (line != NULL)
4263 line = skipwhite(ea.cmd + 1);
4264 continue;
4265 }
4266
4267 case '{':
4268 // "{" starts a block scope
4269 // "{'a': 1}->func() is something else
4270 if (ends_excmd(*skipwhite(ea.cmd + 1)))
4271 {
4272 line = compile_block(ea.cmd, cctx);
4273 continue;
4274 }
4275 break;
4276 }
4277
4278 /*
4279 * COMMAND MODIFIERS
4280 */
4281 cctx->ctx_has_cmdmod = FALSE;
4282 if (parse_command_modifiers(&ea, errormsg, &local_cmdmod, FALSE)
4283 == FAIL)
4284 return FAIL;
4285 generate_cmdmods(cctx, &local_cmdmod);
4286 undo_cmdmod(&local_cmdmod);
4287
4288 // Check if there was a colon after the last command modifier or before
4289 // the current position.
4290 for (p = ea.cmd; p >= line; --p)
4291 {
4292 if (*p == ':')
4293 starts_with_colon = TRUE;
4294 if (p < ea.cmd && !VIM_ISWHITE(*p))
4295 break;
4296 }
4297
4298 // Skip ":call" to get to the function name, unless using :legacy
4299 p = ea.cmd;
4300 if (!(local_cmdmod.cmod_flags & CMOD_LEGACY))
4301 {
4302 if (checkforcmd(&ea.cmd, "call", 3))
4303 {
4304 if (*ea.cmd == '(')
4305 // not for "call()"
4306 ea.cmd = p;
4307 else
4308 ea.cmd = skipwhite(ea.cmd);
4309 }
4310
4311 if (!starts_with_colon)
4312 {
4313 int assign;
4314
4315 // Check for assignment after command modifiers.
4316 assign = may_compile_assignment(&ea, &line, cctx);
4317 if (assign == OK)
4318 goto nextline;
4319 if (assign == FAIL)
4320 return FAIL;
4321 }
4322 }
4323
4324 /*
4325 * COMMAND after range
4326 * 'text'->func() should not be confused with 'a mark
4327 * 0z1234->func() should not be confused with a zero line number
4328 * "++nr" and "--nr" are eval commands
4329 * in "$ENV->func()" the "$" is not a range
4330 * "123->func()" is a method call
4331 */
4332 cmd = ea.cmd;
4333 if ((*cmd != '$' || starts_with_colon)
4334 && (starts_with_colon
4335 || !(*cmd == '\''
4336 || (cmd[0] == '0' && cmd[1] == 'z')
4337 || (cmd[0] != NUL && cmd[0] == cmd[1]
4338 && (*cmd == '+' || *cmd == '-'))
4339 || number_method(cmd))))
4340 {
4341 ea.cmd = skip_range(ea.cmd, TRUE, NULL);
4342 if (ea.cmd > cmd)
4343 {
4344 if (!starts_with_colon
4345 && !(local_cmdmod.cmod_flags & CMOD_LEGACY))
4346 {
4347 semsg(_(e_colon_required_before_range_str), cmd);
4348 return FAIL;
4349 }
4350 ea.addr_count = 1;
4351 if (ends_excmd2(line, ea.cmd))
4352 {
4353 // A range without a command: jump to the line.
4354 generate_EXEC(cctx, ISN_EXECRANGE,
4355 vim_strnsave(cmd, ea.cmd - cmd));
4356 line = ea.cmd;
4357 goto nextline;
4358 }
4359 }
4360 }
4361 p = find_ex_command(&ea, NULL,
4362 starts_with_colon || (local_cmdmod.cmod_flags & CMOD_LEGACY)
4363 ? NULL : item_exists, cctx);
4364
4365 if (p == NULL)
4366 {
4367 if (cctx->ctx_skip != SKIP_YES)
4368 semsg(_(e_ambiguous_use_of_user_defined_command_str), ea.cmd);
4369 return FAIL;
4370 }
4371
4372 // When using ":legacy cmd" always use compile_exec().
4373 if (local_cmdmod.cmod_flags & CMOD_LEGACY)
4374 {
4375 char_u *start = ea.cmd;
4376
4377 switch (ea.cmdidx)
4378 {
4379 case CMD_if:
4380 case CMD_elseif:
4381 case CMD_else:
4382 case CMD_endif:
4383 case CMD_for:
4384 case CMD_endfor:
4385 case CMD_continue:
4386 case CMD_break:
4387 case CMD_while:
4388 case CMD_endwhile:
4389 case CMD_try:
4390 case CMD_catch:
4391 case CMD_finally:
4392 case CMD_endtry:
4393 semsg(_(e_cannot_use_legacy_with_command_str), ea.cmd);
4394 return FAIL;
4395 default: break;
4396 }
4397
4398 // ":legacy return expr" needs to be handled differently.
4399 if (checkforcmd(&start, "return", 4))
4400 ea.cmdidx = CMD_return;
4401 else
4402 ea.cmdidx = CMD_legacy;
4403 }
4404
4405 if (p == ea.cmd && ea.cmdidx != CMD_SIZE)
4406 {
4407 // "eval" is used for "val->func()" and "var" for "var = val", then
4408 // "p" is equal to "ea.cmd" for a valid command.
4409 if (ea.cmdidx == CMD_eval || ea.cmdidx == CMD_var)
4410 ;
4411 else if (cctx->ctx_skip == SKIP_YES)
4412 {
4413 line += STRLEN(line);
4414 goto nextline;
4415 }
4416 else
4417 {
4418 semsg(_(e_command_not_recognized_str), ea.cmd);
4419 return FAIL;
4420 }
4421 }
4422
4423 if ((cctx->ctx_had_return || cctx->ctx_had_throw)
4424 && ea.cmdidx != CMD_elseif
4425 && ea.cmdidx != CMD_else
4426 && ea.cmdidx != CMD_endif
4427 && ea.cmdidx != CMD_endfor
4428 && ea.cmdidx != CMD_endwhile
4429 && ea.cmdidx != CMD_catch
4430 && ea.cmdidx != CMD_finally
4431 && ea.cmdidx != CMD_endtry
4432 && !ignore_unreachable_code_for_testing)
4433 {
4434 semsg(_(e_unreachable_code_after_str),
4435 cctx->ctx_had_return ? "return" : "throw");
4436 return FAIL;
4437 }
Yegappan Lakshmananab9a8942024-12-30 09:56:34 +01004438
4439 // When processing the end of an if-else block, don't clear the
4440 // "ctx_had_throw" flag. If an if-else block ends in a "throw"
4441 // statement, then it is considered to end in a "return" statement.
4442 // The "ctx_had_throw" is cleared immediately after processing the
4443 // if-else block ending statement.
4444 // Otherwise, clear the "had_throw" flag.
4445 if (ea.cmdidx != CMD_else && ea.cmdidx != CMD_elseif
4446 && ea.cmdidx != CMD_endif)
4447 cctx->ctx_had_throw = FALSE;
Yegappan Lakshmanana16f2512024-04-23 20:14:46 +02004448
4449 p = skipwhite(p);
4450 if (ea.cmdidx != CMD_SIZE
4451 && ea.cmdidx != CMD_write && ea.cmdidx != CMD_read)
4452 {
4453 if (ea.cmdidx >= 0)
4454 ea.argt = excmd_get_argt(ea.cmdidx);
4455 if ((ea.argt & EX_BANG) && *p == '!')
4456 {
4457 ea.forceit = TRUE;
4458 p = skipwhite(p + 1);
4459 }
4460 if ((ea.argt & EX_RANGE) == 0 && ea.addr_count > 0)
4461 {
4462 emsg(_(e_no_range_allowed));
4463 return FAIL;
4464 }
4465 }
4466
4467 switch (ea.cmdidx)
4468 {
4469 case CMD_def:
4470 case CMD_function:
4471 ea.arg = p;
4472 line = compile_nested_function(&ea, cctx, lines_to_free);
4473 break;
4474
4475 case CMD_return:
4476 line = compile_return(p, check_return_type,
4477 local_cmdmod.cmod_flags & CMOD_LEGACY, cctx);
4478 cctx->ctx_had_return = TRUE;
4479 break;
4480
4481 case CMD_let:
4482 emsg(_(e_cannot_use_let_in_vim9_script));
4483 break;
4484 case CMD_var:
4485 case CMD_final:
4486 case CMD_const:
4487 case CMD_increment:
4488 case CMD_decrement:
4489 line = compile_assignment(p, &ea, ea.cmdidx, cctx);
4490 if (line == p)
4491 {
4492 emsg(_(e_invalid_assignment));
4493 line = NULL;
4494 }
4495 break;
4496
4497 case CMD_unlet:
4498 case CMD_unlockvar:
4499 case CMD_lockvar:
4500 line = compile_unletlock(p, &ea, cctx);
4501 break;
4502
4503 case CMD_import:
4504 emsg(_(e_import_can_only_be_used_in_script));
4505 line = NULL;
4506 break;
4507
4508 case CMD_if:
4509 line = compile_if(p, cctx);
4510 break;
4511 case CMD_elseif:
4512 line = compile_elseif(p, cctx);
4513 cctx->ctx_had_return = FALSE;
Yegappan Lakshmananab9a8942024-12-30 09:56:34 +01004514 cctx->ctx_had_throw = FALSE;
Yegappan Lakshmanana16f2512024-04-23 20:14:46 +02004515 break;
4516 case CMD_else:
4517 line = compile_else(p, cctx);
4518 cctx->ctx_had_return = FALSE;
Yegappan Lakshmananab9a8942024-12-30 09:56:34 +01004519 cctx->ctx_had_throw = FALSE;
Yegappan Lakshmanana16f2512024-04-23 20:14:46 +02004520 break;
4521 case CMD_endif:
4522 line = compile_endif(p, cctx);
Yegappan Lakshmananab9a8942024-12-30 09:56:34 +01004523 cctx->ctx_had_throw = FALSE;
Yegappan Lakshmanana16f2512024-04-23 20:14:46 +02004524 break;
4525
4526 case CMD_while:
4527 line = compile_while(p, cctx);
4528 break;
4529 case CMD_endwhile:
4530 line = compile_endwhile(p, cctx);
4531 cctx->ctx_had_return = FALSE;
4532 break;
4533
4534 case CMD_for:
4535 line = compile_for(p, cctx);
4536 break;
4537 case CMD_endfor:
4538 line = compile_endfor(p, cctx);
4539 cctx->ctx_had_return = FALSE;
4540 break;
4541 case CMD_continue:
4542 line = compile_continue(p, cctx);
4543 break;
4544 case CMD_break:
4545 line = compile_break(p, cctx);
4546 break;
4547
4548 case CMD_try:
4549 line = compile_try(p, cctx);
4550 break;
4551 case CMD_catch:
4552 line = compile_catch(p, cctx);
4553 cctx->ctx_had_return = FALSE;
4554 break;
4555 case CMD_finally:
4556 line = compile_finally(p, cctx);
4557 cctx->ctx_had_return = FALSE;
4558 break;
4559 case CMD_endtry:
4560 line = compile_endtry(p, cctx);
4561 break;
4562 case CMD_throw:
4563 line = compile_throw(p, cctx);
4564 cctx->ctx_had_throw = TRUE;
4565 break;
4566
4567 case CMD_eval:
4568 line = compile_eval(p, cctx);
4569 break;
4570
4571 case CMD_defer:
4572 line = compile_defer(p, cctx);
4573 break;
4574
4575#ifdef HAS_MESSAGE_WINDOW
4576 case CMD_echowindow:
4577 {
4578 long cmd_count = get_cmd_count(line, &ea);
4579 if (cmd_count < 0)
4580 line = NULL;
4581 else
4582 line = compile_mult_expr(p, ea.cmdidx,
4583 cmd_count, cctx);
4584 }
4585 break;
4586#endif
4587 case CMD_echo:
4588 case CMD_echon:
4589 case CMD_echoconsole:
4590 case CMD_echoerr:
4591 case CMD_echomsg:
4592 case CMD_execute:
4593 line = compile_mult_expr(p, ea.cmdidx, 0, cctx);
4594 break;
4595
4596 case CMD_put:
4597 ea.cmd = cmd;
4598 line = compile_put(p, &ea, cctx);
4599 break;
4600
4601 case CMD_substitute:
4602 if (check_global_and_subst(ea.cmd, p) == FAIL)
4603 return FAIL;
4604 if (cctx->ctx_skip == SKIP_YES)
4605 line = (char_u *)"";
4606 else
4607 {
4608 ea.arg = p;
4609 line = compile_substitute(line, &ea, cctx);
4610 }
4611 break;
4612
4613 case CMD_redir:
4614 ea.arg = p;
4615 line = compile_redir(line, &ea, cctx);
4616 break;
4617
4618 case CMD_cexpr:
4619 case CMD_lexpr:
4620 case CMD_caddexpr:
4621 case CMD_laddexpr:
4622 case CMD_cgetexpr:
4623 case CMD_lgetexpr:
4624#ifdef FEAT_QUICKFIX
4625 ea.arg = p;
4626 line = compile_cexpr(line, &ea, cctx);
4627#else
4628 ex_ni(&ea);
4629 line = NULL;
4630#endif
4631 break;
4632
4633 case CMD_append:
4634 case CMD_change:
4635 case CMD_insert:
4636 case CMD_k:
4637 case CMD_t:
4638 case CMD_xit:
4639 not_in_vim9(&ea);
4640 return FAIL;
4641
4642 case CMD_SIZE:
4643 if (cctx->ctx_skip != SKIP_YES)
4644 {
4645 semsg(_(e_invalid_command_str), ea.cmd);
4646 return FAIL;
4647 }
4648 // We don't check for a next command here.
4649 line = (char_u *)"";
4650 break;
4651
4652 case CMD_lua:
4653 case CMD_mzscheme:
4654 case CMD_perl:
4655 case CMD_py3:
4656 case CMD_python3:
4657 case CMD_python:
4658 case CMD_pythonx:
4659 case CMD_ruby:
4660 case CMD_tcl:
4661 ea.arg = p;
4662 if (vim_strchr(line, '\n') == NULL)
4663 line = compile_exec(line, &ea, cctx);
4664 else
4665 // heredoc lines have been concatenated with NL
4666 // characters in get_function_body()
4667 line = compile_script(line, cctx);
4668 break;
4669
4670 case CMD_vim9script:
4671 if (cctx->ctx_skip != SKIP_YES)
4672 {
4673 emsg(_(e_vim9script_can_only_be_used_in_script));
4674 return FAIL;
4675 }
4676 line = (char_u *)"";
4677 break;
4678
4679 case CMD_class:
4680 emsg(_(e_class_can_only_be_used_in_script));
4681 return FAIL;
4682
4683 case CMD_type:
4684 emsg(_(e_type_can_only_be_used_in_script));
4685 return FAIL;
4686
4687 case CMD_global:
4688 if (check_global_and_subst(ea.cmd, p) == FAIL)
4689 return FAIL;
4690 // FALLTHROUGH
4691 default:
4692 // Not recognized, execute with do_cmdline_cmd().
4693 ea.arg = p;
4694 line = compile_exec(line, &ea, cctx);
4695 break;
4696 }
4697nextline:
4698 if (line == NULL)
4699 return FAIL;
4700 line = skipwhite(line);
4701
4702 // Undo any command modifiers.
4703 generate_undo_cmdmods(cctx);
4704
4705 if (cctx->ctx_type_stack.ga_len < 0)
4706 {
4707 iemsg("Type stack underflow");
4708 return FAIL;
4709 }
4710 } // END of the loop over all the function body lines.
4711
4712 return OK;
4713}
4714
4715/*
Yegappan Lakshmananf07c10d2024-12-23 10:15:08 +01004716 * Returns TRUE if the end of a scope (if, while, for, block) is missing.
4717 * Called after compiling a def function body.
4718 */
4719 static int
4720compile_dfunc_scope_end_missing(cctx_T *cctx)
4721{
4722 if (cctx->ctx_scope == NULL)
4723 return FALSE;
4724
4725 if (cctx->ctx_scope->se_type == IF_SCOPE)
4726 emsg(_(e_missing_endif));
4727 else if (cctx->ctx_scope->se_type == WHILE_SCOPE)
4728 emsg(_(e_missing_endwhile));
4729 else if (cctx->ctx_scope->se_type == FOR_SCOPE)
4730 emsg(_(e_missing_endfor));
4731 else
4732 emsg(_(e_missing_rcurly));
4733
4734 return TRUE;
4735}
4736
4737/*
Yegappan Lakshmananab9a8942024-12-30 09:56:34 +01004738 * When compiling a def function, if it doesn't have an explicit return
Yegappan Lakshmananf07c10d2024-12-23 10:15:08 +01004739 * statement, then generate a default return instruction. For an object
4740 * constructor, return the object.
4741 */
4742 static int
4743compile_dfunc_generate_default_return(ufunc_T *ufunc, cctx_T *cctx)
4744{
4745 // TODO: if a function ends in "throw" but there was a return elsewhere we
4746 // should not assume the return type is "void".
4747 if (cctx->ctx_had_return || cctx->ctx_had_throw)
4748 return OK;
4749
4750 if (ufunc->uf_ret_type->tt_type == VAR_UNKNOWN)
4751 ufunc->uf_ret_type = &t_void;
4752 else if (ufunc->uf_ret_type->tt_type != VAR_VOID
4753 && !IS_CONSTRUCTOR_METHOD(ufunc))
4754 {
4755 emsg(_(e_missing_return_statement));
4756 return FAIL;
4757 }
4758
4759 // Return void if there is no return at the end.
4760 // For a constructor return the object.
4761 if (IS_CONSTRUCTOR_METHOD(ufunc))
4762 {
4763 generate_instr(cctx, ISN_RETURN_OBJECT);
4764 ufunc->uf_ret_type = &ufunc->uf_class->class_object_type;
4765 }
4766 else
4767 generate_instr(cctx, ISN_RETURN_VOID);
4768
4769 return OK;
4770}
4771
4772/*
4773 * Perform the chores after successfully compiling a def function.
4774 */
4775 static void
4776compile_dfunc_epilogue(
4777 cctx_T *outer_cctx,
4778 ufunc_T *ufunc,
4779 garray_T *instr,
4780 cctx_T *cctx)
4781{
4782 dfunc_T *dfunc;
4783
4784 dfunc = ((dfunc_T *)def_functions.ga_data) + ufunc->uf_dfunc_idx;
4785 dfunc->df_deleted = FALSE;
4786 dfunc->df_script_seq = current_sctx.sc_seq;
4787
4788#ifdef FEAT_PROFILE
4789 if (cctx->ctx_compile_type == CT_PROFILE)
4790 {
4791 dfunc->df_instr_prof = instr->ga_data;
4792 dfunc->df_instr_prof_count = instr->ga_len;
4793 }
4794 else
4795#endif
4796 if (cctx->ctx_compile_type == CT_DEBUG)
4797 {
4798 dfunc->df_instr_debug = instr->ga_data;
4799 dfunc->df_instr_debug_count = instr->ga_len;
4800 }
4801 else
4802 {
4803 dfunc->df_instr = instr->ga_data;
4804 dfunc->df_instr_count = instr->ga_len;
4805 }
4806 dfunc->df_varcount = dfunc->df_var_names.ga_len;
4807 dfunc->df_has_closure = cctx->ctx_has_closure;
4808
4809 if (cctx->ctx_outer_used)
4810 {
4811 ufunc->uf_flags |= FC_CLOSURE;
4812 if (outer_cctx != NULL)
4813 ++outer_cctx->ctx_closure_count;
4814 }
4815
4816 ufunc->uf_def_status = UF_COMPILED;
4817}
4818
4819/*
4820 * Perform the cleanup when a def function compilation fails.
4821 */
4822 static void
4823compile_dfunc_ufunc_cleanup(
4824 ufunc_T *ufunc,
4825 garray_T *instr,
4826 int new_def_function,
4827 char *errormsg,
4828 int did_emsg_before,
4829 cctx_T *cctx)
4830{
4831 dfunc_T *dfunc;
4832
4833 dfunc = ((dfunc_T *)def_functions.ga_data) + ufunc->uf_dfunc_idx;
4834
4835 // Compiling aborted, free the generated instructions.
4836 clear_instr_ga(instr);
4837 VIM_CLEAR(dfunc->df_name);
4838 ga_clear_strings(&dfunc->df_var_names);
4839
4840 // If using the last entry in the table and it was added above, we
4841 // might as well remove it.
4842 if (!dfunc->df_deleted && new_def_function
4843 && ufunc->uf_dfunc_idx == def_functions.ga_len - 1)
4844 {
4845 --def_functions.ga_len;
4846 ufunc->uf_dfunc_idx = 0;
4847 }
4848 ufunc->uf_def_status = UF_COMPILE_ERROR;
4849
4850 while (cctx->ctx_scope != NULL)
4851 drop_scope(cctx);
4852
4853 if (errormsg != NULL)
4854 emsg(errormsg);
4855 else if (did_emsg == did_emsg_before)
4856 emsg(_(e_compiling_def_function_failed));
4857}
4858
4859/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004860 * After ex_function() has collected all the function lines: parse and compile
4861 * the lines into instructions.
4862 * Adds the function to "def_functions".
Bram Moolenaar9e68c322020-12-25 12:38:04 +01004863 * When "check_return_type" is set then set ufunc->uf_ret_type to the type of
4864 * the return statement (used for lambda). When uf_ret_type is already set
4865 * then check that it matches.
Bram Moolenaarb2049902021-01-24 12:53:53 +01004866 * When "profiling" is true add ISN_PROF_START instructions.
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +02004867 * "outer_cctx" is set for a nested function.
Bram Moolenaar05afcee2020-03-31 23:32:31 +02004868 * This can be used recursively through compile_lambda(), which may reallocate
4869 * "def_functions".
Bram Moolenaar822ba242020-05-24 23:00:18 +02004870 * Returns OK or FAIL.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004871 */
Bram Moolenaar822ba242020-05-24 23:00:18 +02004872 int
Bram Moolenaarb2049902021-01-24 12:53:53 +01004873compile_def_function(
Bram Moolenaare99d4222021-06-13 14:01:26 +02004874 ufunc_T *ufunc,
4875 int check_return_type,
4876 compiletype_T compile_type,
4877 cctx_T *outer_cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004878{
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004879 garray_T lines_to_free;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004880 char *errormsg = NULL; // error message
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004881 cctx_T cctx;
4882 garray_T *instr;
Bram Moolenaard66960b2020-10-30 20:46:26 +01004883 int did_emsg_before = did_emsg;
Bram Moolenaar599410c2021-04-10 14:03:43 +02004884 int did_emsg_silent_before = did_emsg_silent;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004885 int ret = FAIL;
4886 sctx_T save_current_sctx = current_sctx;
Bram Moolenaarf4e8cdd2020-10-12 22:07:13 +02004887 int save_estack_compiling = estack_compiling;
Bram Moolenaardc4c2302021-04-25 13:54:42 +02004888 int save_cmod_flags = cmdmod.cmod_flags;
Bram Moolenaar25e0f582020-05-25 22:36:50 +02004889 int do_estack_push;
Bram Moolenaar6c4bfe42020-07-23 18:26:30 +02004890 int new_def_function = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004891
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004892 // allocated lines are freed at the end
4893 ga_init2(&lines_to_free, sizeof(char_u *), 50);
4894
Yegappan Lakshmananf07c10d2024-12-23 10:15:08 +01004895 // Initialize the ufunc and the compilation context
4896 if (compile_dfunc_ufunc_init(ufunc, outer_cctx, compile_type,
4897 &new_def_function) == FAIL)
Bram Moolenaar96923b72022-03-15 15:57:04 +00004898 return FAIL;
Bram Moolenaar96923b72022-03-15 15:57:04 +00004899
Yegappan Lakshmananf07c10d2024-12-23 10:15:08 +01004900 compile_dfunc_cctx_init(&cctx, outer_cctx, ufunc, compile_type);
Bram Moolenaar985116a2020-07-12 17:31:09 +02004901
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004902 instr = &cctx.ctx_instr;
4903
Bram Moolenaar25e0f582020-05-25 22:36:50 +02004904 // Set the context to the function, it may be compiled when called from
4905 // another script. Set the script version to the most modern one.
4906 // The line number will be set in next_line_from_context().
4907 current_sctx = ufunc->uf_script_ctx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004908 current_sctx.sc_version = SCRIPT_VERSION_VIM9;
4909
Bram Moolenaardc4c2302021-04-25 13:54:42 +02004910 // Don't use the flag from ":legacy" here.
4911 cmdmod.cmod_flags &= ~CMOD_LEGACY;
4912
Bram Moolenaar25e0f582020-05-25 22:36:50 +02004913 // Make sure error messages are OK.
4914 do_estack_push = !estack_top_is_ufunc(ufunc, 1);
4915 if (do_estack_push)
4916 estack_push_ufunc(ufunc, 1);
Bram Moolenaarf4e8cdd2020-10-12 22:07:13 +02004917 estack_compiling = TRUE;
Bram Moolenaar25e0f582020-05-25 22:36:50 +02004918
Yegappan Lakshmananf07c10d2024-12-23 10:15:08 +01004919 // Make sure arguments don't shadow variables in the context
Bram Moolenaar9a015112021-12-31 14:06:45 +00004920 if (check_args_shadowing(ufunc, &cctx) == FAIL)
4921 goto erret;
4922
Yegappan Lakshmananf6c1fb22024-04-25 21:30:56 +02004923 // For an object method and a constructor generate instructions to
4924 // initialize "this" and the object variables.
Bram Moolenaar574950d2023-01-03 19:08:50 +00004925 if (ufunc->uf_flags & (FC_OBJECT|FC_NEW))
Yegappan Lakshmananf6c1fb22024-04-25 21:30:56 +02004926 if (obj_method_prologue(ufunc, &cctx) == FAIL)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004927 goto erret;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004928
Bram Moolenaar170fcfc2020-02-06 17:51:35 +01004929 if (ufunc->uf_def_args.ga_len > 0)
Yegappan Lakshmananf07c10d2024-12-23 10:15:08 +01004930 if (compile_def_function_default_args(ufunc, instr, &cctx) == FAIL)
Yegappan Lakshmananf6c1fb22024-04-25 21:30:56 +02004931 goto erret;
Bram Moolenaare28d9b32021-07-03 18:56:53 +02004932 ufunc->uf_args_visible = ufunc->uf_args.ga_len;
Bram Moolenaar170fcfc2020-02-06 17:51:35 +01004933
Ernie Rael7c92e882025-01-18 17:26:39 +01004934 // Compiling an abstract method or a function in an interface is done to
4935 // get the function type. No code is actually compiled.
4936 if (ufunc->uf_class != NULL && (IS_INTERFACE(ufunc->uf_class)
4937 || IS_ABSTRACT_METHOD(ufunc)))
Bram Moolenaarb8bebd02023-01-30 20:24:23 +00004938 {
4939 ufunc->uf_def_status = UF_NOT_COMPILED;
4940 ret = OK;
4941 goto erret;
4942 }
4943
Yegappan Lakshmananf6c1fb22024-04-25 21:30:56 +02004944 // compile the function body
Yegappan Lakshmananf07c10d2024-12-23 10:15:08 +01004945 if (compile_def_function_body(ufunc->uf_lines.ga_len, check_return_type,
4946 &lines_to_free, &errormsg, &cctx) == FAIL)
Yegappan Lakshmanana16f2512024-04-23 20:14:46 +02004947 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004948
Yegappan Lakshmananf07c10d2024-12-23 10:15:08 +01004949 if (compile_dfunc_scope_end_missing(&cctx))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004950 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004951
Yegappan Lakshmananf07c10d2024-12-23 10:15:08 +01004952 if (compile_dfunc_generate_default_return(ufunc, &cctx) == FAIL)
4953 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004954
Bram Moolenaar599410c2021-04-10 14:03:43 +02004955 // When compiled with ":silent!" and there was an error don't consider the
4956 // function compiled.
4957 if (emsg_silent == 0 || did_emsg_silent == did_emsg_silent_before)
Yegappan Lakshmananf07c10d2024-12-23 10:15:08 +01004958 compile_dfunc_epilogue(outer_cctx, ufunc, instr, &cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004959
4960 ret = OK;
4961
4962erret:
Bram Moolenaar599410c2021-04-10 14:03:43 +02004963 if (ufunc->uf_def_status == UF_COMPILING)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004964 {
Yegappan Lakshmananf07c10d2024-12-23 10:15:08 +01004965 // compilation failed. do cleanup.
4966 compile_dfunc_ufunc_cleanup(ufunc, instr, new_def_function,
4967 errormsg, did_emsg_before, &cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004968 }
4969
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004970 if (cctx.ctx_redir_lhs.lhs_name != NULL)
4971 {
4972 if (ret == OK)
4973 {
4974 emsg(_(e_missing_redir_end));
4975 ret = FAIL;
4976 }
4977 vim_free(cctx.ctx_redir_lhs.lhs_name);
Bram Moolenaar753bcf82021-04-21 14:24:24 +02004978 vim_free(cctx.ctx_redir_lhs.lhs_whole);
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004979 }
4980
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004981 current_sctx = save_current_sctx;
Bram Moolenaarf4e8cdd2020-10-12 22:07:13 +02004982 estack_compiling = save_estack_compiling;
Bram Moolenaardc4c2302021-04-25 13:54:42 +02004983 cmdmod.cmod_flags = save_cmod_flags;
Bram Moolenaar25e0f582020-05-25 22:36:50 +02004984 if (do_estack_push)
4985 estack_pop();
4986
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004987 ga_clear_strings(&lines_to_free);
Bram Moolenaarb84a3812020-05-01 15:44:29 +02004988 free_locals(&cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004989 ga_clear(&cctx.ctx_type_stack);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004990 return ret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004991}
4992
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004993 void
4994set_function_type(ufunc_T *ufunc)
4995{
4996 int varargs = ufunc->uf_va_name != NULL;
4997 int argcount = ufunc->uf_args.ga_len;
4998
4999 // Create a type for the function, with the return type and any
5000 // argument types.
5001 // A vararg is included in uf_args.ga_len but not in uf_arg_types.
5002 // The type is included in "tt_args".
5003 if (argcount > 0 || varargs)
5004 {
Bram Moolenaar18062fc2021-03-05 21:35:47 +01005005 if (ufunc->uf_type_list.ga_itemsize == 0)
5006 ga_init2(&ufunc->uf_type_list, sizeof(type_T *), 10);
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02005007 ufunc->uf_func_type = alloc_func_type(ufunc->uf_ret_type,
5008 argcount, &ufunc->uf_type_list);
5009 // Add argument types to the function type.
5010 if (func_type_add_arg_types(ufunc->uf_func_type,
5011 argcount + varargs,
5012 &ufunc->uf_type_list) == FAIL)
5013 return;
5014 ufunc->uf_func_type->tt_argcount = argcount + varargs;
5015 ufunc->uf_func_type->tt_min_argcount =
5016 argcount - ufunc->uf_def_args.ga_len;
5017 if (ufunc->uf_arg_types == NULL)
5018 {
5019 int i;
5020
5021 // lambda does not have argument types.
5022 for (i = 0; i < argcount; ++i)
5023 ufunc->uf_func_type->tt_args[i] = &t_any;
5024 }
5025 else
5026 mch_memmove(ufunc->uf_func_type->tt_args,
5027 ufunc->uf_arg_types, sizeof(type_T *) * argcount);
5028 if (varargs)
5029 {
5030 ufunc->uf_func_type->tt_args[argcount] =
Bram Moolenaar2a389082021-04-09 20:24:31 +02005031 ufunc->uf_va_type == NULL ? &t_list_any : ufunc->uf_va_type;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02005032 ufunc->uf_func_type->tt_flags = TTFLAG_VARARGS;
5033 }
5034 }
5035 else
5036 // No arguments, can use a predefined type.
5037 ufunc->uf_func_type = get_func_type(ufunc->uf_ret_type,
5038 argcount, &ufunc->uf_type_list);
5039}
5040
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005041/*
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01005042 * Free all instructions for "dfunc" except df_name.
Bram Moolenaar20431c92020-03-20 18:39:46 +01005043 */
5044 static void
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01005045delete_def_function_contents(dfunc_T *dfunc, int mark_deleted)
Bram Moolenaar20431c92020-03-20 18:39:46 +01005046{
5047 int idx;
5048
Bram Moolenaard505d172022-12-18 21:42:55 +00005049 // In same cases the instructions may refer to a class in which the
5050 // function is defined and unreferencing the class may call back here
5051 // recursively. Set the df_delete_busy to avoid problems.
5052 if (dfunc->df_delete_busy)
5053 return;
5054 dfunc->df_delete_busy = TRUE;
5055
Bram Moolenaar20431c92020-03-20 18:39:46 +01005056 ga_clear(&dfunc->df_def_args_isn);
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02005057 ga_clear_strings(&dfunc->df_var_names);
Bram Moolenaar20431c92020-03-20 18:39:46 +01005058
5059 if (dfunc->df_instr != NULL)
5060 {
5061 for (idx = 0; idx < dfunc->df_instr_count; ++idx)
5062 delete_instr(dfunc->df_instr + idx);
5063 VIM_CLEAR(dfunc->df_instr);
5064 }
Bram Moolenaarc2dec4c2021-06-13 15:39:00 +02005065 if (dfunc->df_instr_debug != NULL)
5066 {
5067 for (idx = 0; idx < dfunc->df_instr_debug_count; ++idx)
5068 delete_instr(dfunc->df_instr_debug + idx);
5069 VIM_CLEAR(dfunc->df_instr_debug);
Bram Moolenaarc2dec4c2021-06-13 15:39:00 +02005070 }
Bram Moolenaarc05fe072021-01-24 21:30:48 +01005071#ifdef FEAT_PROFILE
5072 if (dfunc->df_instr_prof != NULL)
5073 {
5074 for (idx = 0; idx < dfunc->df_instr_prof_count; ++idx)
5075 delete_instr(dfunc->df_instr_prof + idx);
5076 VIM_CLEAR(dfunc->df_instr_prof);
Bram Moolenaarc05fe072021-01-24 21:30:48 +01005077 }
5078#endif
Bram Moolenaar20431c92020-03-20 18:39:46 +01005079
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01005080 if (mark_deleted)
5081 dfunc->df_deleted = TRUE;
5082 if (dfunc->df_ufunc != NULL)
5083 dfunc->df_ufunc->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaard505d172022-12-18 21:42:55 +00005084
5085 dfunc->df_delete_busy = FALSE;
Bram Moolenaar20431c92020-03-20 18:39:46 +01005086}
5087
5088/*
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02005089 * When a user function is deleted, clear the contents of any associated def
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01005090 * function, unless another user function still uses it.
5091 * The position in def_functions can be re-used.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005092 */
5093 void
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01005094unlink_def_function(ufunc_T *ufunc)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005095{
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00005096 if (ufunc->uf_dfunc_idx <= 0)
5097 return;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005098
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00005099 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
5100 + ufunc->uf_dfunc_idx;
5101
5102 if (--dfunc->df_refcount <= 0)
5103 delete_def_function_contents(dfunc, TRUE);
5104 ufunc->uf_def_status = UF_NOT_COMPILED;
5105 ufunc->uf_dfunc_idx = 0;
5106 if (dfunc->df_ufunc == ufunc)
5107 dfunc->df_ufunc = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005108}
5109
Bram Moolenaarfdeab652020-09-19 15:16:50 +02005110/*
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01005111 * Used when a user function refers to an existing dfunc.
Bram Moolenaarfdeab652020-09-19 15:16:50 +02005112 */
5113 void
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01005114link_def_function(ufunc_T *ufunc)
Bram Moolenaarfdeab652020-09-19 15:16:50 +02005115{
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00005116 if (ufunc->uf_dfunc_idx <= 0)
5117 return;
Bram Moolenaarfdeab652020-09-19 15:16:50 +02005118
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00005119 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
5120 + ufunc->uf_dfunc_idx;
5121
5122 ++dfunc->df_refcount;
Bram Moolenaarfdeab652020-09-19 15:16:50 +02005123}
5124
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005125#if defined(EXITFREE) || defined(PROTO)
Bram Moolenaar20431c92020-03-20 18:39:46 +01005126/*
5127 * Free all functions defined with ":def".
5128 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005129 void
5130free_def_functions(void)
5131{
Bram Moolenaar20431c92020-03-20 18:39:46 +01005132 int idx;
5133
5134 for (idx = 0; idx < def_functions.ga_len; ++idx)
5135 {
5136 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data) + idx;
5137
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01005138 delete_def_function_contents(dfunc, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01005139 vim_free(dfunc->df_name);
Bram Moolenaar20431c92020-03-20 18:39:46 +01005140 }
5141
5142 ga_clear(&def_functions);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005143}
5144#endif
5145
5146
5147#endif // FEAT_EVAL