blob: fa02871e8b50cc81a54c9d29efcfce9b42a1ce68 [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{
Hirohito Higashi57f01192025-01-14 17:21:42 +0100781 static int nesting = 0;
Yegappan Lakshmanan782b43d2022-01-08 18:43:40 +0000782 scriptitem_T *si;
783 int idx;
784
785 if (!SCRIPT_ID_VALID(sid))
786 return NULL;
787 si = SCRIPT_ITEM(sid);
788 for (idx = 0; idx < si->sn_imports.ga_len; ++idx)
789 {
790 imported_T *import = ((imported_T *)si->sn_imports.ga_data) + idx;
791
792 if (len == 0 ? STRCMP(name, import->imp_name) == 0
793 : STRLEN(import->imp_name) == len
794 && STRNCMP(name, import->imp_name, len) == 0)
795 return import;
Hirohito Higashi57f01192025-01-14 17:21:42 +0100796 else
797 {
798 if (nesting >= p_mfd)
799 {
800 emsg(_(e_import_nesting_too_deep));
801 return NULL;
802 }
803 ++nesting;
804 import = find_imported_in_script(name, len, import->imp_sid);
805 --nesting;
806 if (import != NULL)
807 return import;
808 }
Yegappan Lakshmanan782b43d2022-01-08 18:43:40 +0000809 }
810 return NULL;
811}
812
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100813/*
Bram Moolenaar4b1d9632022-02-13 21:51:08 +0000814 * Find "name" in imported items of the current script.
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +0100815 * If "len" is 0 use any length that works.
Bram Moolenaardc4451d2022-01-09 21:36:37 +0000816 * If "load" is TRUE and the script was not loaded yet, load it now.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100817 */
818 imported_T *
Bram Moolenaar4b1d9632022-02-13 21:51:08 +0000819find_imported(char_u *name, size_t len, int load)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100820{
Bram Moolenaare3d46852020-08-29 13:39:17 +0200821 if (!SCRIPT_ID_VALID(current_sctx.sc_sid))
Bram Moolenaar8e6cbb72020-07-01 14:38:12 +0200822 return NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100823
Bram Moolenaarb775e722022-11-22 18:12:44 +0000824 // Skip over "s:" before "s:something" to find the import name.
825 int off = name[0] == 's' && name[1] == ':' ? 2 : 0;
826
827 imported_T *ret = find_imported_in_script(name + off, len - off,
828 current_sctx.sc_sid);
Bram Moolenaarb697dc22022-01-22 11:27:29 +0000829 if (ret != NULL && load && (ret->imp_flags & IMP_FLAGS_AUTOLOAD))
Bram Moolenaardc4451d2022-01-09 21:36:37 +0000830 {
Bram Moolenaar753885b2022-08-24 16:30:36 +0100831 scid_T actual_sid = 0;
Bram Moolenaar6809ff92022-07-26 15:10:56 +0100832 int save_emsg_off = emsg_off;
833
834 // "emsg_off" will be set when evaluating an expression silently, but
835 // we do want to know about errors in a script. Also because it then
836 // aborts when an error is encountered.
837 emsg_off = FALSE;
Bram Moolenaar17d36cb2022-01-12 11:46:40 +0000838
Bram Moolenaardc4451d2022-01-09 21:36:37 +0000839 // script found before but not loaded yet
Bram Moolenaarb697dc22022-01-22 11:27:29 +0000840 ret->imp_flags &= ~IMP_FLAGS_AUTOLOAD;
Bram Moolenaardc4451d2022-01-09 21:36:37 +0000841 (void)do_source(SCRIPT_ITEM(ret->imp_sid)->sn_name, FALSE,
Bram Moolenaar753885b2022-08-24 16:30:36 +0100842 DOSO_NONE, &actual_sid);
843 // If the script is a symlink it may be sourced with another name, may
844 // need to adjust the script ID for that.
845 if (actual_sid != 0)
846 ret->imp_sid = actual_sid;
Bram Moolenaar6809ff92022-07-26 15:10:56 +0100847
848 emsg_off = save_emsg_off;
Bram Moolenaardc4451d2022-01-09 21:36:37 +0000849 }
850 return ret;
Bram Moolenaarefa94442020-08-08 22:16:00 +0200851}
852
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100853/*
Bram Moolenaardc7c3662021-12-20 15:04:29 +0000854 * Called when checking for a following operator at "arg". When the rest of
855 * the line is empty or only a comment, peek the next line. If there is a next
856 * line return a pointer to it and set "nextp".
857 * Otherwise skip over white space.
858 */
859 char_u *
860may_peek_next_line(cctx_T *cctx, char_u *arg, char_u **nextp)
861{
862 char_u *p = skipwhite(arg);
863
864 *nextp = NULL;
865 if (*p == NUL || (VIM_ISWHITE(*arg) && vim9_comment_start(p)))
866 {
867 *nextp = peek_next_line_from_context(cctx);
868 if (*nextp != NULL)
869 return *nextp;
870 }
871 return p;
872}
873
874/*
Bram Moolenaar23c55272020-06-21 16:58:13 +0200875 * Return a pointer to the next line that isn't empty or only contains a
876 * comment. Skips over white space.
877 * Returns NULL if there is none.
878 */
Bram Moolenaar7a4b8982020-07-08 17:36:21 +0200879 char_u *
880peek_next_line_from_context(cctx_T *cctx)
Bram Moolenaar23c55272020-06-21 16:58:13 +0200881{
882 int lnum = cctx->ctx_lnum;
883
884 while (++lnum < cctx->ctx_ufunc->uf_lines.ga_len)
885 {
886 char_u *line = ((char_u **)cctx->ctx_ufunc->uf_lines.ga_data)[lnum];
Bram Moolenaaracd4c5e2020-06-22 19:39:03 +0200887 char_u *p;
Bram Moolenaar23c55272020-06-21 16:58:13 +0200888
Bram Moolenaarba60cc42020-08-12 19:15:33 +0200889 // ignore NULLs inserted for continuation lines
890 if (line != NULL)
891 {
892 p = skipwhite(line);
Bram Moolenaar4b3e1962021-03-18 21:37:55 +0100893 if (vim9_bad_comment(p))
894 return NULL;
Bram Moolenaarba60cc42020-08-12 19:15:33 +0200895 if (*p != NUL && !vim9_comment_start(p))
896 return p;
897 }
Bram Moolenaar23c55272020-06-21 16:58:13 +0200898 }
899 return NULL;
900}
901
902/*
Bram Moolenaare6085c52020-04-12 20:19:16 +0200903 * Get the next line of the function from "cctx".
Bram Moolenaar23c55272020-06-21 16:58:13 +0200904 * Skips over empty lines. Skips over comment lines if "skip_comment" is TRUE.
Bram Moolenaare6085c52020-04-12 20:19:16 +0200905 * Returns NULL when at the end.
906 */
Bram Moolenaar7a4b8982020-07-08 17:36:21 +0200907 char_u *
Bram Moolenaar23c55272020-06-21 16:58:13 +0200908next_line_from_context(cctx_T *cctx, int skip_comment)
Bram Moolenaare6085c52020-04-12 20:19:16 +0200909{
Bram Moolenaar7a092242020-04-16 22:10:49 +0200910 char_u *line;
Bram Moolenaare6085c52020-04-12 20:19:16 +0200911
912 do
913 {
914 ++cctx->ctx_lnum;
915 if (cctx->ctx_lnum >= cctx->ctx_ufunc->uf_lines.ga_len)
Bram Moolenaar7a092242020-04-16 22:10:49 +0200916 {
917 line = NULL;
Bram Moolenaare6085c52020-04-12 20:19:16 +0200918 break;
Bram Moolenaar7a092242020-04-16 22:10:49 +0200919 }
Bram Moolenaare6085c52020-04-12 20:19:16 +0200920 line = ((char_u **)cctx->ctx_ufunc->uf_lines.ga_data)[cctx->ctx_lnum];
Bram Moolenaar7a092242020-04-16 22:10:49 +0200921 cctx->ctx_line_start = line;
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200922 SOURCING_LNUM = cctx->ctx_lnum + 1;
Bram Moolenaar23c55272020-06-21 16:58:13 +0200923 } while (line == NULL || *skipwhite(line) == NUL
Bram Moolenaar2dd0a2c2020-08-08 15:10:27 +0200924 || (skip_comment && vim9_comment_start(skipwhite(line))));
Bram Moolenaare6085c52020-04-12 20:19:16 +0200925 return line;
926}
927
928/*
Bram Moolenaar5afd0812021-01-03 18:33:13 +0100929 * Skip over white space at "whitep" and assign to "*arg".
Bram Moolenaar9c7e6dd2020-04-12 20:55:20 +0200930 * If "*arg" is at the end of the line, advance to the next line.
Bram Moolenaar2c330432020-04-13 14:41:35 +0200931 * Also when "whitep" points to white space and "*arg" is on a "#".
Bram Moolenaar9c7e6dd2020-04-12 20:55:20 +0200932 * Return FAIL if beyond the last line, "*arg" is unmodified then.
933 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +0000934 int
Bram Moolenaar2c330432020-04-13 14:41:35 +0200935may_get_next_line(char_u *whitep, char_u **arg, cctx_T *cctx)
Bram Moolenaar9c7e6dd2020-04-12 20:55:20 +0200936{
Bram Moolenaar5afd0812021-01-03 18:33:13 +0100937 *arg = skipwhite(whitep);
Bram Moolenaar4b3e1962021-03-18 21:37:55 +0100938 if (vim9_bad_comment(*arg))
939 return FAIL;
Bram Moolenaarf5be8cd2020-07-17 20:36:00 +0200940 if (**arg == NUL || (VIM_ISWHITE(*whitep) && vim9_comment_start(*arg)))
Bram Moolenaar9c7e6dd2020-04-12 20:55:20 +0200941 {
Bram Moolenaar23c55272020-06-21 16:58:13 +0200942 char_u *next = next_line_from_context(cctx, TRUE);
Bram Moolenaar9c7e6dd2020-04-12 20:55:20 +0200943
944 if (next == NULL)
945 return FAIL;
946 *arg = skipwhite(next);
947 }
948 return OK;
949}
950
Bram Moolenaara7eedf32020-07-10 21:50:41 +0200951/*
952 * Idem, and give an error when failed.
953 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +0000954 int
Bram Moolenaara7eedf32020-07-10 21:50:41 +0200955may_get_next_line_error(char_u *whitep, char_u **arg, cctx_T *cctx)
956{
957 if (may_get_next_line(whitep, arg, cctx) == FAIL)
958 {
Bram Moolenaar8ff16e02020-12-07 21:49:52 +0100959 SOURCING_LNUM = cctx->ctx_lnum + 1;
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200960 emsg(_(e_line_incomplete));
Bram Moolenaara7eedf32020-07-10 21:50:41 +0200961 return FAIL;
962 }
963 return OK;
964}
965
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100966/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200967 * Get a line from the compilation context, compatible with exarg_T getline().
968 * Return a pointer to the line in allocated memory.
969 * Return NULL for end-of-file or some error.
970 */
971 static char_u *
972exarg_getline(
973 int c UNUSED,
974 void *cookie,
975 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +0200976 getline_opt_T options UNUSED)
Bram Moolenaar04b12692020-05-04 23:24:44 +0200977{
978 cctx_T *cctx = (cctx_T *)cookie;
Bram Moolenaar66250c92020-08-20 15:02:42 +0200979 char_u *p;
Bram Moolenaar04b12692020-05-04 23:24:44 +0200980
Bram Moolenaar66250c92020-08-20 15:02:42 +0200981 for (;;)
Bram Moolenaar04b12692020-05-04 23:24:44 +0200982 {
Bram Moolenaar2914a202020-09-27 18:24:03 +0200983 if (cctx->ctx_lnum >= cctx->ctx_ufunc->uf_lines.ga_len - 1)
Bram Moolenaar66250c92020-08-20 15:02:42 +0200984 return NULL;
985 ++cctx->ctx_lnum;
986 p = ((char_u **)cctx->ctx_ufunc->uf_lines.ga_data)[cctx->ctx_lnum];
987 // Comment lines result in NULL pointers, skip them.
988 if (p != NULL)
989 return vim_strsave(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +0200990 }
Bram Moolenaar04b12692020-05-04 23:24:44 +0200991}
992
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100993 void
994fill_exarg_from_cctx(exarg_T *eap, cctx_T *cctx)
995{
Zoltan Arpadffy6fdb6282023-12-19 20:53:07 +0100996 eap->ea_getline = exarg_getline;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100997 eap->cookie = cctx;
Bram Moolenaar4f3321f2022-03-13 13:12:27 +0000998 eap->skip = cctx->ctx_skip == SKIP_YES;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100999}
1000
Bram Moolenaar04b12692020-05-04 23:24:44 +02001001/*
Bram Moolenaardc7c3662021-12-20 15:04:29 +00001002 * Return TRUE if "ufunc" should be compiled, taking into account whether
1003 * "profile" indicates profiling is to be done.
1004 */
1005 int
1006func_needs_compiling(ufunc_T *ufunc, compiletype_T compile_type)
1007{
1008 switch (ufunc->uf_def_status)
1009 {
1010 case UF_TO_BE_COMPILED:
1011 return TRUE;
1012
1013 case UF_COMPILED:
1014 {
1015 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
1016 + ufunc->uf_dfunc_idx;
1017
1018 switch (compile_type)
1019 {
1020 case CT_PROFILE:
1021#ifdef FEAT_PROFILE
1022 return dfunc->df_instr_prof == NULL;
1023#endif
1024 case CT_NONE:
1025 return dfunc->df_instr == NULL;
1026 case CT_DEBUG:
1027 return dfunc->df_instr_debug == NULL;
1028 }
1029 }
1030
1031 case UF_NOT_COMPILED:
1032 case UF_COMPILE_ERROR:
1033 case UF_COMPILING:
1034 break;
1035 }
1036 return FALSE;
1037}
1038
1039/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02001040 * Compile a nested :def command.
1041 */
1042 static char_u *
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00001043compile_nested_function(exarg_T *eap, cctx_T *cctx, garray_T *lines_to_free)
Bram Moolenaar04b12692020-05-04 23:24:44 +02001044{
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001045 int is_global = *eap->arg == 'g' && eap->arg[1] == ':';
Bram Moolenaar04b12692020-05-04 23:24:44 +02001046 char_u *name_start = eap->arg;
Bram Moolenaarbcbf4132020-08-01 22:35:13 +02001047 char_u *name_end = to_name_end(eap->arg, TRUE);
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001048 int off;
1049 char_u *func_name;
Bram Moolenaareef21022020-08-01 22:16:43 +02001050 char_u *lambda_name;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001051 ufunc_T *ufunc;
Bram Moolenaar58a52f22020-12-22 18:56:55 +01001052 int r = FAIL;
Bram Moolenaarffcfddc2021-07-11 20:22:30 +02001053 compiletype_T compile_type;
Yegappan Lakshmanana76fbe62023-09-27 18:51:43 +02001054 int funcref_isn_idx = -1;
Bram Moolenaar1889f492022-08-16 19:34:44 +01001055 lvar_T *lvar = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001056
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +02001057 if (eap->forceit)
Bram Moolenaar8b848ca2020-09-10 22:28:01 +02001058 {
1059 emsg(_(e_cannot_use_bang_with_nested_def));
1060 return NULL;
1061 }
1062
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01001063 if (*name_start == '/')
1064 {
1065 name_end = skip_regexp(name_start + 1, '/', TRUE);
1066 if (*name_end == '/')
1067 ++name_end;
Bram Moolenaar63b91732021-08-05 20:40:03 +02001068 set_nextcmd(eap, name_end);
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01001069 }
1070 if (name_end == name_start || *skipwhite(name_end) != '(')
1071 {
1072 if (!ends_excmd2(name_start, name_end))
1073 {
Bram Moolenaardea5ab02022-02-23 22:12:02 +00001074 if (*skipwhite(name_end) == '.')
1075 semsg(_(e_cannot_define_dict_func_in_vim9_script_str),
1076 eap->cmd);
1077 else
1078 semsg(_(e_invalid_command_str), eap->cmd);
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01001079 return NULL;
1080 }
1081
1082 // "def" or "def Name": list functions
1083 if (generate_DEF(cctx, name_start, name_end - name_start) == FAIL)
1084 return NULL;
1085 return eap->nextcmd == NULL ? (char_u *)"" : eap->nextcmd;
1086 }
1087
Bram Moolenaarbcbf4132020-08-01 22:35:13 +02001088 // Only g:Func() can use a namespace.
1089 if (name_start[1] == ':' && !is_global)
1090 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02001091 semsg(_(e_namespace_not_supported_str), name_start);
Bram Moolenaarbcbf4132020-08-01 22:35:13 +02001092 return NULL;
1093 }
Bram Moolenaar4f3321f2022-03-13 13:12:27 +00001094 if (cctx->ctx_skip != SKIP_YES
1095 && check_defined(name_start, name_end - name_start, cctx,
Bram Moolenaardce24412022-02-08 20:35:30 +00001096 NULL, FALSE) == FAIL)
Bram Moolenaareef21022020-08-01 22:16:43 +02001097 return NULL;
Bram Moolenaarf681cfb2022-02-07 20:30:57 +00001098 if (!ASCII_ISUPPER(is_global ? name_start[2] : name_start[0]))
1099 {
Bram Moolenaar3787f262022-02-07 21:54:01 +00001100 semsg(_(e_function_name_must_start_with_capital_str), name_start);
Bram Moolenaarf681cfb2022-02-07 20:30:57 +00001101 return NULL;
1102 }
Bram Moolenaareef21022020-08-01 22:16:43 +02001103
Bram Moolenaar04b12692020-05-04 23:24:44 +02001104 eap->arg = name_end;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001105 fill_exarg_from_cctx(eap, cctx);
1106
Bram Moolenaar04b12692020-05-04 23:24:44 +02001107 eap->forceit = FALSE;
Bram Moolenaar38453522021-11-28 22:00:12 +00001108 // We use the special <Lamba>99 name, but it's not really a lambda.
Bram Moolenaar58a52f22020-12-22 18:56:55 +01001109 lambda_name = vim_strsave(get_lambda_name());
1110 if (lambda_name == NULL)
1111 return NULL;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001112
1113 // This may free the current line, make a copy of the name.
1114 off = is_global ? 2 : 0;
1115 func_name = vim_strnsave(name_start + off, name_end - name_start - off);
1116 if (func_name == NULL)
1117 {
1118 r = FAIL;
1119 goto theend;
1120 }
1121
Bram Moolenaar39c82ea2023-01-02 13:08:01 +00001122 // Make sure "KeyTyped" is not set, it may cause indent to be written.
1123 int save_KeyTyped = KeyTyped;
1124 KeyTyped = FALSE;
1125
h-eastb895b0f2023-09-24 15:46:31 +02001126 ufunc = define_function(eap, lambda_name, lines_to_free, 0, NULL, 0);
Bram Moolenaar39c82ea2023-01-02 13:08:01 +00001127
1128 KeyTyped = save_KeyTyped;
1129
Bram Moolenaar822ba242020-05-24 23:00:18 +02001130 if (ufunc == NULL)
Bram Moolenaar58a52f22020-12-22 18:56:55 +01001131 {
1132 r = eap->skip ? OK : FAIL;
1133 goto theend;
1134 }
Bram Moolenaar7473a842021-12-28 17:55:26 +00001135 if (eap->nextcmd != NULL)
1136 {
1137 semsg(_(e_text_found_after_str_str),
1138 eap->cmdidx == CMD_def ? "enddef" : "endfunction", eap->nextcmd);
1139 r = FAIL;
Bram Moolenaard2939812021-12-30 17:09:05 +00001140 func_ptr_unref(ufunc);
Bram Moolenaar7473a842021-12-28 17:55:26 +00001141 goto theend;
1142 }
Bram Moolenaar8863bda2021-03-17 18:42:08 +01001143
1144 // copy over the block scope IDs before compiling
1145 if (!is_global && cctx->ctx_ufunc->uf_block_depth > 0)
1146 {
1147 int block_depth = cctx->ctx_ufunc->uf_block_depth;
1148
1149 ufunc->uf_block_ids = ALLOC_MULT(int, block_depth);
1150 if (ufunc->uf_block_ids != NULL)
1151 {
1152 mch_memmove(ufunc->uf_block_ids, cctx->ctx_ufunc->uf_block_ids,
1153 sizeof(int) * block_depth);
1154 ufunc->uf_block_depth = block_depth;
1155 }
1156 }
1157
Bram Moolenaara915fa02022-03-23 11:29:15 +00001158 // Define the funcref before compiling, so that it is found by any
1159 // recursive call.
1160 if (is_global)
1161 {
Bram Moolenaar65449bd2022-09-19 16:02:43 +01001162 r = generate_NEWFUNC(cctx, lambda_name, func_name);
Bram Moolenaara915fa02022-03-23 11:29:15 +00001163 func_name = NULL;
1164 lambda_name = NULL;
1165 }
1166 else
1167 {
1168 // Define a local variable for the function reference.
Bram Moolenaar1889f492022-08-16 19:34:44 +01001169 lvar = reserve_local(cctx, func_name, name_end - name_start,
Bram Moolenaar6586a012022-09-30 11:04:50 +01001170 ASSIGN_CONST, ufunc->uf_func_type);
Bram Moolenaara915fa02022-03-23 11:29:15 +00001171 if (lvar == NULL)
1172 goto theend;
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02001173 if (generate_FUNCREF(cctx, ufunc, NULL, FALSE, 0, &funcref_isn_idx) == FAIL)
Bram Moolenaara915fa02022-03-23 11:29:15 +00001174 goto theend;
1175 r = generate_STORE(cctx, ISN_STORE, lvar->lv_idx, NULL);
1176 }
1177
Bram Moolenaar139575d2022-03-15 19:29:30 +00001178 compile_type = get_compile_type(ufunc);
Bram Moolenaarffcfddc2021-07-11 20:22:30 +02001179#ifdef FEAT_PROFILE
1180 // If the outer function is profiled, also compile the nested function for
1181 // profiling.
1182 if (cctx->ctx_compile_type == CT_PROFILE)
1183 compile_type = CT_PROFILE;
1184#endif
1185 if (func_needs_compiling(ufunc, compile_type)
1186 && compile_def_function(ufunc, TRUE, compile_type, cctx) == FAIL)
Bram Moolenaar4ee711f2020-09-23 18:51:11 +02001187 {
1188 func_ptr_unref(ufunc);
Bram Moolenaar1889f492022-08-16 19:34:44 +01001189 if (lvar != NULL)
1190 // Now the local variable can't be used.
1191 *lvar->lv_name = '/'; // impossible value
Bram Moolenaar58a52f22020-12-22 18:56:55 +01001192 goto theend;
Bram Moolenaar4ee711f2020-09-23 18:51:11 +02001193 }
Bram Moolenaar04b12692020-05-04 23:24:44 +02001194
Bram Moolenaar648594e2021-07-11 17:55:01 +02001195#ifdef FEAT_PROFILE
1196 // When the outer function is compiled for profiling, the nested function
1197 // may be called without profiling. Compile it here in the right context.
Bram Moolenaarffcfddc2021-07-11 20:22:30 +02001198 if (compile_type == CT_PROFILE && func_needs_compiling(ufunc, CT_NONE))
Bram Moolenaar648594e2021-07-11 17:55:01 +02001199 compile_def_function(ufunc, FALSE, CT_NONE, cctx);
1200#endif
1201
Bram Moolenaara915fa02022-03-23 11:29:15 +00001202 // If a FUNCREF instruction was generated, set the index after compiling.
Yegappan Lakshmanana76fbe62023-09-27 18:51:43 +02001203 if (funcref_isn_idx != -1 && ufunc->uf_def_status == UF_COMPILED)
1204 {
1205 isn_T *funcref_isn = ((isn_T *)cctx->ctx_instr.ga_data) +
1206 funcref_isn_idx;
Bram Moolenaara915fa02022-03-23 11:29:15 +00001207 funcref_isn->isn_arg.funcref.fr_dfunc_idx = ufunc->uf_dfunc_idx;
Yegappan Lakshmanana76fbe62023-09-27 18:51:43 +02001208 }
Bram Moolenaar58a52f22020-12-22 18:56:55 +01001209
1210theend:
1211 vim_free(lambda_name);
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001212 vim_free(func_name);
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001213 return r == FAIL ? NULL : (char_u *)"";
Bram Moolenaar04b12692020-05-04 23:24:44 +02001214}
1215
1216/*
Bram Moolenaar0abc2872022-05-10 13:24:30 +01001217 * Compile one Vim expression {expr} in string "p".
1218 * "p" points to the opening "{".
1219 * Return a pointer to the character after "}", NULL for an error.
1220 */
1221 char_u *
1222compile_one_expr_in_str(char_u *p, cctx_T *cctx)
1223{
1224 char_u *block_start;
1225 char_u *block_end;
1226
1227 // Skip the opening {.
1228 block_start = skipwhite(p + 1);
1229 block_end = block_start;
1230 if (*block_start != NUL && skip_expr(&block_end, NULL) == FAIL)
1231 return NULL;
1232 block_end = skipwhite(block_end);
1233 // The block must be closed by a }.
1234 if (*block_end != '}')
1235 {
1236 semsg(_(e_missing_close_curly_str), p);
1237 return NULL;
1238 }
1239 if (compile_expr0(&block_start, cctx) == FAIL)
1240 return NULL;
Yegappan Lakshmananbce51d92024-04-15 19:19:52 +02001241 may_generate_2STRING(-1, TOSTRING_INTERPOLATE, cctx);
Bram Moolenaar0abc2872022-05-10 13:24:30 +01001242
1243 return block_end + 1;
1244}
1245
1246/*
LemonBoy2eaef102022-05-06 13:14:50 +01001247 * Compile a string "str" (either containing a literal string or a mix of
1248 * literal strings and Vim expressions of the form `{expr}`). This is used
1249 * when compiling a heredoc assignment to a variable or an interpolated string
1250 * in a Vim9 def function. Vim9 instructions are generated to push strings,
1251 * evaluate expressions, concatenate them and create a list of lines. When
1252 * "evalstr" is TRUE, Vim expressions in "str" are evaluated.
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01001253 */
1254 int
LemonBoy2eaef102022-05-06 13:14:50 +01001255compile_all_expr_in_str(char_u *str, int evalstr, cctx_T *cctx)
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01001256{
LemonBoy2eaef102022-05-06 13:14:50 +01001257 char_u *p = str;
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01001258 char_u *val;
LemonBoy2eaef102022-05-06 13:14:50 +01001259 int count = 0;
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01001260
1261 if (cctx->ctx_skip == SKIP_YES)
1262 return OK;
1263
LemonBoy2eaef102022-05-06 13:14:50 +01001264 if (!evalstr || *str == NUL)
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01001265 {
LemonBoy2eaef102022-05-06 13:14:50 +01001266 // Literal string, possibly empty.
1267 val = *str != NUL ? vim_strsave(str) : NULL;
1268 return generate_PUSHS(cctx, &val);
1269 }
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01001270
LemonBoy2eaef102022-05-06 13:14:50 +01001271 // Push all the string pieces to the stack, followed by a ISN_CONCAT.
1272 while (*p != NUL)
1273 {
1274 char_u *lit_start;
LemonBoy2eaef102022-05-06 13:14:50 +01001275 int escaped_brace = FALSE;
1276
1277 // Look for a block start.
1278 lit_start = p;
1279 while (*p != '{' && *p != '}' && *p != NUL)
1280 ++p;
1281
1282 if (*p != NUL && *p == p[1])
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01001283 {
LemonBoy2eaef102022-05-06 13:14:50 +01001284 // Escaped brace, unescape and continue.
1285 // Include the brace in the literal string.
1286 ++p;
1287 escaped_brace = TRUE;
1288 }
1289 else if (*p == '}')
1290 {
1291 semsg(_(e_stray_closing_curly_str), str);
1292 return FAIL;
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01001293 }
LemonBoy372bcce2022-04-25 12:43:20 +01001294
LemonBoy2eaef102022-05-06 13:14:50 +01001295 // Append the literal part.
1296 if (p != lit_start)
1297 {
1298 val = vim_strnsave(lit_start, (size_t)(p - lit_start));
1299 if (generate_PUSHS(cctx, &val) == FAIL)
1300 return FAIL;
1301 ++count;
1302 }
1303
1304 if (*p == NUL)
1305 break;
1306
1307 if (escaped_brace)
1308 {
1309 // Skip the second brace.
1310 ++p;
1311 continue;
1312 }
1313
Bram Moolenaar0abc2872022-05-10 13:24:30 +01001314 p = compile_one_expr_in_str(p, cctx);
1315 if (p == NULL)
LemonBoy2eaef102022-05-06 13:14:50 +01001316 return FAIL;
LemonBoy2eaef102022-05-06 13:14:50 +01001317 ++count;
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01001318 }
LemonBoy2eaef102022-05-06 13:14:50 +01001319
1320 // Small optimization, if there's only a single piece skip the ISN_CONCAT.
Bram Moolenaar0abc2872022-05-10 13:24:30 +01001321 if (count > 1)
LemonBoy2eaef102022-05-06 13:14:50 +01001322 return generate_CONCAT(cctx, count);
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01001323
1324 return OK;
1325}
1326
1327/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001328 * Return the length of an assignment operator, or zero if there isn't one.
1329 */
1330 int
1331assignment_len(char_u *p, int *heredoc)
1332{
1333 if (*p == '=')
1334 {
1335 if (p[1] == '<' && p[2] == '<')
1336 {
1337 *heredoc = TRUE;
1338 return 3;
1339 }
1340 return 1;
1341 }
1342 if (vim_strchr((char_u *)"+-*/%", *p) != NULL && p[1] == '=')
1343 return 2;
1344 if (STRNCMP(p, "..=", 3) == 0)
1345 return 3;
1346 return 0;
1347}
1348
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001349/*
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001350 * Generate the load instruction for "name".
1351 */
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02001352 static int
Bram Moolenaard505d172022-12-18 21:42:55 +00001353generate_loadvar(cctx_T *cctx, lhs_T *lhs)
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001354{
Bram Moolenaard505d172022-12-18 21:42:55 +00001355 char_u *name = lhs->lhs_name;
1356 type_T *type = lhs->lhs_type;
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02001357 int res = OK;
Bram Moolenaard505d172022-12-18 21:42:55 +00001358
1359 switch (lhs->lhs_dest)
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001360 {
1361 case dest_option:
Bram Moolenaardcb53be2021-12-09 14:23:43 +00001362 case dest_func_option:
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001363 generate_LOAD(cctx, ISN_LOADOPT, 0, name, type);
1364 break;
1365 case dest_global:
Bram Moolenaar03290b82020-12-19 16:30:44 +01001366 if (vim_strchr(name, AUTOLOAD_CHAR) == NULL)
Bram Moolenaar2e17fef2022-03-18 19:44:48 +00001367 {
1368 if (name[2] == NUL)
1369 generate_instr_type(cctx, ISN_LOADGDICT, &t_dict_any);
1370 else
1371 generate_LOAD(cctx, ISN_LOADG, 0, name + 2, type);
1372 }
Bram Moolenaar03290b82020-12-19 16:30:44 +01001373 else
1374 generate_LOAD(cctx, ISN_LOADAUTO, 0, name, type);
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001375 break;
1376 case dest_buffer:
1377 generate_LOAD(cctx, ISN_LOADB, 0, name + 2, type);
1378 break;
1379 case dest_window:
1380 generate_LOAD(cctx, ISN_LOADW, 0, name + 2, type);
1381 break;
1382 case dest_tab:
1383 generate_LOAD(cctx, ISN_LOADT, 0, name + 2, type);
1384 break;
1385 case dest_script:
Ernie Rael3f821d62024-04-24 20:07:50 +02001386 case dest_script_v9:
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02001387 res = compile_load_scriptvar(cctx,
Bram Moolenaard0132f42022-05-12 11:05:40 +01001388 name + (name[1] == ':' ? 2 : 0), NULL, NULL);
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001389 break;
1390 case dest_env:
1391 // Include $ in the name here
1392 generate_LOAD(cctx, ISN_LOADENV, 0, name, type);
1393 break;
1394 case dest_reg:
1395 generate_LOAD(cctx, ISN_LOADREG, name[1], NULL, &t_string);
1396 break;
1397 case dest_vimvar:
Bram Moolenaarc3caa7f2022-05-25 19:15:10 +01001398 generate_LOADV(cctx, name + 2);
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001399 break;
1400 case dest_local:
Bram Moolenaar4875d6a2022-08-17 15:55:51 +01001401 if (cctx->ctx_skip != SKIP_YES)
1402 {
Bram Moolenaard505d172022-12-18 21:42:55 +00001403 lvar_T *lvar = lhs->lhs_lvar;
Bram Moolenaar4875d6a2022-08-17 15:55:51 +01001404 if (lvar->lv_from_outer > 0)
1405 generate_LOADOUTER(cctx, lvar->lv_idx, lvar->lv_from_outer,
Bram Moolenaar65449bd2022-09-19 16:02:43 +01001406 lvar->lv_loop_depth, lvar->lv_loop_idx, type);
Bram Moolenaar4875d6a2022-08-17 15:55:51 +01001407 else
1408 generate_LOAD(cctx, ISN_LOAD, lvar->lv_idx, NULL, type);
1409 }
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001410 break;
Bram Moolenaard505d172022-12-18 21:42:55 +00001411 case dest_class_member:
1412 generate_CLASSMEMBER(cctx, TRUE, lhs->lhs_class,
1413 lhs->lhs_classmember_idx);
1414 break;
Bram Moolenaardc234ca2020-11-28 18:52:33 +01001415 case dest_expr:
1416 // list or dict value should already be on the stack.
1417 break;
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001418 }
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02001419
1420 return res;
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001421}
1422
Bram Moolenaardc234ca2020-11-28 18:52:33 +01001423/*
1424 * Skip over "[expr]" or ".member".
1425 * Does not check for any errors.
1426 */
1427 static char_u *
1428skip_index(char_u *start)
1429{
1430 char_u *p = start;
1431
1432 if (*p == '[')
1433 {
1434 p = skipwhite(p + 1);
1435 (void)skip_expr(&p, NULL);
1436 p = skipwhite(p);
1437 if (*p == ']')
1438 return p + 1;
1439 return p;
1440 }
1441 // if (*p == '.')
1442 return to_name_end(p + 1, TRUE);
1443}
1444
Bram Moolenaare55b1c02020-06-21 15:52:59 +02001445 void
1446vim9_declare_error(char_u *name)
1447{
1448 char *scope = "";
1449
1450 switch (*name)
1451 {
Bram Moolenaar7fe87552020-06-21 20:38:28 +02001452 case 'g': scope = _("global"); break;
1453 case 'b': scope = _("buffer"); break;
1454 case 'w': scope = _("window"); break;
1455 case 't': scope = _("tab"); break;
1456 case 'v': scope = "v:"; break;
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00001457 case '$': semsg(_(e_cannot_declare_an_environment_variable_str), name);
Bram Moolenaarc2ee44c2020-08-02 16:59:00 +02001458 return;
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00001459 case '&': semsg(_(e_cannot_declare_an_option_str), name);
Bram Moolenaarc2ee44c2020-08-02 16:59:00 +02001460 return;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001461 case '@': semsg(_(e_cannot_declare_a_register_str), name);
Bram Moolenaarc2ee44c2020-08-02 16:59:00 +02001462 return;
Bram Moolenaar7fe87552020-06-21 20:38:28 +02001463 default: return;
Bram Moolenaare55b1c02020-06-21 15:52:59 +02001464 }
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00001465 semsg(_(e_cannot_declare_a_scope_variable_str), scope, name);
Bram Moolenaare55b1c02020-06-21 15:52:59 +02001466}
1467
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001468/*
Bram Moolenaar3558afe2022-10-13 16:12:57 +01001469 * Return TRUE if "name" is a valid register to use.
1470 * Return FALSE and give an error message if not.
1471 */
1472 static int
1473valid_dest_reg(int name)
1474{
1475 if ((name == '@' || valid_yank_reg(name, FALSE)) && name != '.')
1476 return TRUE;
1477 emsg_invreg(name);
1478 return FAIL;
1479}
1480
1481/*
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001482 * For one assignment figure out the type of destination. Return it in "dest".
1483 * When not recognized "dest" is not set.
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001484 * For an option "option_scope" is set.
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001485 * For a v:var "vimvaridx" is set.
1486 * "type" is set to the destination type if known, unchanted otherwise.
1487 * Return FAIL if an error message was given.
1488 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +00001489 int
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001490get_var_dest(
1491 char_u *name,
1492 assign_dest_T *dest,
Bram Moolenaar97f8c102022-04-02 19:43:57 +01001493 cmdidx_T cmdidx,
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001494 int *option_scope,
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001495 int *vimvaridx,
1496 type_T **type,
1497 cctx_T *cctx)
1498{
1499 char_u *p;
1500
1501 if (*name == '&')
1502 {
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001503 int cc;
1504 long numval;
1505 getoption_T opt_type;
Bram Moolenaardcb53be2021-12-09 14:23:43 +00001506 int opt_p_flags;
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001507
1508 *dest = dest_option;
1509 if (cmdidx == CMD_final || cmdidx == CMD_const)
1510 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00001511 emsg(_(e_cannot_lock_option));
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001512 return FAIL;
1513 }
1514 p = name;
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001515 p = find_option_end(&p, option_scope);
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001516 if (p == NULL)
1517 {
1518 // cannot happen?
Bram Moolenaar108010a2021-06-27 22:03:33 +02001519 emsg(_(e_unexpected_characters_in_assignment));
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001520 return FAIL;
1521 }
1522 cc = *p;
1523 *p = NUL;
1524 opt_type = get_option_value(skip_option_env_lead(name),
Bram Moolenaardcb53be2021-12-09 14:23:43 +00001525 &numval, NULL, &opt_p_flags, *option_scope);
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001526 *p = cc;
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001527 switch (opt_type)
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001528 {
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001529 case gov_unknown:
Bram Moolenaare1242042021-12-16 20:56:57 +00001530 semsg(_(e_unknown_option_str), name);
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001531 return FAIL;
1532 case gov_string:
1533 case gov_hidden_string:
Bram Moolenaardcb53be2021-12-09 14:23:43 +00001534 if (opt_p_flags & P_FUNC)
1535 {
1536 // might be a Funcref, check the type later
1537 *type = &t_any;
1538 *dest = dest_func_option;
1539 }
1540 else
1541 {
1542 *type = &t_string;
1543 }
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001544 break;
1545 case gov_bool:
1546 case gov_hidden_bool:
1547 *type = &t_bool;
1548 break;
1549 case gov_number:
1550 case gov_hidden_number:
1551 *type = &t_number;
1552 break;
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001553 }
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001554 }
1555 else if (*name == '$')
1556 {
1557 *dest = dest_env;
1558 *type = &t_string;
1559 }
1560 else if (*name == '@')
1561 {
Bram Moolenaar3558afe2022-10-13 16:12:57 +01001562 if (!valid_dest_reg(name[1]))
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001563 return FAIL;
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001564 *dest = dest_reg;
Bram Moolenaar74f4a962021-06-17 21:03:07 +02001565 *type = name[1] == '#' ? &t_number_or_string : &t_string;
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001566 }
1567 else if (STRNCMP(name, "g:", 2) == 0)
1568 {
1569 *dest = dest_global;
1570 }
1571 else if (STRNCMP(name, "b:", 2) == 0)
1572 {
1573 *dest = dest_buffer;
1574 }
1575 else if (STRNCMP(name, "w:", 2) == 0)
1576 {
1577 *dest = dest_window;
1578 }
1579 else if (STRNCMP(name, "t:", 2) == 0)
1580 {
1581 *dest = dest_tab;
1582 }
1583 else if (STRNCMP(name, "v:", 2) == 0)
1584 {
1585 typval_T *vtv;
1586 int di_flags;
1587
1588 *vimvaridx = find_vim_var(name + 2, &di_flags);
1589 if (*vimvaridx < 0)
1590 {
1591 semsg(_(e_variable_not_found_str), name);
1592 return FAIL;
1593 }
1594 // We use the current value of "sandbox" here, is that OK?
1595 if (var_check_ro(di_flags, name, FALSE))
1596 return FAIL;
1597 *dest = dest_vimvar;
1598 vtv = get_vim_var_tv(*vimvaridx);
1599 *type = typval2type_vimvar(vtv, cctx->ctx_type_list);
1600 }
1601 return OK;
1602}
1603
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02001604 static int
Bram Moolenaar97f8c102022-04-02 19:43:57 +01001605is_decl_command(cmdidx_T cmdidx)
Bram Moolenaar752fc692021-01-04 21:57:11 +01001606{
1607 return cmdidx == CMD_let || cmdidx == CMD_var
1608 || cmdidx == CMD_final || cmdidx == CMD_const;
1609}
1610
1611/*
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02001612 * Returns TRUE if the class or object variable in "lhs" is modifiable.
1613 * "var_start" points to the start of the variable name and "lhs->lhs_varlen"
1614 * has the total length. Note that the "lhs" can be nested an object reference
1615 * (e.g. a.b.c.d.var).
1616 */
1617 static int
1618lhs_class_member_modifiable(lhs_T *lhs, char_u *var_start, cctx_T *cctx)
1619{
1620 size_t varlen = lhs->lhs_varlen;
1621 class_T *cl = lhs->lhs_type->tt_class;
1622 int is_object = lhs->lhs_type->tt_type == VAR_OBJECT;
1623 char_u *name = var_start + varlen + 1;
1624 size_t namelen = lhs->lhs_end - var_start - varlen - 1;
1625 ocmember_T *m;
1626
1627 m = member_lookup(cl, lhs->lhs_type->tt_type, name, namelen, NULL);
1628 if (m == NULL)
1629 {
1630 member_not_found_msg(cl, lhs->lhs_type->tt_type, name, namelen);
1631 return FALSE;
1632 }
1633
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01001634 if (IS_ENUM(cl))
1635 {
1636 semsg(_(e_enumvalue_str_cannot_be_modified), cl->class_name,
1637 m->ocm_name);
1638 return FALSE;
1639 }
1640
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02001641 // If it is private member variable, then accessing it outside the
1642 // class is not allowed.
1643 // If it is a read only class variable, then it can be modified
1644 // only inside the class where it is defined.
1645 if ((m->ocm_access != VIM_ACCESS_ALL) &&
1646 ((is_object && !inside_class(cctx, cl))
1647 || (!is_object && cctx->ctx_ufunc->uf_class != cl)))
1648 {
1649 char *msg = (m->ocm_access == VIM_ACCESS_PRIVATE)
Ernie Rael03042a22023-11-11 08:53:32 +01001650 ? e_cannot_access_protected_variable_str
RestorerZ7fe8f432023-09-24 23:21:24 +02001651 : e_variable_is_not_writable_str;
Ernie Raele6c9aa52023-10-06 19:55:52 +02001652 emsg_var_cl_define(msg, m->ocm_name, 0, cl);
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02001653 return FALSE;
1654 }
1655
1656 return TRUE;
1657}
1658
1659/*
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001660 * Initialize "lhs" with default values
Bram Moolenaar752fc692021-01-04 21:57:11 +01001661 */
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001662 static void
1663lhs_init_defaults(lhs_T *lhs)
Bram Moolenaar752fc692021-01-04 21:57:11 +01001664{
Bram Moolenaar752fc692021-01-04 21:57:11 +01001665 CLEAR_POINTER(lhs);
1666 lhs->lhs_dest = dest_local;
1667 lhs->lhs_vimvaridx = -1;
1668 lhs->lhs_scriptvar_idx = -1;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001669 lhs->lhs_member_idx = -1;
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001670}
Bram Moolenaar752fc692021-01-04 21:57:11 +01001671
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001672/*
1673 * When compiling a LHS variable name, find the end of the destination and the
1674 * end of the variable name.
1675 */
1676 static int
1677lhs_find_var_end(
1678 lhs_T *lhs,
1679 char_u *var_start,
1680 int is_decl,
1681 char_u **var_endp)
1682{
1683 char_u *var_end = *var_endp;
1684
1685 // "lhs_dest_end" is the end of the destination, including "[expr]" or
Bram Moolenaar752fc692021-01-04 21:57:11 +01001686 // ".name".
1687 // "var_end" is the end of the variable/option/etc. name.
1688 lhs->lhs_dest_end = skip_var_one(var_start, FALSE);
1689 if (*var_start == '@')
Bram Moolenaar3558afe2022-10-13 16:12:57 +01001690 {
1691 if (!valid_dest_reg(var_start[1]))
1692 return FAIL;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001693 var_end = var_start + 2;
Bram Moolenaar3558afe2022-10-13 16:12:57 +01001694 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01001695 else
1696 {
1697 // skip over the leading "&", "&l:", "&g:" and "$"
1698 var_end = skip_option_env_lead(var_start);
1699 var_end = to_name_end(var_end, TRUE);
1700 }
1701
1702 // "a: type" is declaring variable "a" with a type, not dict "a:".
1703 if (is_decl && lhs->lhs_dest_end == var_start + 2
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001704 && lhs->lhs_dest_end[-1] == ':')
Bram Moolenaar752fc692021-01-04 21:57:11 +01001705 --lhs->lhs_dest_end;
1706 if (is_decl && var_end == var_start + 2 && var_end[-1] == ':')
1707 --var_end;
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001708
Bram Moolenaarab36e6a2021-11-30 16:14:49 +00001709 lhs->lhs_end = lhs->lhs_dest_end;
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001710 *var_endp = var_end;
1711
1712 return OK;
1713}
1714
1715/*
1716 * Set various fields in "lhs"
1717 */
1718 static int
1719lhs_init(
1720 lhs_T *lhs,
1721 char_u *var_start,
1722 int is_decl,
1723 int heredoc,
1724 char_u **var_endp)
1725{
1726 char_u *var_end = *var_endp;
1727
1728 lhs_init_defaults(lhs);
1729
1730 // Find the end of the variable and the destination
1731 if (lhs_find_var_end(lhs, var_start, is_decl, &var_end) == FAIL)
1732 return FAIL;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001733
1734 // compute the length of the destination without "[expr]" or ".name"
1735 lhs->lhs_varlen = var_end - var_start;
Bram Moolenaar753bcf82021-04-21 14:24:24 +02001736 lhs->lhs_varlen_total = lhs->lhs_varlen;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001737 lhs->lhs_name = vim_strnsave(var_start, lhs->lhs_varlen);
1738 if (lhs->lhs_name == NULL)
1739 return FAIL;
Bram Moolenaar08251752021-01-11 21:20:18 +01001740
1741 if (lhs->lhs_dest_end > var_start + lhs->lhs_varlen)
1742 // Something follows after the variable: "var[idx]" or "var.key".
1743 lhs->lhs_has_index = TRUE;
1744
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001745 lhs->lhs_type = heredoc ? &t_list_string : &t_any;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001746
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001747 *var_endp = var_end;
1748
1749 return OK;
1750}
1751
1752/*
1753 * Compile a LHS class variable name.
1754 */
1755 static int
1756compile_lhs_class_variable(
1757 cctx_T *cctx,
1758 lhs_T *lhs,
1759 class_T *defcl,
1760 int is_decl)
1761{
1762 if (cctx->ctx_ufunc->uf_defclass != defcl)
Bram Moolenaar752fc692021-01-04 21:57:11 +01001763 {
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001764 // A class variable can be accessed without the class name
1765 // only inside a class.
1766 semsg(_(e_class_variable_str_accessible_only_inside_class_str),
1767 lhs->lhs_name, defcl->class_name);
1768 return FAIL;
1769 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01001770
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001771 if (is_decl)
1772 {
1773 semsg(_(e_variable_already_declared_in_class_str), lhs->lhs_name);
1774 return FAIL;
1775 }
1776
1777 ocmember_T *m = &defcl->class_class_members[lhs->lhs_classmember_idx];
1778 if (oc_var_check_ro(defcl, m))
1779 return FAIL;
1780
1781 lhs->lhs_dest = dest_class_member;
1782 // The class variable is defined either in the current class or
1783 // in one of the parent class in the hierarchy.
1784 lhs->lhs_class = defcl;
1785 lhs->lhs_type = oc_member_type_by_idx(defcl, FALSE,
1786 lhs->lhs_classmember_idx);
1787
1788 return OK;
1789}
1790
1791/*
1792 * Compile an imported LHS variable
1793 */
1794 static int
1795compile_lhs_import_var(
1796 lhs_T *lhs,
1797 imported_T *import,
1798 char_u *var_start,
1799 char_u **var_endp,
1800 char_u **rawnamep)
1801{
1802 char_u *var_end = *var_endp;
1803 char_u *dot = vim_strchr(var_start, '.');
1804 char_u *p;
1805
1806 // for an import the name is what comes after the dot
1807 if (dot == NULL)
1808 {
1809 semsg(_(e_no_dot_after_imported_name_str), var_start);
1810 return FAIL;
1811 }
1812
1813 p = skipwhite(dot + 1);
1814 var_end = to_name_end(p, TRUE);
1815 if (var_end == p)
1816 {
1817 semsg(_(e_missing_name_after_imported_name_str), var_start);
1818 return FAIL;
1819 }
1820
1821 vim_free(lhs->lhs_name);
1822 lhs->lhs_varlen = var_end - p;
1823 lhs->lhs_name = vim_strnsave(p, lhs->lhs_varlen);
1824 if (lhs->lhs_name == NULL)
1825 return FAIL;
1826 *rawnamep = lhs->lhs_name;
1827 lhs->lhs_scriptvar_sid = import->imp_sid;
1828
1829 // TODO: where do we check this name is exported?
1830
1831 // Check if something follows: "exp.var[idx]" or
1832 // "exp.var.key".
1833 lhs->lhs_has_index = lhs->lhs_dest_end > skipwhite(var_end);
1834
1835 *var_endp = var_end;
1836
1837 return OK;
1838}
1839
1840/*
1841 * Process a script-local variable when compiling a LHS variable name.
1842 */
1843 static int
1844compile_lhs_script_var(
1845 cctx_T *cctx,
1846 lhs_T *lhs,
1847 char_u *var_start,
1848 char_u *var_end,
1849 int is_decl)
1850{
1851 int script_namespace = FALSE;
1852 int script_var = FALSE;
1853 imported_T *import;
1854 char_u *var_name;
Yegappan Lakshmanan084529c2024-12-24 09:50:01 +01001855 size_t var_name_len;
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001856
1857 if (lhs->lhs_varlen > 1 && STRNCMP(var_start, "s:", 2) == 0)
1858 script_namespace = TRUE;
1859
1860 if (script_namespace)
1861 {
1862 var_name = var_start + 2;
1863 var_name_len = lhs->lhs_varlen - 2;
1864 }
1865 else
1866 {
1867 var_name = var_start;
1868 var_name_len = lhs->lhs_varlen;
1869 }
1870
1871 if (script_var_exists(var_name, var_name_len, cctx, NULL) == OK)
1872 script_var = TRUE;
1873
1874 import = find_imported(var_start, lhs->lhs_varlen, FALSE);
1875
1876 if (script_namespace || script_var || import != NULL)
1877 {
1878 char_u *rawname = lhs->lhs_name + (lhs->lhs_name[1] == ':' ? 2 : 0);
1879
1880 if (script_namespace && current_script_is_vim9())
Bram Moolenaar752fc692021-01-04 21:57:11 +01001881 {
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001882 semsg(_(e_cannot_use_s_colon_in_vim9_script_str), var_start);
1883 return FAIL;
1884 }
1885
1886 if (is_decl)
1887 {
1888 if (script_namespace)
1889 semsg(_(e_cannot_declare_script_variable_in_function_str),
1890 lhs->lhs_name);
1891 else
1892 semsg(_(e_variable_already_declared_in_script_str),
1893 lhs->lhs_name);
1894 return FAIL;
1895 }
1896 else if (cctx->ctx_ufunc->uf_script_ctx_version == SCRIPT_VERSION_VIM9
1897 && script_namespace
1898 && !script_var && import == NULL)
1899 {
1900 semsg(_(e_unknown_variable_str), lhs->lhs_name);
1901 return FAIL;
1902 }
1903
1904 lhs->lhs_dest = current_script_is_vim9() ? dest_script_v9 :
1905 dest_script;
1906
1907 // existing script-local variables should have a type
1908 lhs->lhs_scriptvar_sid = current_sctx.sc_sid;
1909 if (import != NULL)
1910 {
1911 if (compile_lhs_import_var(lhs, import, var_start, &var_end,
1912 &rawname) == FAIL)
1913 return FAIL;
1914 }
1915
1916 if (SCRIPT_ID_VALID(lhs->lhs_scriptvar_sid))
1917 {
1918 // Check writable only when no index follows.
1919 lhs->lhs_scriptvar_idx = get_script_item_idx(
1920 lhs->lhs_scriptvar_sid, rawname,
1921 lhs->lhs_has_index ? ASSIGN_FINAL :
1922 ASSIGN_CONST, cctx, NULL);
1923 if (lhs->lhs_scriptvar_idx >= 0)
1924 {
1925 scriptitem_T *si = SCRIPT_ITEM(lhs->lhs_scriptvar_sid);
1926 svar_T *sv = ((svar_T *)si->sn_var_vals.ga_data)
1927 + lhs->lhs_scriptvar_idx;
1928
1929 lhs->lhs_type = sv->sv_type;
1930 }
1931 }
1932
1933 return OK;
1934 }
1935
1936 return check_defined(var_start, lhs->lhs_varlen, cctx, NULL, FALSE);
1937}
1938
1939/*
1940 * Compile the LHS destination.
1941 */
1942 static int
1943compile_lhs_var_dest(
1944 cctx_T *cctx,
1945 lhs_T *lhs,
1946 int cmdidx,
1947 char_u *var_start,
1948 char_u *var_end,
1949 int is_decl)
1950{
1951 int declare_error = FALSE;
1952
1953 if (get_var_dest(lhs->lhs_name, &lhs->lhs_dest, cmdidx,
1954 &lhs->lhs_opt_flags, &lhs->lhs_vimvaridx,
1955 &lhs->lhs_type, cctx) == FAIL)
1956 return FAIL;
1957
1958 if (lhs->lhs_dest != dest_local && cmdidx != CMD_const
1959 && cmdidx != CMD_final)
1960 {
1961 // Specific kind of variable recognized.
1962 declare_error = is_decl;
1963 }
1964 else
1965 {
1966 class_T *defcl;
1967
1968 // No specific kind of variable recognized, just a name.
1969 if (check_reserved_name(lhs->lhs_name, lhs->lhs_has_index
1970 && *var_end == '.') == FAIL)
1971 return FAIL;
1972
1973 if (lookup_local(var_start, lhs->lhs_varlen, &lhs->lhs_local_lvar,
1974 cctx) == OK)
1975 {
1976 lhs->lhs_lvar = &lhs->lhs_local_lvar;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001977 }
1978 else
1979 {
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001980 CLEAR_FIELD(lhs->lhs_arg_lvar);
1981 if (arg_exists(var_start, lhs->lhs_varlen,
1982 &lhs->lhs_arg_lvar.lv_idx, &lhs->lhs_arg_lvar.lv_type,
1983 &lhs->lhs_arg_lvar.lv_from_outer, cctx) == OK)
Bram Moolenaar752fc692021-01-04 21:57:11 +01001984 {
1985 if (is_decl)
1986 {
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001987 semsg(_(e_str_is_used_as_argument), lhs->lhs_name);
Bram Moolenaar752fc692021-01-04 21:57:11 +01001988 return FAIL;
1989 }
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001990 lhs->lhs_lvar = &lhs->lhs_arg_lvar;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001991 }
1992 }
1993
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001994 if (lhs->lhs_lvar != NULL)
Bram Moolenaar752fc692021-01-04 21:57:11 +01001995 {
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001996 if (is_decl)
1997 {
1998 // if we come here with what looks like an assignment like
1999 // .= but which has been rejected by assignment_len() from
2000 // may_compile_assignment give a better error message
2001 char_u *p = skipwhite(lhs->lhs_end);
2002 if (p[0] == '.' && p[1] == '=')
2003 emsg(_(e_dot_equal_not_supported_with_script_version_two));
2004 else if (p[0] == ':')
2005 // type specified in a non-var assignment
2006 semsg(_(e_trailing_characters_str), p);
2007 else
2008 semsg(_(e_variable_already_declared_str), lhs->lhs_name);
2009 return FAIL;
2010 }
2011 }
2012 else if ((lhs->lhs_classmember_idx = cctx_class_member_idx(
2013 cctx, var_start, lhs->lhs_varlen, &defcl)) >= 0)
2014 {
2015 if (compile_lhs_class_variable(cctx, lhs, defcl, is_decl)
2016 == FAIL)
2017 return FAIL;
2018 }
2019 else
2020 {
2021 if (compile_lhs_script_var(cctx, lhs, var_start, var_end,
2022 is_decl) == FAIL)
2023 return FAIL;
2024 }
2025 }
2026
2027 if (declare_error)
2028 {
2029 vim9_declare_error(lhs->lhs_name);
2030 return FAIL;
2031 }
2032
2033 return OK;
2034}
2035
2036/*
2037 * When compiling a LHS variable name, for a class or an object, set the LHS
2038 * member type.
2039 */
2040 static int
2041compile_lhs_set_oc_member_type(
2042 cctx_T *cctx,
2043 lhs_T *lhs,
2044 char_u *var_start)
2045{
2046 class_T *cl = lhs->lhs_type->tt_class;
2047 int is_object = lhs->lhs_type->tt_type == VAR_OBJECT;
2048 char_u *name = var_start + lhs->lhs_varlen + 1;
2049 size_t namelen = lhs->lhs_end - var_start - lhs->lhs_varlen - 1;
2050
2051 ocmember_T *m = member_lookup(cl, lhs->lhs_type->tt_type,
2052 name, namelen, &lhs->lhs_member_idx);
2053 if (m == NULL)
2054 {
2055 member_not_found_msg(cl, lhs->lhs_type->tt_type, name, namelen);
2056 return FAIL;
2057 }
2058
2059 if (IS_ENUM(cl))
2060 {
2061 if (!inside_class(cctx, cl))
2062 {
2063 semsg(_(e_enumvalue_str_cannot_be_modified),
2064 cl->class_name, m->ocm_name);
Bram Moolenaar752fc692021-01-04 21:57:11 +01002065 return FAIL;
2066 }
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01002067 if (lhs->lhs_type->tt_type == VAR_OBJECT &&
2068 lhs->lhs_member_idx < 2)
2069 {
2070 char *msg = lhs->lhs_member_idx == 0 ?
2071 e_enum_str_name_cannot_be_modified :
2072 e_enum_str_ordinal_cannot_be_modified;
2073 semsg(_(msg), cl->class_name);
2074 return FAIL;
2075 }
2076 }
2077
2078 // If it is private member variable, then accessing it outside the
2079 // class is not allowed.
2080 // If it is a read only class variable, then it can be modified
2081 // only inside the class where it is defined.
2082 if ((m->ocm_access != VIM_ACCESS_ALL) &&
2083 ((is_object && !inside_class(cctx, cl))
2084 || (!is_object && cctx->ctx_ufunc->uf_class != cl)))
2085 {
2086 char *msg = (m->ocm_access == VIM_ACCESS_PRIVATE)
2087 ? e_cannot_access_protected_variable_str
2088 : e_variable_is_not_writable_str;
2089 emsg_var_cl_define(msg, m->ocm_name, 0, cl);
2090 return FAIL;
2091 }
2092
2093 if (!IS_CONSTRUCTOR_METHOD(cctx->ctx_ufunc)
2094 && oc_var_check_ro(cl, m))
2095 return FAIL;
2096
2097 lhs->lhs_member_type = m->ocm_type;
2098
2099 return OK;
2100}
2101
2102/*
2103 * When compiling a LHS variable, set the LHS variable type.
2104 */
2105 static int
2106compile_lhs_set_type(cctx_T *cctx, lhs_T *lhs, char_u *var_end, int is_decl)
2107{
2108 if (is_decl && *skipwhite(var_end) == ':')
2109 {
2110 char_u *p;
2111
2112 // parse optional type: "let var: type = expr"
2113 if (VIM_ISWHITE(*var_end))
2114 {
2115 semsg(_(e_no_white_space_allowed_before_colon_str), var_end);
2116 return FAIL;
2117 }
2118
2119 if (!VIM_ISWHITE(var_end[1]))
2120 {
2121 semsg(_(e_white_space_required_after_str_str), ":", var_end);
2122 return FAIL;
2123 }
2124
2125 p = skipwhite(var_end + 1);
2126 lhs->lhs_type = parse_type(&p, cctx->ctx_type_list, TRUE);
2127 if (lhs->lhs_type == NULL)
2128 return FAIL;
2129
2130 lhs->lhs_has_type = TRUE;
2131 lhs->lhs_end = p;
2132 }
2133 else if (lhs->lhs_lvar != NULL)
2134 lhs->lhs_type = lhs->lhs_lvar->lv_type;
2135
2136 return OK;
2137}
2138
2139/*
2140 * Returns TRUE if "lhs" is a concatenable string.
2141 */
2142 static int
2143lhs_concatenable(lhs_T *lhs)
2144{
2145 return lhs->lhs_dest == dest_global
2146 || lhs->lhs_has_index
2147 || lhs->lhs_type->tt_type == VAR_STRING
2148 || lhs->lhs_type->tt_type == VAR_ANY;
2149}
2150
2151/*
2152 * Create a new local variable when compiling a LHS variable.
2153 */
2154 static int
2155compile_lhs_new_local_var(
2156 cctx_T *cctx,
2157 lhs_T *lhs,
2158 char_u *var_start,
2159 int cmdidx,
2160 int oplen,
2161 int is_decl,
2162 int has_cmd,
2163 int heredoc)
2164{
2165 if (oplen > 1 && !heredoc)
2166 {
2167 // +=, /=, etc. require an existing variable
2168 semsg(_(e_cannot_use_operator_on_new_variable_str), lhs->lhs_name);
2169 return FAIL;
2170 }
2171
2172 if (!is_decl || (lhs->lhs_has_index && !has_cmd
2173 && cctx->ctx_skip != SKIP_YES))
2174 {
2175 semsg(_(e_unknown_variable_str), lhs->lhs_name);
2176 return FAIL;
2177 }
2178
2179 // Check the name is valid for a funcref.
2180 if (lhs->lhs_type->tt_type == VAR_FUNC
2181 || lhs->lhs_type->tt_type == VAR_PARTIAL)
2182 {
2183 if (var_wrong_func_name(lhs->lhs_name, TRUE))
2184 return FAIL;
2185 }
2186
2187 // New local variable.
2188 int assign;
2189 switch (cmdidx)
2190 {
2191 case CMD_final:
2192 assign = ASSIGN_FINAL; break;
2193 case CMD_const:
2194 assign = ASSIGN_CONST; break;
2195 default:
2196 assign = ASSIGN_VAR; break;
2197 }
2198
2199 lhs->lhs_lvar = reserve_local(cctx, var_start, lhs->lhs_varlen, assign,
2200 lhs->lhs_type);
2201 if (lhs->lhs_lvar == NULL)
2202 return FAIL;
2203
2204 lhs->lhs_new_local = TRUE;
2205
2206 return OK;
2207}
2208
2209/*
2210 * When compiling a LHS variable name, set the LHS member type.
2211 */
2212 static int
2213compile_lhs_set_member_type(
2214 cctx_T *cctx,
2215 lhs_T *lhs,
2216 char_u *var_start,
2217 int is_decl,
2218 int has_cmd)
2219{
2220 lhs->lhs_member_type = lhs->lhs_type;
2221
2222 if (!lhs->lhs_has_index)
2223 return OK;
2224
2225 char_u *after = var_start + lhs->lhs_varlen;
2226 char_u *p;
2227
2228 // Something follows after the variable: "var[idx]" or "var.key".
2229 if (is_decl && cctx->ctx_skip != SKIP_YES)
2230 {
2231 if (has_cmd)
2232 emsg(_(e_cannot_use_index_when_declaring_variable));
2233 else
2234 semsg(_(e_unknown_variable_str), lhs->lhs_name);
2235 return FAIL;
2236 }
2237
2238 // Now: var_start[lhs->lhs_varlen] is '[' or '.'
2239 // Only the last index is used below, if there are others
2240 // before it generate code for the expression. Thus for
2241 // "ll[1][2]" the expression is "ll[1]" and "[2]" is the index.
2242 for (;;)
2243 {
2244 p = skip_index(after);
2245 if (*p != '[' && *p != '.')
2246 {
2247 lhs->lhs_varlen_total = p - var_start;
2248 break;
2249 }
2250 after = p;
2251 }
2252 if (after > var_start + lhs->lhs_varlen)
2253 {
2254 lhs->lhs_varlen = after - var_start;
2255 lhs->lhs_dest = dest_expr;
2256 // We don't know the type before evaluating the expression,
2257 // use "any" until then.
2258 lhs->lhs_type = &t_any;
2259 }
2260
2261 int use_class = lhs->lhs_type != NULL
2262 && (lhs->lhs_type->tt_type == VAR_CLASS
2263 || lhs->lhs_type->tt_type == VAR_OBJECT);
2264
2265 if (lhs->lhs_type == NULL
2266 || (use_class ? lhs->lhs_type->tt_class == NULL
2267 : lhs->lhs_type->tt_member == NULL))
2268 {
2269 lhs->lhs_member_type = &t_any;
2270 }
2271 else if (use_class)
2272 {
2273 // for an object or class member get the type of the member
2274 if (compile_lhs_set_oc_member_type(cctx, lhs, var_start) == FAIL)
2275 return FAIL;
2276 }
2277 else
2278 lhs->lhs_member_type = lhs->lhs_type->tt_member;
2279
2280 return OK;
2281}
2282
2283/*
2284 * Figure out the LHS type and other properties for an assignment or one item
2285 * of ":unlet" with an index.
2286 * Returns OK or FAIL.
2287 */
2288 int
2289compile_lhs(
2290 char_u *var_start,
2291 lhs_T *lhs,
2292 cmdidx_T cmdidx,
2293 int heredoc,
2294 int has_cmd, // "var" before "var_start"
2295 int oplen,
2296 cctx_T *cctx)
2297{
Yegappan Lakshmanan59c88802024-12-19 20:00:31 +01002298 char_u *var_end = NULL;
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01002299 int is_decl = is_decl_command(cmdidx);
2300
2301 if (lhs_init(lhs, var_start, is_decl, heredoc, &var_end) == FAIL)
2302 return FAIL;
2303
2304 if (cctx->ctx_skip != SKIP_YES)
2305 {
2306 // compile the LHS destination
2307 if (compile_lhs_var_dest(cctx, lhs, cmdidx, var_start, var_end,
2308 is_decl) == FAIL)
2309 return FAIL;
Bram Moolenaar752fc692021-01-04 21:57:11 +01002310 }
2311
Bram Moolenaarab36e6a2021-11-30 16:14:49 +00002312 // handle "a:name" as a name, not index "name" in "a"
Bram Moolenaar752fc692021-01-04 21:57:11 +01002313 if (lhs->lhs_varlen > 1 || var_start[lhs->lhs_varlen] != ':')
2314 var_end = lhs->lhs_dest_end;
2315
Bram Moolenaardcb53be2021-12-09 14:23:43 +00002316 if (lhs->lhs_dest != dest_option && lhs->lhs_dest != dest_func_option)
Bram Moolenaar752fc692021-01-04 21:57:11 +01002317 {
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01002318 // set the LHS variable type
2319 if (compile_lhs_set_type(cctx, lhs, var_end, is_decl) == FAIL)
2320 return FAIL;
Bram Moolenaar752fc692021-01-04 21:57:11 +01002321 }
2322
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01002323 if (oplen == 3 && !heredoc && !lhs_concatenable(lhs))
Bram Moolenaar752fc692021-01-04 21:57:11 +01002324 {
2325 emsg(_(e_can_only_concatenate_to_string));
2326 return FAIL;
2327 }
2328
2329 if (lhs->lhs_lvar == NULL && lhs->lhs_dest == dest_local
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01002330 && cctx->ctx_skip != SKIP_YES)
Bram Moolenaar752fc692021-01-04 21:57:11 +01002331 {
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01002332 if (compile_lhs_new_local_var(cctx, lhs, var_start, cmdidx, oplen,
2333 is_decl, has_cmd, heredoc) == FAIL)
Bram Moolenaar752fc692021-01-04 21:57:11 +01002334 return FAIL;
Bram Moolenaar752fc692021-01-04 21:57:11 +01002335 }
2336
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01002337 if (compile_lhs_set_member_type(cctx, lhs, var_start, is_decl, has_cmd)
2338 == FAIL)
2339 return FAIL;
Bram Moolenaarc750d912021-11-29 22:02:12 +00002340
Bram Moolenaar752fc692021-01-04 21:57:11 +01002341 return OK;
2342}
2343
2344/*
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002345 * Figure out the LHS and check a few errors.
2346 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +00002347 int
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002348compile_assign_lhs(
Bram Moolenaar97f8c102022-04-02 19:43:57 +01002349 char_u *var_start,
2350 lhs_T *lhs,
2351 cmdidx_T cmdidx,
2352 int is_decl,
2353 int heredoc,
2354 int has_cmd, // "var" before "var_start"
2355 int oplen,
2356 cctx_T *cctx)
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002357{
Bram Moolenaar97f8c102022-04-02 19:43:57 +01002358 if (compile_lhs(var_start, lhs, cmdidx, heredoc, has_cmd, oplen, cctx)
2359 == FAIL)
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002360 return FAIL;
2361
2362 if (!lhs->lhs_has_index && lhs->lhs_lvar == &lhs->lhs_arg_lvar)
2363 {
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00002364 semsg(_(e_cannot_assign_to_argument_str), lhs->lhs_name);
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002365 return FAIL;
2366 }
2367 if (!is_decl && lhs->lhs_lvar != NULL
Bram Moolenaar6586a012022-09-30 11:04:50 +01002368 && lhs->lhs_lvar->lv_const != ASSIGN_VAR
2369 && !lhs->lhs_has_index)
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002370 {
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00002371 semsg(_(e_cannot_assign_to_constant_str), lhs->lhs_name);
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002372 return FAIL;
2373 }
2374 return OK;
2375}
2376
2377/*
Bram Moolenaar4f0884d2021-08-11 21:49:23 +02002378 * Return TRUE if "lhs" has a range index: "[expr : expr]".
2379 */
2380 static int
2381has_list_index(char_u *idx_start, cctx_T *cctx)
2382{
2383 char_u *p = idx_start;
2384 int save_skip;
2385
2386 if (*p != '[')
2387 return FALSE;
2388
2389 p = skipwhite(p + 1);
2390 if (*p == ':')
2391 return TRUE;
2392
2393 save_skip = cctx->ctx_skip;
2394 cctx->ctx_skip = SKIP_YES;
2395 (void)compile_expr0(&p, cctx);
2396 cctx->ctx_skip = save_skip;
2397 return *skipwhite(p) == ':';
2398}
2399
2400/*
Bram Moolenaare42939a2021-04-05 17:11:17 +02002401 * For an assignment with an index, compile the "idx" in "var[idx]" or "key" in
2402 * "var.key".
Bram Moolenaar752fc692021-01-04 21:57:11 +01002403 */
2404 static int
Bram Moolenaare42939a2021-04-05 17:11:17 +02002405compile_assign_index(
Bram Moolenaar752fc692021-01-04 21:57:11 +01002406 char_u *var_start,
2407 lhs_T *lhs,
Bram Moolenaare42939a2021-04-05 17:11:17 +02002408 int *range,
Bram Moolenaar752fc692021-01-04 21:57:11 +01002409 cctx_T *cctx)
2410{
Bram Moolenaar752fc692021-01-04 21:57:11 +01002411 size_t varlen = lhs->lhs_varlen;
Bram Moolenaare42939a2021-04-05 17:11:17 +02002412 char_u *p;
2413 int r = OK;
Bram Moolenaar68452172021-04-12 21:21:02 +02002414 int need_white_before = TRUE;
2415 int empty_second;
Bram Moolenaar752fc692021-01-04 21:57:11 +01002416
Bram Moolenaar752fc692021-01-04 21:57:11 +01002417 p = var_start + varlen;
2418 if (*p == '[')
2419 {
2420 p = skipwhite(p + 1);
Bram Moolenaar68452172021-04-12 21:21:02 +02002421 if (*p == ':')
2422 {
2423 // empty first index, push zero
2424 r = generate_PUSHNR(cctx, 0);
2425 need_white_before = FALSE;
2426 }
2427 else
2428 r = compile_expr0(&p, cctx);
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002429
2430 if (r == OK && *skipwhite(p) == ':')
2431 {
2432 // unlet var[idx : idx]
Bram Moolenaar68452172021-04-12 21:21:02 +02002433 // blob[idx : idx] = value
Bram Moolenaare42939a2021-04-05 17:11:17 +02002434 *range = TRUE;
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002435 p = skipwhite(p);
Bram Moolenaar68452172021-04-12 21:21:02 +02002436 empty_second = *skipwhite(p + 1) == ']';
2437 if ((need_white_before && !IS_WHITE_OR_NUL(p[-1]))
2438 || (!empty_second && !IS_WHITE_OR_NUL(p[1])))
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002439 {
2440 semsg(_(e_white_space_required_before_and_after_str_at_str),
2441 ":", p);
2442 return FAIL;
2443 }
2444 p = skipwhite(p + 1);
Bram Moolenaar68452172021-04-12 21:21:02 +02002445 if (*p == ']')
2446 // empty second index, push "none"
2447 r = generate_PUSHSPEC(cctx, VVAL_NONE);
2448 else
2449 r = compile_expr0(&p, cctx);
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002450 }
2451
Bram Moolenaar752fc692021-01-04 21:57:11 +01002452 if (r == OK && *skipwhite(p) != ']')
2453 {
2454 // this should not happen
Bram Moolenaare1242042021-12-16 20:56:57 +00002455 emsg(_(e_missing_closing_square_brace));
Bram Moolenaar752fc692021-01-04 21:57:11 +01002456 r = FAIL;
2457 }
2458 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002459 else if (lhs->lhs_member_idx >= 0)
2460 {
2461 // object member index
2462 r = generate_PUSHNR(cctx, lhs->lhs_member_idx);
2463 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01002464 else // if (*p == '.')
2465 {
2466 char_u *key_end = to_name_end(p + 1, TRUE);
2467 char_u *key = vim_strnsave(p + 1, key_end - p - 1);
2468
Zdenek Dohnal9fe17d42021-08-04 22:30:52 +02002469 r = generate_PUSHS(cctx, &key);
Bram Moolenaar752fc692021-01-04 21:57:11 +01002470 }
Bram Moolenaare42939a2021-04-05 17:11:17 +02002471 return r;
2472}
2473
2474/*
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002475 * For a LHS with an index, load the variable to be indexed.
2476 */
2477 static int
2478compile_load_lhs(
2479 lhs_T *lhs,
2480 char_u *var_start,
2481 type_T *rhs_type,
2482 cctx_T *cctx)
2483{
2484 if (lhs->lhs_dest == dest_expr)
2485 {
2486 size_t varlen = lhs->lhs_varlen;
2487 int c = var_start[varlen];
Bram Moolenaare97976b2021-08-01 13:17:17 +02002488 int lines_len = cctx->ctx_ufunc->uf_lines.ga_len;
Bram Moolenaare97976b2021-08-01 13:17:17 +02002489 int res;
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002490
Bram Moolenaare97976b2021-08-01 13:17:17 +02002491 // Evaluate "ll[expr]" of "ll[expr][idx]". End the line with a NUL and
2492 // limit the lines array length to avoid skipping to a following line.
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002493 var_start[varlen] = NUL;
Bram Moolenaare97976b2021-08-01 13:17:17 +02002494 cctx->ctx_ufunc->uf_lines.ga_len = cctx->ctx_lnum + 1;
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002495 char_u *p = var_start;
Bram Moolenaare97976b2021-08-01 13:17:17 +02002496 res = compile_expr0(&p, cctx);
2497 var_start[varlen] = c;
2498 cctx->ctx_ufunc->uf_lines.ga_len = lines_len;
2499 if (res == FAIL || p != var_start + varlen)
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002500 {
2501 // this should not happen
Bram Moolenaare97976b2021-08-01 13:17:17 +02002502 if (res != FAIL)
Bram Moolenaare1242042021-12-16 20:56:57 +00002503 emsg(_(e_missing_closing_square_brace));
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002504 return FAIL;
2505 }
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002506
Bram Moolenaar078a4612022-01-04 15:17:03 +00002507 lhs->lhs_type = cctx->ctx_type_stack.ga_len == 0 ? &t_void
2508 : get_type_on_stack(cctx, 0);
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02002509
2510 if (lhs->lhs_type->tt_type == VAR_OBJECT)
2511 {
2512 // Check whether the object variable is modifiable
2513 if (!lhs_class_member_modifiable(lhs, var_start, cctx))
2514 return FAIL;
2515 }
2516
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002517 // Now we can properly check the type. The variable is indexed, thus
2518 // we need the member type. For a class or object we don't know the
2519 // type yet, it depends on what member is used.
Yegappan Lakshmananc229a6a2023-10-26 23:05:07 +02002520 // The top item in the stack is the Dict, followed by the key and then
2521 // the type of the value.
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002522 vartype_T vartype = lhs->lhs_type->tt_type;
2523 type_T *member_type = lhs->lhs_type->tt_member;
2524 if (rhs_type != NULL && member_type != NULL
2525 && vartype != VAR_OBJECT && vartype != VAR_CLASS
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002526 && rhs_type != &t_void
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002527 && need_type(rhs_type, member_type, FALSE,
Yegappan Lakshmananc229a6a2023-10-26 23:05:07 +02002528 -3, 0, cctx, FALSE, FALSE) == FAIL)
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002529 return FAIL;
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02002530
2531 return OK;
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002532 }
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02002533
2534 return generate_loadvar(cctx, lhs);
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002535}
2536
2537/*
Bram Moolenaara369c3d2021-04-21 16:00:10 +02002538 * Produce code for loading "lhs" and also take care of an index.
2539 * Return OK/FAIL.
2540 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +00002541 int
Bram Moolenaara369c3d2021-04-21 16:00:10 +02002542compile_load_lhs_with_index(lhs_T *lhs, char_u *var_start, cctx_T *cctx)
2543{
Bram Moolenaar4cae8452023-01-15 15:51:48 +00002544 if (lhs->lhs_type->tt_type == VAR_OBJECT)
2545 {
Bram Moolenaar22363c62023-04-24 17:15:25 +01002546 // "this.value": load "this" object and get the value at index for an
2547 // object or class member get the type of the member.
2548 // Also for "obj.value".
Yegappan Lakshmananff6f0d52023-12-21 16:46:18 +01002549 char_u *dot = vim_strchr(var_start, '.');
2550 if (dot == NULL)
2551 {
2552 semsg(_(e_missing_dot_after_object_str), lhs->lhs_name);
2553 return FAIL;
2554 }
Bram Moolenaar22363c62023-04-24 17:15:25 +01002555
Yegappan Lakshmananeb91e242023-08-31 18:10:46 +02002556 class_T *cl = lhs->lhs_type->tt_class;
Yegappan Lakshmanan1ea42882023-10-11 21:43:52 +02002557 type_T *type = oc_member_type(cl, TRUE, dot + 1,
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02002558 lhs->lhs_end, &lhs->lhs_member_idx);
Bram Moolenaar4cae8452023-01-15 15:51:48 +00002559 if (lhs->lhs_member_idx < 0)
2560 return FAIL;
2561
Bram Moolenaar22363c62023-04-24 17:15:25 +01002562 if (dot - var_start == 4 && STRNCMP(var_start, "this", 4) == 0)
2563 {
2564 // load "this"
Yegappan Lakshmanand990bf02024-03-22 19:56:17 +01002565 lvar_T *lvar = lhs->lhs_lvar;
2566 int rc;
2567
2568 if (lvar->lv_from_outer > 0)
2569 rc = generate_LOADOUTER(cctx, lvar->lv_idx,
2570 lvar->lv_from_outer, lvar->lv_loop_depth,
2571 lvar->lv_loop_idx, type);
2572 else
2573 rc = generate_LOAD(cctx, ISN_LOAD, lvar->lv_idx, NULL, type);
2574
2575 if (rc == FAIL)
Bram Moolenaar22363c62023-04-24 17:15:25 +01002576 return FAIL;
2577 }
2578 else
2579 {
2580 // load object variable or argument
2581 if (compile_load_lhs(lhs, var_start, lhs->lhs_type, cctx) == FAIL)
2582 return FAIL;
2583 }
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002584 if (IS_INTERFACE(cl))
Yegappan Lakshmanan5a05d372023-09-29 19:43:11 +02002585 return generate_GET_ITF_MEMBER(cctx, cl, lhs->lhs_member_idx, type);
2586 return generate_GET_OBJ_MEMBER(cctx, lhs->lhs_member_idx, type);
Bram Moolenaar4cae8452023-01-15 15:51:48 +00002587 }
Yegappan Lakshmanan1ea42882023-10-11 21:43:52 +02002588 else if (lhs->lhs_type->tt_type == VAR_CLASS)
2589 {
2590 // "<classname>.value": load class variable "classname.value"
Yegappan Lakshmananff6f0d52023-12-21 16:46:18 +01002591 char_u *dot = vim_strchr(var_start, '.');
2592 if (dot == NULL)
2593 {
2594 check_type_is_value(lhs->lhs_type);
2595 return FAIL;
2596 }
Yegappan Lakshmanan1ea42882023-10-11 21:43:52 +02002597
2598 class_T *cl = lhs->lhs_type->tt_class;
2599 ocmember_T *m = class_member_lookup(cl, dot + 1,
2600 lhs->lhs_end - dot - 1,
2601 &lhs->lhs_member_idx);
2602 if (m == NULL)
2603 return FAIL;
2604
2605 return generate_CLASSMEMBER(cctx, TRUE, cl, lhs->lhs_member_idx);
2606 }
Bram Moolenaar4cae8452023-01-15 15:51:48 +00002607
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02002608 if (compile_load_lhs(lhs, var_start, NULL, cctx) == FAIL)
2609 return FAIL;
Bram Moolenaara369c3d2021-04-21 16:00:10 +02002610
2611 if (lhs->lhs_has_index)
2612 {
2613 int range = FALSE;
2614
2615 // Get member from list or dict. First compile the
2616 // index value.
2617 if (compile_assign_index(var_start, lhs, &range, cctx) == FAIL)
2618 return FAIL;
2619 if (range)
2620 {
2621 semsg(_(e_cannot_use_range_with_assignment_operator_str),
2622 var_start);
2623 return FAIL;
2624 }
2625
2626 // Get the member.
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02002627 if (compile_member(FALSE, NULL, cctx) == FAIL)
Bram Moolenaara369c3d2021-04-21 16:00:10 +02002628 return FAIL;
2629 }
2630 return OK;
2631}
2632
2633/*
Bram Moolenaare42939a2021-04-05 17:11:17 +02002634 * Assignment to a list or dict member, or ":unlet" for the item, using the
2635 * information in "lhs".
2636 * Returns OK or FAIL.
2637 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +00002638 int
Bram Moolenaare42939a2021-04-05 17:11:17 +02002639compile_assign_unlet(
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002640 char_u *var_start,
2641 lhs_T *lhs,
2642 int is_assign,
2643 type_T *rhs_type,
2644 cctx_T *cctx)
Bram Moolenaare42939a2021-04-05 17:11:17 +02002645{
Bram Moolenaare42939a2021-04-05 17:11:17 +02002646 vartype_T dest_type;
Bram Moolenaare42939a2021-04-05 17:11:17 +02002647 int range = FALSE;
2648
Bram Moolenaar68452172021-04-12 21:21:02 +02002649 if (compile_assign_index(var_start, lhs, &range, cctx) == FAIL)
Bram Moolenaar752fc692021-01-04 21:57:11 +01002650 return FAIL;
Bram Moolenaar4f0884d2021-08-11 21:49:23 +02002651 if (is_assign && range
2652 && lhs->lhs_type->tt_type != VAR_LIST
2653 && lhs->lhs_type != &t_blob
2654 && lhs->lhs_type != &t_any)
Bram Moolenaar68452172021-04-12 21:21:02 +02002655 {
2656 semsg(_(e_cannot_use_range_with_assignment_str), var_start);
2657 return FAIL;
2658 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01002659
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002660 if (lhs->lhs_type == NULL || lhs->lhs_type == &t_any)
Bram Moolenaar752fc692021-01-04 21:57:11 +01002661 {
2662 // Index on variable of unknown type: check at runtime.
2663 dest_type = VAR_ANY;
2664 }
2665 else
2666 {
2667 dest_type = lhs->lhs_type->tt_type;
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002668 if (dest_type == VAR_DICT && range)
2669 {
zeertzjq276410e2023-05-07 21:59:33 +01002670 emsg(_(e_cannot_use_range_with_dictionary));
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002671 return FAIL;
2672 }
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02002673 if (dest_type == VAR_DICT
Yegappan Lakshmananbce51d92024-04-15 19:19:52 +02002674 && may_generate_2STRING(-1, TOSTRING_NONE, cctx) == FAIL)
Bram Moolenaar752fc692021-01-04 21:57:11 +01002675 return FAIL;
Bram Moolenaar51e93322021-04-17 20:44:56 +02002676 if (dest_type == VAR_LIST || dest_type == VAR_BLOB)
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002677 {
Bram Moolenaar51e93322021-04-17 20:44:56 +02002678 type_T *type;
2679
2680 if (range)
2681 {
Bram Moolenaar078a4612022-01-04 15:17:03 +00002682 type = get_type_on_stack(cctx, 1);
Bram Moolenaarc6951a72022-12-29 20:56:24 +00002683 if (need_type(type, &t_number, FALSE,
Bram Moolenaar2995e5c2022-03-18 21:41:47 +00002684 -2, 0, cctx, FALSE, FALSE) == FAIL)
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002685 return FAIL;
Bram Moolenaar51e93322021-04-17 20:44:56 +02002686 }
Bram Moolenaar078a4612022-01-04 15:17:03 +00002687 type = get_type_on_stack(cctx, 0);
Bram Moolenaar53ba6ca2022-03-10 19:23:28 +00002688 if ((dest_type != VAR_BLOB && type->tt_type != VAR_SPECIAL)
Bram Moolenaarc6951a72022-12-29 20:56:24 +00002689 && need_type(type, &t_number, FALSE,
Bram Moolenaar51e93322021-04-17 20:44:56 +02002690 -1, 0, cctx, FALSE, FALSE) == FAIL)
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002691 return FAIL;
2692 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01002693 }
2694
Bram Moolenaar4875d6a2022-08-17 15:55:51 +01002695 if (cctx->ctx_skip == SKIP_YES)
2696 return OK;
2697
Bram Moolenaar22363c62023-04-24 17:15:25 +01002698 // Load the dict, list or object. On the stack we then have:
Bram Moolenaar752fc692021-01-04 21:57:11 +01002699 // - value (for assignment, not for :unlet)
2700 // - index
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002701 // - for [a : b] second index
Bram Moolenaar752fc692021-01-04 21:57:11 +01002702 // - variable
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002703 if (compile_load_lhs(lhs, var_start, rhs_type, cctx) == FAIL)
2704 return FAIL;
Bram Moolenaar752fc692021-01-04 21:57:11 +01002705
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002706 if (dest_type == VAR_LIST
2707 || dest_type == VAR_DICT
2708 || dest_type == VAR_BLOB
2709 || dest_type == VAR_CLASS
2710 || dest_type == VAR_OBJECT
2711 || dest_type == VAR_ANY)
Bram Moolenaar752fc692021-01-04 21:57:11 +01002712 {
2713 if (is_assign)
2714 {
Bram Moolenaar68452172021-04-12 21:21:02 +02002715 if (range)
2716 {
2717 if (generate_instr_drop(cctx, ISN_STORERANGE, 4) == NULL)
2718 return FAIL;
2719 }
2720 else
2721 {
2722 isn_T *isn = generate_instr_drop(cctx, ISN_STOREINDEX, 3);
Bram Moolenaar752fc692021-01-04 21:57:11 +01002723
Bram Moolenaar68452172021-04-12 21:21:02 +02002724 if (isn == NULL)
2725 return FAIL;
Bram Moolenaarf7d1c6e2023-01-16 20:47:57 +00002726 isn->isn_arg.storeindex.si_vartype = dest_type;
2727 isn->isn_arg.storeindex.si_class = NULL;
2728
2729 if (dest_type == VAR_OBJECT)
2730 {
Bram Moolenaarb1e32ac2023-02-21 12:38:51 +00002731 class_T *cl = lhs->lhs_type->tt_class;
Bram Moolenaarf7d1c6e2023-01-16 20:47:57 +00002732
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002733 if (IS_INTERFACE(cl))
Bram Moolenaarf7d1c6e2023-01-16 20:47:57 +00002734 {
2735 // "this.value": load "this" object and get the value
2736 // at index for an object or class member get the type
2737 // of the member
2738 isn->isn_arg.storeindex.si_class = cl;
2739 ++cl->class_refcount;
2740 }
2741 }
Bram Moolenaar68452172021-04-12 21:21:02 +02002742 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01002743 }
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002744 else if (range)
2745 {
2746 if (generate_instr_drop(cctx, ISN_UNLETRANGE, 3) == NULL)
2747 return FAIL;
2748 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01002749 else
2750 {
2751 if (generate_instr_drop(cctx, ISN_UNLETINDEX, 2) == NULL)
2752 return FAIL;
2753 }
2754 }
2755 else
2756 {
2757 emsg(_(e_indexable_type_required));
2758 return FAIL;
2759 }
2760
2761 return OK;
2762}
2763
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01002764/*
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00002765 * Generate an instruction to push the default value for "vartype".
2766 * if "dest_local" is TRUE then for some types no instruction is generated.
2767 * "skip_store" is set to TRUE if no PUSH instruction is generated.
2768 * Returns OK or FAIL.
2769 */
2770 static int
2771push_default_value(
2772 cctx_T *cctx,
2773 vartype_T vartype,
2774 int dest_is_local,
2775 int *skip_store)
2776{
2777 int r = OK;
2778
2779 switch (vartype)
2780 {
2781 case VAR_BOOL:
2782 r = generate_PUSHBOOL(cctx, VVAL_FALSE);
2783 break;
2784 case VAR_FLOAT:
2785 r = generate_PUSHF(cctx, 0.0);
2786 break;
2787 case VAR_STRING:
2788 r = generate_PUSHS(cctx, NULL);
2789 break;
2790 case VAR_BLOB:
2791 r = generate_PUSHBLOB(cctx, blob_alloc());
2792 break;
2793 case VAR_FUNC:
2794 r = generate_PUSHFUNC(cctx, NULL, &t_func_void, TRUE);
2795 break;
2796 case VAR_LIST:
2797 r = generate_NEWLIST(cctx, 0, FALSE);
2798 break;
2799 case VAR_DICT:
2800 r = generate_NEWDICT(cctx, 0, FALSE);
2801 break;
2802 case VAR_JOB:
2803 r = generate_PUSHJOB(cctx);
2804 break;
2805 case VAR_CHANNEL:
2806 r = generate_PUSHCHANNEL(cctx);
2807 break;
Ernie Rael5c018be2023-08-27 18:40:26 +02002808 case VAR_OBJECT:
2809 r = generate_PUSHOBJ(cctx);
2810 break;
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00002811 case VAR_NUMBER:
2812 case VAR_UNKNOWN:
2813 case VAR_ANY:
2814 case VAR_PARTIAL:
2815 case VAR_VOID:
2816 case VAR_INSTR:
2817 case VAR_CLASS:
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02002818 case VAR_TYPEALIAS:
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00002819 case VAR_SPECIAL: // cannot happen
2820 // This is skipped for local variables, they are always
2821 // initialized to zero. But in a "for" or "while" loop
2822 // the value may have been changed.
2823 if (dest_is_local && !inside_loop_scope(cctx))
2824 *skip_store = TRUE;
2825 else
2826 r = generate_PUSHNR(cctx, 0);
2827 break;
2828 }
2829 return r;
2830}
2831
2832/*
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002833 * Compile assignment context. Used when compiling an assignment statement.
2834 */
2835typedef struct cac_S cac_T;
2836struct cac_S
2837{
2838 cmdidx_T cac_cmdidx; // assignment command
2839 char_u *cac_nextc; // next character to parse
2840 lhs_T cac_lhs; // lhs of the assignment
2841 type_T *cac_rhs_type; // rhs type of an assignment
2842 char_u *cac_op; // assignment operator
2843 int cac_oplen; // assignment operator length
2844 char_u *cac_var_start; // start of the variable names
2845 char_u *cac_var_end; // end of the variable names
2846 int cac_var_count; // number of variables in assignment
2847 int cac_var_idx; // variable index in a list
2848 int cac_semicolon; // semicolon in [var1, var2; var3]
2849 garray_T *cac_instr;
2850 int cac_instr_count;
2851 int cac_incdec;
2852 int cac_did_generate_slice;
2853 int cac_is_decl;
2854 int cac_is_const;
2855 int cac_start_lnum;
2856 type_T *cac_inferred_type;
2857 int cac_skip_store;
2858};
2859
2860/*
2861 * Initialize the compile assignment context.
2862 */
2863 static void
2864compile_assign_context_init(cac_T *cac, cctx_T *cctx, int cmdidx, char_u *arg)
2865{
2866 CLEAR_FIELD(*cac);
2867 cac->cac_cmdidx = cmdidx;
2868 cac->cac_instr = &cctx->ctx_instr;
2869 cac->cac_rhs_type = &t_any;
2870 cac->cac_is_decl = is_decl_command(cmdidx);
2871 cac->cac_start_lnum = SOURCING_LNUM;
2872 cac->cac_instr_count = -1;
2873 cac->cac_var_end = arg;
2874}
2875
2876/*
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01002877 * Compile an object member variable assignment in the arguments passed to a
2878 * class new() method.
2879 *
2880 * Instruction format:
2881 *
2882 * ifargisset <n> this.<varname> = <value>
2883 *
2884 * where <n> is the index of the default argument.
2885 *
2886 * Generates the ISN_JUMP_IF_ARG_NOT_SET instruction to skip the assignment if
2887 * the value is passed as an argument to the new() method call.
2888 *
2889 * Returns OK on success.
2890 */
2891 static int
2892compile_assign_obj_new_arg(char_u **argp, cctx_T *cctx)
2893{
2894 char_u *arg = *argp;
2895
2896 arg += 11; // skip "ifargisset"
2897 int def_arg_idx = getdigits(&arg);
2898 arg = skipwhite(arg);
2899
2900 // Use a JUMP_IF_ARG_NOT_SET instruction to skip if the value was not
2901 // given and the default value is "v:none".
2902 int stack_offset = STACK_FRAME_SIZE +
2903 (cctx->ctx_ufunc->uf_va_name != NULL ? 1 : 0);
2904 int def_arg_count = cctx->ctx_ufunc->uf_def_args.ga_len;
2905 int arg_offset = def_arg_idx - def_arg_count - stack_offset;
2906
2907 if (generate_JUMP_IF_ARG(cctx, ISN_JUMP_IF_ARG_NOT_SET,
2908 arg_offset) == FAIL)
2909 return FAIL;
2910
2911 *argp = arg;
2912 return OK;
2913}
2914
2915/*
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002916 * Translate the increment (++) and decrement (--) operators to the
2917 * corresponding compound operators (+= or -=).
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01002918 *
2919 * Returns OK on success and FAIL on syntax error.
2920 */
2921 static int
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002922translate_incdec_op(exarg_T *eap, cac_T *cac)
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01002923{
2924 if (VIM_ISWHITE(eap->cmd[2]))
2925 {
2926 semsg(_(e_no_white_space_allowed_after_str_str),
2927 eap->cmdidx == CMD_increment ? "++" : "--", eap->cmd);
2928 return FAIL;
2929 }
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002930 cac->cac_op = (char_u *)(eap->cmdidx == CMD_increment ? "+=" : "-=");
2931 cac->cac_oplen = 2;
2932 cac->cac_incdec = TRUE;
2933
2934 return OK;
2935}
2936
2937/*
2938 * Process the operator in an assignment statement.
2939 */
2940 static int
2941compile_assign_process_operator(
2942 exarg_T *eap,
2943 char_u *arg,
2944 cac_T *cac,
2945 int *heredoc,
2946 char_u **retstr)
2947{
2948 *retstr = NULL;
2949
2950 if (eap->cmdidx == CMD_increment || eap->cmdidx == CMD_decrement)
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002951 // Change an unary operator to a compound operator
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01002952 return translate_incdec_op(eap, cac);
2953
2954 char_u *sp = cac->cac_nextc;
2955 cac->cac_nextc = skipwhite(cac->cac_nextc);
2956 cac->cac_op = cac->cac_nextc;
2957 cac->cac_oplen = assignment_len(cac->cac_nextc, heredoc);
2958
2959 if (cac->cac_var_count > 0 && cac->cac_oplen == 0)
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002960 {
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01002961 // can be something like "[1, 2]->func()"
2962 *retstr = arg;
2963 return FAIL;
2964 }
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002965
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01002966 // need white space before and after the operator
2967 if (cac->cac_oplen > 0 && (!VIM_ISWHITE(*sp)
2968 || !IS_WHITE_OR_NUL(cac->cac_op[cac->cac_oplen])))
2969 {
2970 error_white_both(cac->cac_op, cac->cac_oplen);
2971 return FAIL;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002972 }
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01002973
2974 return OK;
2975}
2976
2977/*
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01002978 * Find the start of an assignment statement.
2979 */
2980 static char_u *
2981compile_assign_compute_start(char_u *arg, int var_count)
2982{
2983 if (var_count > 0)
2984 // [var1, var2] = [val1, val2]
2985 // skip over the "["
2986 return skipwhite(arg + 1);
2987
2988 return arg;
2989}
2990
2991/*
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01002992 * Parse a heredoc assignment starting at "p". Returns a pointer to the
2993 * beginning of the heredoc content.
2994 */
2995 static char_u *
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002996parse_heredoc_assignment(exarg_T *eap, cctx_T *cctx, cac_T *cac)
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01002997{
2998 // [let] varname =<< [trim] {end}
2999 eap->ea_getline = exarg_getline;
3000 eap->cookie = cctx;
3001
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003002 list_T *l = heredoc_get(eap, cac->cac_nextc + 3, FALSE, TRUE);
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01003003 if (l == NULL)
3004 return NULL;
3005
3006 list_free(l);
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003007 cac->cac_nextc += STRLEN(cac->cac_nextc);
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01003008
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003009 return cac->cac_nextc;
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01003010}
3011
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003012/*
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003013 * Check the type of a RHS expression in a list assignment statement.
3014 * The RHS expression is already compiled. So the type is on the stack.
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003015 */
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003016 static int
3017compile_assign_list_check_rhs_type(cctx_T *cctx, cac_T *cac)
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01003018{
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003019 type_T *stacktype;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003020
3021 stacktype = cctx->ctx_type_stack.ga_len == 0 ? &t_void
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01003022 : get_type_on_stack(cctx, 0);
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003023 if (stacktype->tt_type == VAR_VOID)
3024 {
3025 emsg(_(e_cannot_use_void_value));
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003026 return FAIL;
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01003027 }
3028
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003029 if (need_type(stacktype, &t_list_any, FALSE, -1, 0, cctx,
3030 FALSE, FALSE) == FAIL)
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003031 return FAIL;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003032
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003033 if (stacktype->tt_member != NULL)
3034 cac->cac_rhs_type = stacktype->tt_member;
3035
3036 return OK;
3037}
3038
3039/*
3040 * In a list assignment statement, if a constant list was used, check the
3041 * length. Returns OK if the length check succeeds. Returns FAIL otherwise.
3042 */
3043 static int
3044compile_assign_list_check_length(cctx_T *cctx, cac_T *cac)
3045{
3046 int needed_list_len;
3047 int did_check = FALSE;
3048
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003049 needed_list_len = cac->cac_semicolon
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003050 ? cac->cac_var_count - 1
3051 : cac->cac_var_count;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003052 if (cac->cac_instr->ga_len > 0)
3053 {
3054 isn_T *isn = ((isn_T *)cac->cac_instr->ga_data) +
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003055 cac->cac_instr->ga_len - 1;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003056
3057 if (isn->isn_type == ISN_NEWLIST)
3058 {
3059 did_check = TRUE;
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003060 if (cac->cac_semicolon ?
3061 isn->isn_arg.number < needed_list_len
3062 : isn->isn_arg.number != needed_list_len)
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003063 {
3064 semsg(_(e_expected_nr_items_but_got_nr),
3065 needed_list_len, (int)isn->isn_arg.number);
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003066 return FAIL;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003067 }
3068 }
3069 }
3070
3071 if (!did_check)
3072 generate_CHECKLEN(cctx, needed_list_len, cac->cac_semicolon);
3073
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003074 return OK;
3075}
3076
3077/*
3078 * Evaluate the expression for "[var, var] = expr" assignment.
3079 * A line break may follow the assignment operator "=".
3080 */
3081 static char_u *
3082compile_assign_list_expr(cctx_T *cctx, cac_T *cac)
3083{
3084 char_u *whitep;
3085
3086 whitep = cac->cac_op + cac->cac_oplen;
3087
3088 if (may_get_next_line_error(whitep, &cac->cac_nextc, cctx) == FAIL)
3089 return NULL;
3090
3091 // compile RHS expression
3092 if (compile_expr0(&cac->cac_nextc, cctx) == FAIL)
3093 return NULL;
3094
3095 if (cctx->ctx_skip == SKIP_YES)
3096 // no need to parse more when skipping
3097 return cac->cac_nextc;
3098
3099 if (compile_assign_list_check_rhs_type(cctx, cac) == FAIL)
3100 return NULL;
3101
3102 // If a constant list was used we can check the length right here.
3103 if (compile_assign_list_check_length(cctx, cac) == FAIL)
3104 return FAIL;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003105
3106 return cac->cac_nextc;
3107}
3108
3109/*
3110 * Find and return the end of a heredoc or a list of variables assignment
3111 * statement. For a single variable assignment statement, returns the current
3112 * end.
3113 * Returns NULL on failure.
3114 */
3115 static char_u *
3116compile_assign_compute_end(
3117 exarg_T *eap,
3118 cctx_T *cctx,
3119 cac_T *cac,
3120 int heredoc)
3121{
3122 if (heredoc)
3123 {
3124 cac->cac_nextc = parse_heredoc_assignment(eap, cctx, cac);
3125 return cac->cac_nextc;
3126 }
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003127
3128 if (cac->cac_var_count > 0)
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003129 {
3130 // for "[var, var] = expr" evaluate the expression. The list of
3131 // variables are processed later.
3132 // A line break may follow the "=".
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003133 cac->cac_nextc = compile_assign_list_expr(cctx, cac);
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003134 return cac->cac_nextc;
3135 }
3136
3137 return cac->cac_var_end;
3138}
3139
3140/*
3141 * For "var = expr" evaluate the expression.
3142 */
3143 static int
3144compile_assign_single_eval_expr(cctx_T *cctx, cac_T *cac)
3145{
3146 int ret = OK;
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003147 char_u *whitep;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003148 lhs_T *lhs = &cac->cac_lhs;
3149
3150 // Compile the expression.
3151 if (cac->cac_incdec)
3152 return generate_PUSHNR(cctx, 1);
3153
3154 // Temporarily hide the new local variable here, it is
3155 // not available to this expression.
3156 if (lhs->lhs_new_local)
3157 --cctx->ctx_locals.ga_len;
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003158 whitep = cac->cac_op + cac->cac_oplen;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003159
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003160 if (may_get_next_line_error(whitep, &cac->cac_nextc, cctx) == FAIL)
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003161 {
3162 if (lhs->lhs_new_local)
3163 ++cctx->ctx_locals.ga_len;
3164 return FAIL;
3165 }
3166
3167 ret = compile_expr0_ext(&cac->cac_nextc, cctx, &cac->cac_is_const);
3168 if (lhs->lhs_new_local)
3169 ++cctx->ctx_locals.ga_len;
3170
3171 return ret;
3172}
3173
3174/*
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003175 * When compiling an assignment, set the LHS type to the RHS type.
3176 */
3177 static int
3178compile_assign_set_lhs_type_from_rhs(
3179 cctx_T *cctx,
3180 cac_T *cac,
3181 lhs_T *lhs,
3182 type_T *rhs_type)
3183{
3184 if (rhs_type->tt_type == VAR_VOID)
3185 {
3186 emsg(_(e_cannot_use_void_value));
3187 return FAIL;
3188 }
3189
3190 type_T *type;
3191
3192 // An empty list or dict has a &t_unknown member, for a variable that
3193 // implies &t_any.
3194 if (rhs_type == &t_list_empty)
3195 type = &t_list_any;
3196 else if (rhs_type == &t_dict_empty)
3197 type = &t_dict_any;
3198 else if (rhs_type == &t_unknown)
3199 type = &t_any;
3200 else
3201 {
3202 type = rhs_type;
3203 cac->cac_inferred_type = rhs_type;
3204 }
3205
3206 set_var_type(lhs->lhs_lvar, type, cctx);
3207
3208 return OK;
3209}
3210
3211/*
3212 * Returns TRUE if the "rhs_type" can be assigned to the "lhs" variable.
3213 * Used when compiling an assignment statement.
3214 */
3215 static int
3216compile_assign_valid_rhs_type(
3217 cctx_T *cctx,
3218 cac_T *cac,
3219 lhs_T *lhs,
3220 type_T *rhs_type)
3221{
3222 type_T *use_type = lhs->lhs_lvar->lv_type;
3223 where_T where = WHERE_INIT;
3224
3225 // Without operator check type here, otherwise below.
3226 // Use the line number of the assignment.
3227 SOURCING_LNUM = cac->cac_start_lnum;
3228 if (cac->cac_var_count > 0)
3229 {
3230 where.wt_index = cac->cac_var_idx + 1;
3231 where.wt_kind = WT_VARIABLE;
3232 }
3233
3234 // If assigning to a list or dict member, use the member type.
3235 // Not for "list[:] =".
3236 if (lhs->lhs_has_index &&
3237 !has_list_index(cac->cac_var_start + lhs->lhs_varlen, cctx))
3238 use_type = lhs->lhs_member_type;
3239
3240 if (need_type_where(rhs_type, use_type, FALSE, -1, where, cctx, FALSE,
3241 cac->cac_is_const) == FAIL)
3242 return FALSE;
3243
3244 return TRUE;
3245}
3246
3247/*
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003248 * Compare the LHS type with the RHS type in an assignment.
3249 */
3250 static int
3251compile_assign_check_type(cctx_T *cctx, cac_T *cac)
3252{
3253 lhs_T *lhs = &cac->cac_lhs;
3254 type_T *rhs_type;
3255
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003256 rhs_type = cctx->ctx_type_stack.ga_len == 0
3257 ? &t_void
3258 : get_type_on_stack(cctx, 0);
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003259 cac->cac_rhs_type = rhs_type;
3260
3261 if (check_type_is_value(rhs_type) == FAIL)
3262 return FAIL;
3263
3264 if (lhs->lhs_lvar != NULL && (cac->cac_is_decl || !lhs->lhs_has_type))
3265 {
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003266 if (rhs_type->tt_type == VAR_FUNC
3267 || rhs_type->tt_type == VAR_PARTIAL)
3268 {
3269 // Make sure the variable name can be used as a funcref
3270 if (!lhs->lhs_has_index
3271 && var_wrong_func_name(lhs->lhs_name, TRUE))
3272 return FAIL;
3273 }
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003274
3275 if (lhs->lhs_new_local && !lhs->lhs_has_type)
3276 {
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003277 // The LHS variable doesn't have a type. Set it to the RHS type.
3278 if (compile_assign_set_lhs_type_from_rhs(cctx, cac, lhs, rhs_type)
3279 == FAIL)
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003280 return FAIL;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003281 }
3282 else if (*cac->cac_op == '=')
3283 {
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003284 if (!compile_assign_valid_rhs_type(cctx, cac, lhs, rhs_type))
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003285 return FAIL;
3286 }
3287 }
3288 else
3289 {
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003290 // Assigning to a register using @r = "abc"
3291
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003292 type_T *lhs_type = lhs->lhs_member_type;
3293
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003294 // Special case: assigning to @# can use a number or a string.
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003295 // Also: can assign a number to a float.
3296 if ((lhs_type == &t_number_or_string || lhs_type == &t_float)
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003297 && rhs_type->tt_type == VAR_NUMBER)
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003298 lhs_type = &t_number;
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003299
3300 if (*cac->cac_nextc != '=')
3301 {
3302 if (need_type(rhs_type, lhs_type, FALSE, -1, 0, cctx, FALSE,
3303 FALSE) == FAIL)
3304 return FAIL;
3305 }
3306 }
3307
3308 return OK;
3309}
3310
3311/*
3312 * Compile the RHS expression in an assignment statement and generate the
3313 * instructions.
3314 */
3315 static int
3316compile_assign_rhs_expr(cctx_T *cctx, cac_T *cac)
3317{
3318 cac->cac_is_const = FALSE;
3319
3320 // for "+=", "*=", "..=" etc. first load the current value
3321 if (*cac->cac_op != '='
3322 && compile_load_lhs_with_index(&cac->cac_lhs, cac->cac_var_start,
3323 cctx) == FAIL)
3324 return FAIL;
3325
3326 // For "var = expr" evaluate the expression.
3327 if (cac->cac_var_count == 0)
3328 {
3329 int ret;
3330
3331 // Compile the expression.
3332 cac->cac_instr_count = cac->cac_instr->ga_len;
3333 ret = compile_assign_single_eval_expr(cctx, cac);
3334 if (ret == FAIL)
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003335 return FAIL;
3336 }
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003337 else if (cac->cac_semicolon && cac->cac_var_idx == cac->cac_var_count - 1)
3338 {
3339 // For "[var; var] = expr" get the rest of the list
3340 cac->cac_did_generate_slice = TRUE;
3341 if (generate_SLICE(cctx, cac->cac_var_count - 1) == FAIL)
3342 return FAIL;
3343 }
3344 else
3345 {
3346 // For "[var, var] = expr" get the "var_idx" item from the
3347 // list.
3348 int with_op = *cac->cac_op != '=';
3349 if (generate_GETITEM(cctx, cac->cac_var_idx, with_op) == FAIL)
3350 return FAIL;
3351 }
3352
3353 if (compile_assign_check_type(cctx, cac) == FAIL)
3354 return FAIL;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003355
3356 return OK;
3357}
3358
3359/*
3360 * Compile the RHS expression in an assignment
3361 */
3362 static int
3363compile_assign_rhs(cctx_T *cctx, cac_T *cac)
3364{
3365 lhs_T *lhs = &cac->cac_lhs;
3366
3367 if (cctx->ctx_skip == SKIP_YES)
3368 {
3369 if (cac->cac_oplen > 0 && cac->cac_var_count == 0)
3370 {
3371 // skip over the "=" and the expression
3372 cac->cac_nextc = skipwhite(cac->cac_op + cac->cac_oplen);
3373 (void)compile_expr0(&cac->cac_nextc, cctx);
3374 }
3375 return OK;
3376 }
3377
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003378 // If RHS is specified, then generate instructions for RHS expression
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003379 if (cac->cac_oplen > 0)
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003380 return compile_assign_rhs_expr(cctx, cac);
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003381
3382 if (cac->cac_cmdidx == CMD_final)
3383 {
3384 emsg(_(e_final_requires_a_value));
3385 return FAIL;
3386 }
3387
3388 if (cac->cac_cmdidx == CMD_const)
3389 {
3390 emsg(_(e_const_requires_a_value));
3391 return FAIL;
3392 }
3393
3394 if (!lhs->lhs_has_type || lhs->lhs_dest == dest_option
3395 || lhs->lhs_dest == dest_func_option)
3396 {
3397 emsg(_(e_type_or_initialization_required));
3398 return FAIL;
3399 }
3400
3401 // variables are always initialized
3402 if (GA_GROW_FAILS(cac->cac_instr, 1))
3403 return FAIL;
3404
3405 cac->cac_instr_count = cac->cac_instr->ga_len;
3406
3407 return push_default_value(cctx, lhs->lhs_member_type->tt_type,
3408 lhs->lhs_dest == dest_local,
3409 &cac->cac_skip_store);
3410}
3411
3412/*
3413 * Compile a compound op assignment statement (+=, -=, *=, %=, etc.)
3414 */
3415 static int
3416compile_assign_compound_op(cctx_T *cctx, cac_T *cac)
3417{
3418 lhs_T *lhs = &cac->cac_lhs;
3419 type_T *expected;
3420 type_T *stacktype = NULL;
3421
3422 if (*cac->cac_op == '.')
3423 {
3424 if (may_generate_2STRING(-1, TOSTRING_NONE, cctx) == FAIL)
3425 return FAIL;
3426 }
3427 else
3428 {
3429 expected = lhs->lhs_member_type;
3430 stacktype = get_type_on_stack(cctx, 0);
3431 if (
3432 // If variable is float operation with number is OK.
3433 !(expected == &t_float && (stacktype == &t_number
3434 || stacktype == &t_number_bool))
3435 && need_type(stacktype, expected, TRUE, -1, 0, cctx,
3436 FALSE, FALSE) == FAIL)
3437 return FAIL;
3438 }
3439
3440 if (*cac->cac_op == '.')
3441 {
3442 if (generate_CONCAT(cctx, 2) == FAIL)
3443 return FAIL;
3444 }
3445 else if (*cac->cac_op == '+')
3446 {
3447 if (generate_add_instr(cctx,
3448 operator_type(lhs->lhs_member_type, stacktype),
3449 lhs->lhs_member_type, stacktype,
3450 EXPR_APPEND) == FAIL)
3451 return FAIL;
3452 }
3453 else if (generate_two_op(cctx, cac->cac_op) == FAIL)
3454 return FAIL;
3455
3456 return OK;
3457}
3458
3459/*
3460 * Generate the STORE and SETTYPE instructions for an assignment statement.
3461 */
3462 static int
3463compile_assign_generate_store(cctx_T *cctx, cac_T *cac)
3464{
3465 lhs_T *lhs = &cac->cac_lhs;
3466 int save_lnum;
3467
3468 // Use the line number of the assignment for store instruction.
3469 save_lnum = cctx->ctx_lnum;
3470 cctx->ctx_lnum = cac->cac_start_lnum - 1;
3471
3472 if (lhs->lhs_has_index)
3473 {
3474 // Use the info in "lhs" to store the value at the index in the
3475 // list, dict or object.
3476 if (compile_assign_unlet(cac->cac_var_start, &cac->cac_lhs,
3477 TRUE, cac->cac_rhs_type, cctx) == FAIL)
3478 {
3479 cctx->ctx_lnum = save_lnum;
3480 return FAIL;
3481 }
3482 }
3483 else
3484 {
3485 if (cac->cac_is_decl && cac->cac_cmdidx == CMD_const &&
3486 (lhs->lhs_dest == dest_script
3487 || lhs->lhs_dest == dest_script_v9
3488 || lhs->lhs_dest == dest_global
3489 || lhs->lhs_dest == dest_local))
3490 // ":const var": lock the value, but not referenced variables
3491 generate_LOCKCONST(cctx);
3492
3493 type_T *inferred_type = cac->cac_inferred_type;
3494
3495 if ((lhs->lhs_type->tt_type == VAR_DICT
3496 || lhs->lhs_type->tt_type == VAR_LIST)
3497 && lhs->lhs_type->tt_member != NULL
3498 && lhs->lhs_type->tt_member != &t_any
3499 && lhs->lhs_type->tt_member != &t_unknown)
3500 // Set the type in the list or dict, so that it can be checked,
3501 // also in legacy script.
3502 generate_SETTYPE(cctx, lhs->lhs_type);
3503 else if (inferred_type != NULL
3504 && (inferred_type->tt_type == VAR_DICT
3505 || inferred_type->tt_type == VAR_LIST)
3506 && inferred_type->tt_member != NULL
3507 && inferred_type->tt_member != &t_unknown
3508 && inferred_type->tt_member != &t_any)
3509 // Set the type in the list or dict, so that it can be checked,
3510 // also in legacy script.
3511 generate_SETTYPE(cctx, inferred_type);
3512
3513 if (!cac->cac_skip_store &&
3514 generate_store_lhs(cctx, &cac->cac_lhs,
3515 cac->cac_instr_count,
3516 cac->cac_is_decl) == FAIL)
3517 {
3518 cctx->ctx_lnum = save_lnum;
3519 return FAIL;
3520 }
3521 }
3522
3523 cctx->ctx_lnum = save_lnum;
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003524
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003525 return OK;
3526}
3527
3528/*
3529 * Process the variable(s) in an assignment statement
3530 */
3531 static int
3532compile_assign_process_variables(
3533 cctx_T *cctx,
3534 cac_T *cac,
3535 int cmdidx,
3536 int heredoc,
3537 int has_cmd,
3538 int has_argisset_prefix,
3539 int jump_instr_idx)
3540{
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003541 /*
3542 * Loop over variables in "[var, var] = expr".
3543 * For "name = expr" and "var name: type" this is done only once.
3544 */
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003545 for (cac->cac_var_idx = 0; cac->cac_var_idx == 0 ||
3546 cac->cac_var_idx < cac->cac_var_count; cac->cac_var_idx++)
3547 {
3548 if (cac->cac_var_start[0] == '_'
3549 && !eval_isnamec(cac->cac_var_start[1]))
3550 {
3551 // Ignore underscore in "[a, _, b] = list".
3552 if (cac->cac_var_count > 0)
3553 {
3554 cac->cac_var_start = skipwhite(cac->cac_var_start + 2);
3555 continue;
3556 }
3557 emsg(_(e_cannot_use_underscore_here));
3558 return FAIL;
3559 }
3560 vim_free(cac->cac_lhs.lhs_name);
3561
3562 /*
3563 * Figure out the LHS type and other properties.
3564 */
3565 if (compile_assign_lhs(cac->cac_var_start, &cac->cac_lhs, cmdidx,
3566 cac->cac_is_decl, heredoc, has_cmd,
3567 cac->cac_oplen, cctx) == FAIL)
3568 return FAIL;
3569
3570 // Compile the RHS expression
3571 if (heredoc)
3572 {
3573 SOURCING_LNUM = cac->cac_start_lnum;
3574 if (cac->cac_lhs.lhs_has_type
3575 && need_type(&t_list_string, cac->cac_lhs.lhs_type,
3576 FALSE, -1, 0, cctx, FALSE, FALSE) == FAIL)
3577 return FAIL;
3578 }
3579 else
3580 {
3581 if (compile_assign_rhs(cctx, cac) == FAIL)
3582 return FAIL;
3583 if (cac->cac_var_count == 0)
3584 cac->cac_var_end = cac->cac_nextc;
3585 }
3586
3587 // no need to parse more when skipping
3588 if (cctx->ctx_skip == SKIP_YES)
3589 break;
3590
3591 if (cac->cac_oplen > 0 && *cac->cac_op != '=')
3592 {
3593 if (compile_assign_compound_op(cctx, cac) == FAIL)
3594 return FAIL;
3595 }
3596
3597 // generate the store instructions
3598 if (compile_assign_generate_store(cctx, cac) == FAIL)
3599 return FAIL;
3600
3601 if (cac->cac_var_idx + 1 < cac->cac_var_count)
3602 cac->cac_var_start = skipwhite(cac->cac_lhs.lhs_end + 1);
3603
3604 if (has_argisset_prefix)
3605 {
3606 // set instruction index in JUMP_IF_ARG_SET to here
3607 isn_T *isn = ((isn_T *)cac->cac_instr->ga_data) + jump_instr_idx;
3608 isn->isn_arg.jumparg.jump_where = cac->cac_instr->ga_len;
3609 }
3610 }
3611
3612 return OK;
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01003613}
3614
3615/*
Bram Moolenaar47a519a2020-06-14 23:05:10 +02003616 * Compile declaration and assignment:
Bram Moolenaar30fd8202020-09-26 15:09:30 +02003617 * "let name"
3618 * "var name = expr"
3619 * "final name = expr"
3620 * "const name = expr"
3621 * "name = expr"
3622 * "arg" points to "name".
Bram Moolenaarbdc0f1c2021-04-24 19:08:24 +02003623 * "++arg" and "--arg"
Bram Moolenaar47a519a2020-06-14 23:05:10 +02003624 * Return NULL for an error.
3625 * Return "arg" if it does not look like a variable list.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003626 */
3627 static char_u *
Bram Moolenaar65b0d162022-12-13 18:43:22 +00003628compile_assignment(
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003629 char_u *arg_start,
3630 exarg_T *eap,
3631 cmdidx_T cmdidx,
3632 cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003633{
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003634 cac_T cac;
Bram Moolenaar65b0d162022-12-13 18:43:22 +00003635 char_u *arg = arg_start;
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003636 char_u *retstr = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003637 int heredoc = FALSE;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003638 int jump_instr_idx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003639
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003640 compile_assign_context_init(&cac, cctx, cmdidx, arg);
3641
3642 jump_instr_idx = cac.cac_instr->ga_len;
3643
3644 // process object variable initialization in a new() constructor method
3645 int has_argisset_prefix = STRNCMP(arg, "ifargisset ", 11) == 0;
3646 if (has_argisset_prefix &&
3647 compile_assign_obj_new_arg(&arg, cctx) == FAIL)
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01003648 goto theend;
Bram Moolenaar65b0d162022-12-13 18:43:22 +00003649
Bram Moolenaare1d12112022-03-05 11:37:48 +00003650 // Skip over the "varname" or "[varname, varname]" to get to any "=".
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003651 cac.cac_nextc = skip_var_list(arg, TRUE, &cac.cac_var_count,
3652 &cac.cac_semicolon, TRUE);
3653 if (cac.cac_nextc == NULL)
Bram Moolenaar47a519a2020-06-14 23:05:10 +02003654 return *arg == '[' ? arg : NULL;
3655
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003656 if (compile_assign_process_operator(eap, arg, &cac, &heredoc,
3657 &retstr) == FAIL)
3658 return retstr;
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01003659
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003660 // Compute the start of the assignment
3661 cac.cac_var_start = compile_assign_compute_start(arg, cac.cac_var_count);
3662
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003663 // Compute the end of the assignment
3664 cac.cac_var_end = compile_assign_compute_end(eap, cctx, &cac, heredoc);
3665 if (cac.cac_var_end == NULL)
3666 return NULL;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02003667
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003668 int has_cmd = cac.cac_var_start > eap->cmd;
Bram Moolenaar752fc692021-01-04 21:57:11 +01003669
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003670 /* process the variable(s) */
3671 if (compile_assign_process_variables(cctx, &cac, cmdidx, heredoc,
3672 has_cmd, has_argisset_prefix,
3673 jump_instr_idx) == FAIL)
3674 goto theend;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02003675
Bram Moolenaar4d5dfe22021-06-26 13:59:29 +02003676 // For "[var, var] = expr" drop the "expr" value.
3677 // Also for "[var, var; _] = expr".
Yegappan Lakshmanane2038412024-12-14 19:59:24 +01003678 if (cctx->ctx_skip != SKIP_YES && cac.cac_var_count > 0 &&
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003679 (!cac.cac_semicolon || !cac.cac_did_generate_slice))
Bram Moolenaar9af78762020-06-16 11:34:42 +02003680 {
Bram Moolenaarec792292020-12-13 21:26:56 +01003681 if (generate_instr_drop(cctx, ISN_DROP, 1) == NULL)
Bram Moolenaar9af78762020-06-16 11:34:42 +02003682 goto theend;
3683 }
Bram Moolenaar47a519a2020-06-14 23:05:10 +02003684
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003685 retstr = skipwhite(cac.cac_var_end);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003686
3687theend:
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003688 vim_free(cac.cac_lhs.lhs_name);
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003689 return retstr;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003690}
3691
3692/*
Bram Moolenaar17126b12021-01-07 22:03:02 +01003693 * Check for an assignment at "eap->cmd", compile it if found.
3694 * Return NOTDONE if there is none, FAIL for failure, OK if done.
3695 */
3696 static int
3697may_compile_assignment(exarg_T *eap, char_u **line, cctx_T *cctx)
3698{
3699 char_u *pskip;
3700 char_u *p;
3701
3702 // Assuming the command starts with a variable or function name,
3703 // find what follows.
3704 // Skip over "var.member", "var[idx]" and the like.
3705 // Also "&opt = val", "$ENV = val" and "@r = val".
3706 pskip = (*eap->cmd == '&' || *eap->cmd == '$' || *eap->cmd == '@')
3707 ? eap->cmd + 1 : eap->cmd;
3708 p = to_name_end(pskip, TRUE);
3709 if (p > eap->cmd && *p != NUL)
3710 {
3711 char_u *var_end;
3712 int oplen;
3713 int heredoc;
3714
3715 if (eap->cmd[0] == '@')
3716 var_end = eap->cmd + 2;
3717 else
3718 var_end = find_name_end(pskip, NULL, NULL,
3719 FNE_CHECK_START | FNE_INCL_BR);
3720 oplen = assignment_len(skipwhite(var_end), &heredoc);
3721 if (oplen > 0)
3722 {
3723 size_t len = p - eap->cmd;
3724
3725 // Recognize an assignment if we recognize the variable
3726 // name:
Bram Moolenaar17126b12021-01-07 22:03:02 +01003727 // "&opt = expr"
3728 // "$ENV = expr"
3729 // "@r = expr"
Bram Moolenaar2e17fef2022-03-18 19:44:48 +00003730 // "g:var = expr"
3731 // "g:[key] = expr"
3732 // "local = expr" where "local" is a local var.
3733 // "script = expr" where "script" is a script-local var.
3734 // "import = expr" where "import" is an imported var
Bram Moolenaar17126b12021-01-07 22:03:02 +01003735 if (*eap->cmd == '&'
3736 || *eap->cmd == '$'
3737 || *eap->cmd == '@'
3738 || ((len) > 2 && eap->cmd[1] == ':')
Bram Moolenaar2e17fef2022-03-18 19:44:48 +00003739 || STRNCMP(eap->cmd, "g:[", 3) == 0
Bram Moolenaare0890d62021-02-17 14:52:14 +01003740 || variable_exists(eap->cmd, len, cctx))
Bram Moolenaar17126b12021-01-07 22:03:02 +01003741 {
3742 *line = compile_assignment(eap->cmd, eap, CMD_SIZE, cctx);
3743 if (*line == NULL || *line == eap->cmd)
3744 return FAIL;
3745 return OK;
3746 }
3747 }
3748 }
3749
Bram Moolenaar65b0d162022-12-13 18:43:22 +00003750 // might be "[var, var] = expr" or "ifargisset this.member = expr"
3751 if (*eap->cmd == '[' || STRNCMP(eap->cmd, "ifargisset ", 11) == 0)
Bram Moolenaar17126b12021-01-07 22:03:02 +01003752 {
Bram Moolenaar17126b12021-01-07 22:03:02 +01003753 *line = compile_assignment(eap->cmd, eap, CMD_SIZE, cctx);
3754 if (*line == NULL)
3755 return FAIL;
3756 if (*line != eap->cmd)
3757 return OK;
3758 }
3759 return NOTDONE;
3760}
3761
Bram Moolenaar9a015112021-12-31 14:06:45 +00003762/*
3763 * Check if arguments of "ufunc" shadow variables in "cctx".
3764 * Return OK or FAIL.
3765 */
3766 static int
3767check_args_shadowing(ufunc_T *ufunc, cctx_T *cctx)
3768{
3769 int i;
3770 char_u *arg;
3771 int r = OK;
3772
3773 // Make sure arguments are not found when compiling a second time.
3774 ufunc->uf_args_visible = 0;
3775
3776 // Check for arguments shadowing variables from the context.
3777 for (i = 0; i < ufunc->uf_args.ga_len; ++i)
3778 {
3779 arg = ((char_u **)(ufunc->uf_args.ga_data))[i];
Bram Moolenaardce24412022-02-08 20:35:30 +00003780 if (check_defined(arg, STRLEN(arg), cctx, NULL, TRUE) == FAIL)
Bram Moolenaar9a015112021-12-31 14:06:45 +00003781 {
3782 r = FAIL;
3783 break;
3784 }
3785 }
3786 ufunc->uf_args_visible = ufunc->uf_args.ga_len;
3787 return r;
3788}
3789
Bram Moolenaarfcb86b02022-10-07 22:46:24 +01003790#ifdef HAS_MESSAGE_WINDOW
Bram Moolenaar139575d2022-03-15 19:29:30 +00003791/*
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003792 * Get a count before a command. Can only be a number.
3793 * Returns zero if there is no count.
3794 * Returns -1 if there is something wrong.
3795 */
3796 static long
3797get_cmd_count(char_u *line, exarg_T *eap)
3798{
3799 char_u *p;
3800
3801 // skip over colons and white space
3802 for (p = line; *p == ':' || VIM_ISWHITE(*p); ++p)
3803 ;
Keith Thompson184f71c2024-01-04 21:19:04 +01003804 if (!SAFE_isdigit(*p))
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003805 {
Bram Moolenaar2435adf2022-10-21 12:05:46 +01003806 // The command or modifiers must be following. Assume a lower case
3807 // character means there is a modifier.
3808 if (p < eap->cmd && !vim_islower(*p))
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003809 {
3810 emsg(_(e_invalid_range));
3811 return -1;
3812 }
3813 return 0;
3814 }
3815 return atol((char *)p);
3816}
Bram Moolenaarfcb86b02022-10-07 22:46:24 +01003817#endif
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003818
3819/*
Bram Moolenaar139575d2022-03-15 19:29:30 +00003820 * Get the compilation type that should be used for "ufunc".
3821 * Keep in sync with INSTRUCTIONS().
3822 */
3823 compiletype_T
3824get_compile_type(ufunc_T *ufunc)
3825{
3826 // Update uf_has_breakpoint if needed.
3827 update_has_breakpoint(ufunc);
3828
3829 if (debug_break_level > 0 || may_break_in_function(ufunc))
3830 return CT_DEBUG;
3831#ifdef FEAT_PROFILE
3832 if (do_profiling == PROF_YES)
3833 {
Ernie Rael21d32122023-09-02 15:09:18 +02003834 if (!ufunc->uf_profiling && has_profiling(FALSE, ufunc->uf_name, NULL,
3835 &ufunc->uf_hash))
Bram Moolenaar139575d2022-03-15 19:29:30 +00003836 func_do_profile(ufunc);
3837 if (ufunc->uf_profiling)
3838 return CT_PROFILE;
3839 }
3840#endif
3841 return CT_NONE;
3842}
3843
Yegappan Lakshmananf07c10d2024-12-23 10:15:08 +01003844/*
3845 * Free the compiled instructions saved for a def function. This is used when
3846 * compiling a def function and the function was compiled before.
3847 * The index is reused.
3848 */
3849 static void
3850clear_def_function(ufunc_T *ufunc, compiletype_T compile_type)
3851{
3852 isn_T *instr_dest = NULL;
3853 dfunc_T *dfunc;
3854
3855 dfunc = ((dfunc_T *)def_functions.ga_data) + ufunc->uf_dfunc_idx;
3856
3857 switch (compile_type)
3858 {
3859 case CT_PROFILE:
3860#ifdef FEAT_PROFILE
3861 instr_dest = dfunc->df_instr_prof; break;
3862#endif
3863 case CT_NONE: instr_dest = dfunc->df_instr; break;
3864 case CT_DEBUG: instr_dest = dfunc->df_instr_debug; break;
3865 }
3866
3867 if (instr_dest != NULL)
3868 // Was compiled in this mode before: Free old instructions.
3869 delete_def_function_contents(dfunc, FALSE);
3870
3871 ga_clear_strings(&dfunc->df_var_names);
3872 dfunc->df_defer_var_idx = 0;
3873}
Bram Moolenaar7b829262021-10-13 15:04:34 +01003874
3875/*
Bram Moolenaar09689a02020-05-09 22:50:08 +02003876 * Add a function to the list of :def functions.
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003877 * This sets "ufunc->uf_dfunc_idx" but the function isn't compiled yet.
Bram Moolenaar09689a02020-05-09 22:50:08 +02003878 */
Bram Moolenaar822ba242020-05-24 23:00:18 +02003879 static int
Bram Moolenaar09689a02020-05-09 22:50:08 +02003880add_def_function(ufunc_T *ufunc)
3881{
3882 dfunc_T *dfunc;
3883
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003884 if (def_functions.ga_len == 0)
3885 {
3886 // The first position is not used, so that a zero uf_dfunc_idx means it
3887 // wasn't set.
Bram Moolenaar35578162021-08-02 19:10:38 +02003888 if (GA_GROW_FAILS(&def_functions, 1))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003889 return FAIL;
3890 ++def_functions.ga_len;
3891 }
3892
Bram Moolenaar09689a02020-05-09 22:50:08 +02003893 // Add the function to "def_functions".
Bram Moolenaar35578162021-08-02 19:10:38 +02003894 if (GA_GROW_FAILS(&def_functions, 1))
Bram Moolenaar09689a02020-05-09 22:50:08 +02003895 return FAIL;
3896 dfunc = ((dfunc_T *)def_functions.ga_data) + def_functions.ga_len;
3897 CLEAR_POINTER(dfunc);
3898 dfunc->df_idx = def_functions.ga_len;
3899 ufunc->uf_dfunc_idx = dfunc->df_idx;
3900 dfunc->df_ufunc = ufunc;
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01003901 dfunc->df_name = vim_strsave(ufunc->uf_name);
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02003902 ga_init2(&dfunc->df_var_names, sizeof(char_u *), 10);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01003903 ++dfunc->df_refcount;
Bram Moolenaar09689a02020-05-09 22:50:08 +02003904 ++def_functions.ga_len;
3905 return OK;
3906}
3907
Yegappan Lakshmananf07c10d2024-12-23 10:15:08 +01003908 static int
3909compile_dfunc_ufunc_init(
3910 ufunc_T *ufunc,
3911 cctx_T *outer_cctx,
3912 compiletype_T compile_type,
3913 int *new_def_function)
3914{
3915 // When using a function that was compiled before: Free old instructions.
3916 // The index is reused. Otherwise add a new entry in "def_functions".
3917 if (ufunc->uf_dfunc_idx > 0)
3918 clear_def_function(ufunc, compile_type);
3919 else
3920 {
3921 if (add_def_function(ufunc) == FAIL)
3922 return FAIL;
3923
3924 *new_def_function = TRUE;
3925 }
3926
3927 if ((ufunc->uf_flags & FC_CLOSURE) && outer_cctx == NULL)
3928 {
3929 semsg(_(e_compiling_closure_without_context_str),
3930 printable_func_name(ufunc));
3931 return FAIL;
3932 }
3933
3934 ufunc->uf_def_status = UF_COMPILING;
3935
3936 return OK;
3937}
3938
3939/*
3940 * Initialize the compilation context for compiling a def function.
3941 */
3942 static void
3943compile_dfunc_cctx_init(
3944 cctx_T *cctx,
3945 cctx_T *outer_cctx,
3946 ufunc_T *ufunc,
3947 compiletype_T compile_type)
3948{
3949 CLEAR_FIELD(*cctx);
3950
3951 cctx->ctx_compile_type = compile_type;
3952 cctx->ctx_ufunc = ufunc;
3953 cctx->ctx_lnum = -1;
3954 cctx->ctx_outer = outer_cctx;
3955 ga_init2(&cctx->ctx_locals, sizeof(lvar_T), 10);
3956 // Each entry on the type stack consists of two type pointers.
3957 ga_init2(&cctx->ctx_type_stack, sizeof(type2_T), 50);
3958 cctx->ctx_type_list = &ufunc->uf_type_list;
3959 ga_init2(&cctx->ctx_instr, sizeof(isn_T), 50);
3960}
3961
Bram Moolenaar09689a02020-05-09 22:50:08 +02003962/*
Yegappan Lakshmananf6c1fb22024-04-25 21:30:56 +02003963 * For an object constructor, generate instruction to setup "this" (the first
3964 * local variable) and to initialize the object variables.
3965 */
3966 static int
3967obj_constructor_prologue(ufunc_T *ufunc, cctx_T *cctx)
3968{
3969 generate_CONSTRUCT(cctx, ufunc->uf_class);
3970
3971 for (int i = 0; i < ufunc->uf_class->class_obj_member_count; ++i)
3972 {
3973 ocmember_T *m = &ufunc->uf_class->class_obj_members[i];
3974
3975 if (i < 2 && IS_ENUM(ufunc->uf_class))
3976 // The first two object variables in an enum are the name
3977 // and the ordinal. These are set by the ISN_CONSTRUCT
3978 // instruction. So don't generate instructions to set
3979 // these variables.
3980 continue;
3981
3982 if (m->ocm_init != NULL)
3983 {
3984 char_u *expr = m->ocm_init;
3985
3986 if (compile_expr0(&expr, cctx) == FAIL)
3987 return FAIL;
3988
3989 if (!ends_excmd2(m->ocm_init, expr))
3990 {
3991 semsg(_(e_trailing_characters_str), expr);
3992 return FAIL;
3993 }
3994
3995 type_T *type = get_type_on_stack(cctx, 0);
3996 if (m->ocm_type->tt_type == VAR_ANY
3997 && !(m->ocm_flags & OCMFLAG_HAS_TYPE)
3998 && type->tt_type != VAR_SPECIAL)
3999 {
4000 // If the member variable type is not yet set, then use
4001 // the initialization expression type.
4002 m->ocm_type = type;
4003 }
LemonBoyf4af3312024-07-04 13:43:12 +02004004 else
Yegappan Lakshmananf6c1fb22024-04-25 21:30:56 +02004005 {
4006 // The type of the member initialization expression is
4007 // determined at run time. Add a runtime type check.
4008 where_T where = WHERE_INIT;
4009 where.wt_kind = WT_MEMBER;
4010 where.wt_func_name = (char *)m->ocm_name;
4011 if (need_type_where(type, m->ocm_type, FALSE, -1,
4012 where, cctx, FALSE, FALSE) == FAIL)
4013 return FAIL;
4014 }
4015 }
4016 else
4017 push_default_value(cctx, m->ocm_type->tt_type, FALSE, NULL);
4018
LemonBoyf4af3312024-07-04 13:43:12 +02004019 if ((m->ocm_type->tt_type == VAR_DICT
4020 || m->ocm_type->tt_type == VAR_LIST)
4021 && m->ocm_type->tt_member != NULL
4022 && m->ocm_type->tt_member != &t_any
4023 && m->ocm_type->tt_member != &t_unknown)
4024 // Set the type in the list or dict, so that it can be checked,
4025 // also in legacy script.
4026 generate_SETTYPE(cctx, m->ocm_type);
4027
Yegappan Lakshmananf6c1fb22024-04-25 21:30:56 +02004028 generate_STORE_THIS(cctx, i);
4029 }
4030
4031 return OK;
4032}
4033
4034/*
4035 * For an object method and an constructor, generate instruction to setup
4036 * "this" (the first local variable). For a constructor, generate instructions
4037 * to initialize the object variables.
4038 */
4039 static int
4040obj_method_prologue(ufunc_T *ufunc, cctx_T *cctx)
4041{
4042 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data) + ufunc->uf_dfunc_idx;
4043
4044 if (GA_GROW_FAILS(&dfunc->df_var_names, 1))
4045 return FAIL;
4046
4047 ((char_u **)dfunc->df_var_names.ga_data)[0] =
4048 vim_strsave((char_u *)"this");
4049 ++dfunc->df_var_names.ga_len;
4050
4051 // In the constructor allocate memory for the object and initialize the
4052 // object members.
4053 if (IS_CONSTRUCTOR_METHOD(ufunc))
4054 return obj_constructor_prologue(ufunc, cctx);
4055
4056 return OK;
4057}
4058
4059/*
4060 * Produce instructions for the default values of optional arguments.
4061 */
4062 static int
4063compile_def_function_default_args(
4064 ufunc_T *ufunc,
Yegappan Lakshmananf07c10d2024-12-23 10:15:08 +01004065 garray_T *instr,
4066 cctx_T *cctx)
Yegappan Lakshmananf6c1fb22024-04-25 21:30:56 +02004067{
4068 int count = ufunc->uf_def_args.ga_len;
4069 int first_def_arg = ufunc->uf_args.ga_len - count;
4070 int i;
4071 int off = STACK_FRAME_SIZE + (ufunc->uf_va_name != NULL ? 1 : 0);
4072 int did_set_arg_type = FALSE;
4073
4074 // Produce instructions for the default values of optional arguments.
4075 SOURCING_LNUM = 0; // line number unknown
4076 for (i = 0; i < count; ++i)
4077 {
4078 char_u *arg = ((char_u **)(ufunc->uf_def_args.ga_data))[i];
4079 if (STRCMP(arg, "v:none") == 0)
4080 // "arg = v:none" means the argument is optional without
4081 // setting a value when the argument is missing.
4082 continue;
4083
4084 type_T *val_type;
4085 int arg_idx = first_def_arg + i;
4086 where_T where = WHERE_INIT;
4087 int jump_instr_idx = instr->ga_len;
4088 isn_T *isn;
4089
4090 // Use a JUMP_IF_ARG_SET instruction to skip if the value was given.
4091 if (generate_JUMP_IF_ARG(cctx, ISN_JUMP_IF_ARG_SET,
4092 i - count - off) == FAIL)
4093 return FAIL;
4094
4095 // Make sure later arguments are not found.
4096 ufunc->uf_args_visible = arg_idx;
4097
4098 int r = compile_expr0(&arg, cctx);
4099 if (r == FAIL)
4100 return FAIL;
4101
4102 // If no type specified use the type of the default value.
4103 // Otherwise check that the default value type matches the
4104 // specified type.
4105 val_type = get_type_on_stack(cctx, 0);
4106 where.wt_index = arg_idx + 1;
4107 where.wt_kind = WT_ARGUMENT;
4108 if (ufunc->uf_arg_types[arg_idx] == &t_unknown)
4109 {
4110 did_set_arg_type = TRUE;
4111 ufunc->uf_arg_types[arg_idx] = val_type;
4112 }
4113 else if (need_type_where(val_type, ufunc->uf_arg_types[arg_idx],
4114 FALSE, -1, where, cctx, FALSE, FALSE) == FAIL)
4115 return FAIL;
4116
4117 if (generate_STORE(cctx, ISN_STORE, i - count - off, NULL) == FAIL)
4118 return FAIL;
4119
4120 // set instruction index in JUMP_IF_ARG_SET to here
4121 isn = ((isn_T *)instr->ga_data) + jump_instr_idx;
4122 isn->isn_arg.jumparg.jump_where = instr->ga_len;
4123 }
4124
4125 if (did_set_arg_type)
4126 set_function_type(ufunc);
4127
4128 return OK;
4129}
4130
4131/*
Yegappan Lakshmanana16f2512024-04-23 20:14:46 +02004132 * Compile def function body. Loop over all the lines in the function and
4133 * generate instructions.
4134 */
4135 static int
4136compile_def_function_body(
Yegappan Lakshmanana16f2512024-04-23 20:14:46 +02004137 int last_func_lnum,
4138 int check_return_type,
4139 garray_T *lines_to_free,
Yegappan Lakshmananf07c10d2024-12-23 10:15:08 +01004140 char **errormsg,
4141 cctx_T *cctx)
Yegappan Lakshmanana16f2512024-04-23 20:14:46 +02004142{
4143 char_u *line = NULL;
4144 char_u *p;
4145 int did_emsg_before = did_emsg;
4146#ifdef FEAT_PROFILE
4147 int prof_lnum = -1;
4148#endif
4149 int debug_lnum = -1;
4150
4151 for (;;)
4152 {
4153 exarg_T ea;
4154 int starts_with_colon = FALSE;
4155 char_u *cmd;
4156 cmdmod_T local_cmdmod;
4157
4158 // Bail out on the first error to avoid a flood of errors and report
4159 // the right line number when inside try/catch.
4160 if (did_emsg_before != did_emsg)
4161 return FAIL;
4162
4163 if (line != NULL && *line == '|')
4164 // the line continues after a '|'
4165 ++line;
4166 else if (line != NULL && *skipwhite(line) != NUL
4167 && !(*line == '#' && (line == cctx->ctx_line_start
4168 || VIM_ISWHITE(line[-1]))))
4169 {
4170 semsg(_(e_trailing_characters_str), line);
4171 return FAIL;
4172 }
4173 else if (line != NULL && vim9_bad_comment(skipwhite(line)))
4174 return FAIL;
4175 else
4176 {
4177 line = next_line_from_context(cctx, FALSE);
4178 if (cctx->ctx_lnum >= last_func_lnum)
4179 {
4180 // beyond the last line
4181#ifdef FEAT_PROFILE
4182 if (cctx->ctx_skip != SKIP_YES)
4183 may_generate_prof_end(cctx, prof_lnum);
4184#endif
4185 break;
4186 }
4187 // Make a copy, splitting off nextcmd and removing trailing spaces
4188 // may change it.
4189 if (line != NULL)
4190 {
4191 line = vim_strsave(line);
4192 if (ga_add_string(lines_to_free, line) == FAIL)
4193 return FAIL;
4194 }
4195 }
4196
4197 CLEAR_FIELD(ea);
4198 ea.cmdlinep = &line;
4199 ea.cmd = skipwhite(line);
4200 ea.skip = cctx->ctx_skip == SKIP_YES;
4201
4202 if (*ea.cmd == '#')
4203 {
4204 // "#" starts a comment, but "#{" is an error
4205 if (vim9_bad_comment(ea.cmd))
4206 return FAIL;
4207 line = (char_u *)"";
4208 continue;
4209 }
4210
4211#ifdef FEAT_PROFILE
4212 if (cctx->ctx_compile_type == CT_PROFILE && cctx->ctx_lnum != prof_lnum
4213 && cctx->ctx_skip != SKIP_YES)
4214 {
4215 may_generate_prof_end(cctx, prof_lnum);
4216
4217 prof_lnum = cctx->ctx_lnum;
4218 generate_instr(cctx, ISN_PROF_START);
4219 }
4220#endif
4221 if (cctx->ctx_compile_type == CT_DEBUG && cctx->ctx_lnum != debug_lnum
4222 && cctx->ctx_skip != SKIP_YES)
4223 {
4224 debug_lnum = cctx->ctx_lnum;
4225 generate_instr_debug(cctx);
4226 }
4227 cctx->ctx_prev_lnum = cctx->ctx_lnum + 1;
4228
4229 // Some things can be recognized by the first character.
4230 switch (*ea.cmd)
4231 {
4232 case '}':
4233 {
4234 // "}" ends a block scope
4235 scopetype_T stype = cctx->ctx_scope == NULL
4236 ? NO_SCOPE : cctx->ctx_scope->se_type;
4237
4238 if (stype == BLOCK_SCOPE)
4239 {
4240 compile_endblock(cctx);
4241 line = ea.cmd;
4242 }
4243 else
4244 {
4245 emsg(_(e_using_rcurly_outside_if_block_scope));
4246 return FAIL;
4247 }
4248 if (line != NULL)
4249 line = skipwhite(ea.cmd + 1);
4250 continue;
4251 }
4252
4253 case '{':
4254 // "{" starts a block scope
4255 // "{'a': 1}->func() is something else
4256 if (ends_excmd(*skipwhite(ea.cmd + 1)))
4257 {
4258 line = compile_block(ea.cmd, cctx);
4259 continue;
4260 }
4261 break;
4262 }
4263
4264 /*
4265 * COMMAND MODIFIERS
4266 */
4267 cctx->ctx_has_cmdmod = FALSE;
4268 if (parse_command_modifiers(&ea, errormsg, &local_cmdmod, FALSE)
4269 == FAIL)
4270 return FAIL;
4271 generate_cmdmods(cctx, &local_cmdmod);
4272 undo_cmdmod(&local_cmdmod);
4273
4274 // Check if there was a colon after the last command modifier or before
4275 // the current position.
4276 for (p = ea.cmd; p >= line; --p)
4277 {
4278 if (*p == ':')
4279 starts_with_colon = TRUE;
4280 if (p < ea.cmd && !VIM_ISWHITE(*p))
4281 break;
4282 }
4283
4284 // Skip ":call" to get to the function name, unless using :legacy
4285 p = ea.cmd;
4286 if (!(local_cmdmod.cmod_flags & CMOD_LEGACY))
4287 {
4288 if (checkforcmd(&ea.cmd, "call", 3))
4289 {
4290 if (*ea.cmd == '(')
4291 // not for "call()"
4292 ea.cmd = p;
4293 else
4294 ea.cmd = skipwhite(ea.cmd);
4295 }
4296
4297 if (!starts_with_colon)
4298 {
4299 int assign;
4300
4301 // Check for assignment after command modifiers.
4302 assign = may_compile_assignment(&ea, &line, cctx);
4303 if (assign == OK)
4304 goto nextline;
4305 if (assign == FAIL)
4306 return FAIL;
4307 }
4308 }
4309
4310 /*
4311 * COMMAND after range
4312 * 'text'->func() should not be confused with 'a mark
4313 * 0z1234->func() should not be confused with a zero line number
4314 * "++nr" and "--nr" are eval commands
4315 * in "$ENV->func()" the "$" is not a range
4316 * "123->func()" is a method call
4317 */
4318 cmd = ea.cmd;
4319 if ((*cmd != '$' || starts_with_colon)
4320 && (starts_with_colon
4321 || !(*cmd == '\''
4322 || (cmd[0] == '0' && cmd[1] == 'z')
4323 || (cmd[0] != NUL && cmd[0] == cmd[1]
4324 && (*cmd == '+' || *cmd == '-'))
4325 || number_method(cmd))))
4326 {
4327 ea.cmd = skip_range(ea.cmd, TRUE, NULL);
4328 if (ea.cmd > cmd)
4329 {
4330 if (!starts_with_colon
4331 && !(local_cmdmod.cmod_flags & CMOD_LEGACY))
4332 {
4333 semsg(_(e_colon_required_before_range_str), cmd);
4334 return FAIL;
4335 }
4336 ea.addr_count = 1;
4337 if (ends_excmd2(line, ea.cmd))
4338 {
4339 // A range without a command: jump to the line.
4340 generate_EXEC(cctx, ISN_EXECRANGE,
4341 vim_strnsave(cmd, ea.cmd - cmd));
4342 line = ea.cmd;
4343 goto nextline;
4344 }
4345 }
4346 }
4347 p = find_ex_command(&ea, NULL,
4348 starts_with_colon || (local_cmdmod.cmod_flags & CMOD_LEGACY)
4349 ? NULL : item_exists, cctx);
4350
4351 if (p == NULL)
4352 {
4353 if (cctx->ctx_skip != SKIP_YES)
4354 semsg(_(e_ambiguous_use_of_user_defined_command_str), ea.cmd);
4355 return FAIL;
4356 }
4357
4358 // When using ":legacy cmd" always use compile_exec().
4359 if (local_cmdmod.cmod_flags & CMOD_LEGACY)
4360 {
4361 char_u *start = ea.cmd;
4362
4363 switch (ea.cmdidx)
4364 {
4365 case CMD_if:
4366 case CMD_elseif:
4367 case CMD_else:
4368 case CMD_endif:
4369 case CMD_for:
4370 case CMD_endfor:
4371 case CMD_continue:
4372 case CMD_break:
4373 case CMD_while:
4374 case CMD_endwhile:
4375 case CMD_try:
4376 case CMD_catch:
4377 case CMD_finally:
4378 case CMD_endtry:
4379 semsg(_(e_cannot_use_legacy_with_command_str), ea.cmd);
4380 return FAIL;
4381 default: break;
4382 }
4383
4384 // ":legacy return expr" needs to be handled differently.
4385 if (checkforcmd(&start, "return", 4))
4386 ea.cmdidx = CMD_return;
4387 else
4388 ea.cmdidx = CMD_legacy;
4389 }
4390
4391 if (p == ea.cmd && ea.cmdidx != CMD_SIZE)
4392 {
4393 // "eval" is used for "val->func()" and "var" for "var = val", then
4394 // "p" is equal to "ea.cmd" for a valid command.
4395 if (ea.cmdidx == CMD_eval || ea.cmdidx == CMD_var)
4396 ;
4397 else if (cctx->ctx_skip == SKIP_YES)
4398 {
4399 line += STRLEN(line);
4400 goto nextline;
4401 }
4402 else
4403 {
4404 semsg(_(e_command_not_recognized_str), ea.cmd);
4405 return FAIL;
4406 }
4407 }
4408
4409 if ((cctx->ctx_had_return || cctx->ctx_had_throw)
4410 && ea.cmdidx != CMD_elseif
4411 && ea.cmdidx != CMD_else
4412 && ea.cmdidx != CMD_endif
4413 && ea.cmdidx != CMD_endfor
4414 && ea.cmdidx != CMD_endwhile
4415 && ea.cmdidx != CMD_catch
4416 && ea.cmdidx != CMD_finally
4417 && ea.cmdidx != CMD_endtry
4418 && !ignore_unreachable_code_for_testing)
4419 {
4420 semsg(_(e_unreachable_code_after_str),
4421 cctx->ctx_had_return ? "return" : "throw");
4422 return FAIL;
4423 }
Yegappan Lakshmananab9a8942024-12-30 09:56:34 +01004424
4425 // When processing the end of an if-else block, don't clear the
4426 // "ctx_had_throw" flag. If an if-else block ends in a "throw"
4427 // statement, then it is considered to end in a "return" statement.
4428 // The "ctx_had_throw" is cleared immediately after processing the
4429 // if-else block ending statement.
4430 // Otherwise, clear the "had_throw" flag.
4431 if (ea.cmdidx != CMD_else && ea.cmdidx != CMD_elseif
4432 && ea.cmdidx != CMD_endif)
4433 cctx->ctx_had_throw = FALSE;
Yegappan Lakshmanana16f2512024-04-23 20:14:46 +02004434
4435 p = skipwhite(p);
4436 if (ea.cmdidx != CMD_SIZE
4437 && ea.cmdidx != CMD_write && ea.cmdidx != CMD_read)
4438 {
4439 if (ea.cmdidx >= 0)
4440 ea.argt = excmd_get_argt(ea.cmdidx);
4441 if ((ea.argt & EX_BANG) && *p == '!')
4442 {
4443 ea.forceit = TRUE;
4444 p = skipwhite(p + 1);
4445 }
4446 if ((ea.argt & EX_RANGE) == 0 && ea.addr_count > 0)
4447 {
4448 emsg(_(e_no_range_allowed));
4449 return FAIL;
4450 }
4451 }
4452
4453 switch (ea.cmdidx)
4454 {
4455 case CMD_def:
4456 case CMD_function:
4457 ea.arg = p;
4458 line = compile_nested_function(&ea, cctx, lines_to_free);
4459 break;
4460
4461 case CMD_return:
4462 line = compile_return(p, check_return_type,
4463 local_cmdmod.cmod_flags & CMOD_LEGACY, cctx);
4464 cctx->ctx_had_return = TRUE;
4465 break;
4466
4467 case CMD_let:
4468 emsg(_(e_cannot_use_let_in_vim9_script));
4469 break;
4470 case CMD_var:
4471 case CMD_final:
4472 case CMD_const:
4473 case CMD_increment:
4474 case CMD_decrement:
4475 line = compile_assignment(p, &ea, ea.cmdidx, cctx);
4476 if (line == p)
4477 {
4478 emsg(_(e_invalid_assignment));
4479 line = NULL;
4480 }
4481 break;
4482
4483 case CMD_unlet:
4484 case CMD_unlockvar:
4485 case CMD_lockvar:
4486 line = compile_unletlock(p, &ea, cctx);
4487 break;
4488
4489 case CMD_import:
4490 emsg(_(e_import_can_only_be_used_in_script));
4491 line = NULL;
4492 break;
4493
4494 case CMD_if:
4495 line = compile_if(p, cctx);
4496 break;
4497 case CMD_elseif:
4498 line = compile_elseif(p, cctx);
4499 cctx->ctx_had_return = FALSE;
Yegappan Lakshmananab9a8942024-12-30 09:56:34 +01004500 cctx->ctx_had_throw = FALSE;
Yegappan Lakshmanana16f2512024-04-23 20:14:46 +02004501 break;
4502 case CMD_else:
4503 line = compile_else(p, cctx);
4504 cctx->ctx_had_return = FALSE;
Yegappan Lakshmananab9a8942024-12-30 09:56:34 +01004505 cctx->ctx_had_throw = FALSE;
Yegappan Lakshmanana16f2512024-04-23 20:14:46 +02004506 break;
4507 case CMD_endif:
4508 line = compile_endif(p, cctx);
Yegappan Lakshmananab9a8942024-12-30 09:56:34 +01004509 cctx->ctx_had_throw = FALSE;
Yegappan Lakshmanana16f2512024-04-23 20:14:46 +02004510 break;
4511
4512 case CMD_while:
4513 line = compile_while(p, cctx);
4514 break;
4515 case CMD_endwhile:
4516 line = compile_endwhile(p, cctx);
4517 cctx->ctx_had_return = FALSE;
4518 break;
4519
4520 case CMD_for:
4521 line = compile_for(p, cctx);
4522 break;
4523 case CMD_endfor:
4524 line = compile_endfor(p, cctx);
4525 cctx->ctx_had_return = FALSE;
4526 break;
4527 case CMD_continue:
4528 line = compile_continue(p, cctx);
4529 break;
4530 case CMD_break:
4531 line = compile_break(p, cctx);
4532 break;
4533
4534 case CMD_try:
4535 line = compile_try(p, cctx);
4536 break;
4537 case CMD_catch:
4538 line = compile_catch(p, cctx);
4539 cctx->ctx_had_return = FALSE;
4540 break;
4541 case CMD_finally:
4542 line = compile_finally(p, cctx);
4543 cctx->ctx_had_return = FALSE;
4544 break;
4545 case CMD_endtry:
4546 line = compile_endtry(p, cctx);
4547 break;
4548 case CMD_throw:
4549 line = compile_throw(p, cctx);
4550 cctx->ctx_had_throw = TRUE;
4551 break;
4552
4553 case CMD_eval:
4554 line = compile_eval(p, cctx);
4555 break;
4556
4557 case CMD_defer:
4558 line = compile_defer(p, cctx);
4559 break;
4560
4561#ifdef HAS_MESSAGE_WINDOW
4562 case CMD_echowindow:
4563 {
4564 long cmd_count = get_cmd_count(line, &ea);
4565 if (cmd_count < 0)
4566 line = NULL;
4567 else
4568 line = compile_mult_expr(p, ea.cmdidx,
4569 cmd_count, cctx);
4570 }
4571 break;
4572#endif
4573 case CMD_echo:
4574 case CMD_echon:
4575 case CMD_echoconsole:
4576 case CMD_echoerr:
4577 case CMD_echomsg:
4578 case CMD_execute:
4579 line = compile_mult_expr(p, ea.cmdidx, 0, cctx);
4580 break;
4581
4582 case CMD_put:
4583 ea.cmd = cmd;
4584 line = compile_put(p, &ea, cctx);
4585 break;
4586
4587 case CMD_substitute:
4588 if (check_global_and_subst(ea.cmd, p) == FAIL)
4589 return FAIL;
4590 if (cctx->ctx_skip == SKIP_YES)
4591 line = (char_u *)"";
4592 else
4593 {
4594 ea.arg = p;
4595 line = compile_substitute(line, &ea, cctx);
4596 }
4597 break;
4598
4599 case CMD_redir:
4600 ea.arg = p;
4601 line = compile_redir(line, &ea, cctx);
4602 break;
4603
4604 case CMD_cexpr:
4605 case CMD_lexpr:
4606 case CMD_caddexpr:
4607 case CMD_laddexpr:
4608 case CMD_cgetexpr:
4609 case CMD_lgetexpr:
4610#ifdef FEAT_QUICKFIX
4611 ea.arg = p;
4612 line = compile_cexpr(line, &ea, cctx);
4613#else
4614 ex_ni(&ea);
4615 line = NULL;
4616#endif
4617 break;
4618
4619 case CMD_append:
4620 case CMD_change:
4621 case CMD_insert:
4622 case CMD_k:
4623 case CMD_t:
4624 case CMD_xit:
4625 not_in_vim9(&ea);
4626 return FAIL;
4627
4628 case CMD_SIZE:
4629 if (cctx->ctx_skip != SKIP_YES)
4630 {
4631 semsg(_(e_invalid_command_str), ea.cmd);
4632 return FAIL;
4633 }
4634 // We don't check for a next command here.
4635 line = (char_u *)"";
4636 break;
4637
4638 case CMD_lua:
4639 case CMD_mzscheme:
4640 case CMD_perl:
4641 case CMD_py3:
4642 case CMD_python3:
4643 case CMD_python:
4644 case CMD_pythonx:
4645 case CMD_ruby:
4646 case CMD_tcl:
4647 ea.arg = p;
4648 if (vim_strchr(line, '\n') == NULL)
4649 line = compile_exec(line, &ea, cctx);
4650 else
4651 // heredoc lines have been concatenated with NL
4652 // characters in get_function_body()
4653 line = compile_script(line, cctx);
4654 break;
4655
4656 case CMD_vim9script:
4657 if (cctx->ctx_skip != SKIP_YES)
4658 {
4659 emsg(_(e_vim9script_can_only_be_used_in_script));
4660 return FAIL;
4661 }
4662 line = (char_u *)"";
4663 break;
4664
4665 case CMD_class:
4666 emsg(_(e_class_can_only_be_used_in_script));
4667 return FAIL;
4668
4669 case CMD_type:
4670 emsg(_(e_type_can_only_be_used_in_script));
4671 return FAIL;
4672
4673 case CMD_global:
4674 if (check_global_and_subst(ea.cmd, p) == FAIL)
4675 return FAIL;
4676 // FALLTHROUGH
4677 default:
4678 // Not recognized, execute with do_cmdline_cmd().
4679 ea.arg = p;
4680 line = compile_exec(line, &ea, cctx);
4681 break;
4682 }
4683nextline:
4684 if (line == NULL)
4685 return FAIL;
4686 line = skipwhite(line);
4687
4688 // Undo any command modifiers.
4689 generate_undo_cmdmods(cctx);
4690
4691 if (cctx->ctx_type_stack.ga_len < 0)
4692 {
4693 iemsg("Type stack underflow");
4694 return FAIL;
4695 }
4696 } // END of the loop over all the function body lines.
4697
4698 return OK;
4699}
4700
4701/*
Yegappan Lakshmananf07c10d2024-12-23 10:15:08 +01004702 * Returns TRUE if the end of a scope (if, while, for, block) is missing.
4703 * Called after compiling a def function body.
4704 */
4705 static int
4706compile_dfunc_scope_end_missing(cctx_T *cctx)
4707{
4708 if (cctx->ctx_scope == NULL)
4709 return FALSE;
4710
4711 if (cctx->ctx_scope->se_type == IF_SCOPE)
4712 emsg(_(e_missing_endif));
4713 else if (cctx->ctx_scope->se_type == WHILE_SCOPE)
4714 emsg(_(e_missing_endwhile));
4715 else if (cctx->ctx_scope->se_type == FOR_SCOPE)
4716 emsg(_(e_missing_endfor));
4717 else
4718 emsg(_(e_missing_rcurly));
4719
4720 return TRUE;
4721}
4722
4723/*
Yegappan Lakshmananab9a8942024-12-30 09:56:34 +01004724 * When compiling a def function, if it doesn't have an explicit return
Yegappan Lakshmananf07c10d2024-12-23 10:15:08 +01004725 * statement, then generate a default return instruction. For an object
4726 * constructor, return the object.
4727 */
4728 static int
4729compile_dfunc_generate_default_return(ufunc_T *ufunc, cctx_T *cctx)
4730{
4731 // TODO: if a function ends in "throw" but there was a return elsewhere we
4732 // should not assume the return type is "void".
4733 if (cctx->ctx_had_return || cctx->ctx_had_throw)
4734 return OK;
4735
4736 if (ufunc->uf_ret_type->tt_type == VAR_UNKNOWN)
4737 ufunc->uf_ret_type = &t_void;
4738 else if (ufunc->uf_ret_type->tt_type != VAR_VOID
4739 && !IS_CONSTRUCTOR_METHOD(ufunc))
4740 {
4741 emsg(_(e_missing_return_statement));
4742 return FAIL;
4743 }
4744
4745 // Return void if there is no return at the end.
4746 // For a constructor return the object.
4747 if (IS_CONSTRUCTOR_METHOD(ufunc))
4748 {
4749 generate_instr(cctx, ISN_RETURN_OBJECT);
4750 ufunc->uf_ret_type = &ufunc->uf_class->class_object_type;
4751 }
4752 else
4753 generate_instr(cctx, ISN_RETURN_VOID);
4754
4755 return OK;
4756}
4757
4758/*
4759 * Perform the chores after successfully compiling a def function.
4760 */
4761 static void
4762compile_dfunc_epilogue(
4763 cctx_T *outer_cctx,
4764 ufunc_T *ufunc,
4765 garray_T *instr,
4766 cctx_T *cctx)
4767{
4768 dfunc_T *dfunc;
4769
4770 dfunc = ((dfunc_T *)def_functions.ga_data) + ufunc->uf_dfunc_idx;
4771 dfunc->df_deleted = FALSE;
4772 dfunc->df_script_seq = current_sctx.sc_seq;
4773
4774#ifdef FEAT_PROFILE
4775 if (cctx->ctx_compile_type == CT_PROFILE)
4776 {
4777 dfunc->df_instr_prof = instr->ga_data;
4778 dfunc->df_instr_prof_count = instr->ga_len;
4779 }
4780 else
4781#endif
4782 if (cctx->ctx_compile_type == CT_DEBUG)
4783 {
4784 dfunc->df_instr_debug = instr->ga_data;
4785 dfunc->df_instr_debug_count = instr->ga_len;
4786 }
4787 else
4788 {
4789 dfunc->df_instr = instr->ga_data;
4790 dfunc->df_instr_count = instr->ga_len;
4791 }
4792 dfunc->df_varcount = dfunc->df_var_names.ga_len;
4793 dfunc->df_has_closure = cctx->ctx_has_closure;
4794
4795 if (cctx->ctx_outer_used)
4796 {
4797 ufunc->uf_flags |= FC_CLOSURE;
4798 if (outer_cctx != NULL)
4799 ++outer_cctx->ctx_closure_count;
4800 }
4801
4802 ufunc->uf_def_status = UF_COMPILED;
4803}
4804
4805/*
4806 * Perform the cleanup when a def function compilation fails.
4807 */
4808 static void
4809compile_dfunc_ufunc_cleanup(
4810 ufunc_T *ufunc,
4811 garray_T *instr,
4812 int new_def_function,
4813 char *errormsg,
4814 int did_emsg_before,
4815 cctx_T *cctx)
4816{
4817 dfunc_T *dfunc;
4818
4819 dfunc = ((dfunc_T *)def_functions.ga_data) + ufunc->uf_dfunc_idx;
4820
4821 // Compiling aborted, free the generated instructions.
4822 clear_instr_ga(instr);
4823 VIM_CLEAR(dfunc->df_name);
4824 ga_clear_strings(&dfunc->df_var_names);
4825
4826 // If using the last entry in the table and it was added above, we
4827 // might as well remove it.
4828 if (!dfunc->df_deleted && new_def_function
4829 && ufunc->uf_dfunc_idx == def_functions.ga_len - 1)
4830 {
4831 --def_functions.ga_len;
4832 ufunc->uf_dfunc_idx = 0;
4833 }
4834 ufunc->uf_def_status = UF_COMPILE_ERROR;
4835
4836 while (cctx->ctx_scope != NULL)
4837 drop_scope(cctx);
4838
4839 if (errormsg != NULL)
4840 emsg(errormsg);
4841 else if (did_emsg == did_emsg_before)
4842 emsg(_(e_compiling_def_function_failed));
4843}
4844
4845/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004846 * After ex_function() has collected all the function lines: parse and compile
4847 * the lines into instructions.
4848 * Adds the function to "def_functions".
Bram Moolenaar9e68c322020-12-25 12:38:04 +01004849 * When "check_return_type" is set then set ufunc->uf_ret_type to the type of
4850 * the return statement (used for lambda). When uf_ret_type is already set
4851 * then check that it matches.
Bram Moolenaarb2049902021-01-24 12:53:53 +01004852 * When "profiling" is true add ISN_PROF_START instructions.
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +02004853 * "outer_cctx" is set for a nested function.
Bram Moolenaar05afcee2020-03-31 23:32:31 +02004854 * This can be used recursively through compile_lambda(), which may reallocate
4855 * "def_functions".
Bram Moolenaar822ba242020-05-24 23:00:18 +02004856 * Returns OK or FAIL.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004857 */
Bram Moolenaar822ba242020-05-24 23:00:18 +02004858 int
Bram Moolenaarb2049902021-01-24 12:53:53 +01004859compile_def_function(
Bram Moolenaare99d4222021-06-13 14:01:26 +02004860 ufunc_T *ufunc,
4861 int check_return_type,
4862 compiletype_T compile_type,
4863 cctx_T *outer_cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004864{
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004865 garray_T lines_to_free;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004866 char *errormsg = NULL; // error message
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004867 cctx_T cctx;
4868 garray_T *instr;
Bram Moolenaard66960b2020-10-30 20:46:26 +01004869 int did_emsg_before = did_emsg;
Bram Moolenaar599410c2021-04-10 14:03:43 +02004870 int did_emsg_silent_before = did_emsg_silent;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004871 int ret = FAIL;
4872 sctx_T save_current_sctx = current_sctx;
Bram Moolenaarf4e8cdd2020-10-12 22:07:13 +02004873 int save_estack_compiling = estack_compiling;
Bram Moolenaardc4c2302021-04-25 13:54:42 +02004874 int save_cmod_flags = cmdmod.cmod_flags;
Bram Moolenaar25e0f582020-05-25 22:36:50 +02004875 int do_estack_push;
Bram Moolenaar6c4bfe42020-07-23 18:26:30 +02004876 int new_def_function = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004877
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004878 // allocated lines are freed at the end
4879 ga_init2(&lines_to_free, sizeof(char_u *), 50);
4880
Yegappan Lakshmananf07c10d2024-12-23 10:15:08 +01004881 // Initialize the ufunc and the compilation context
4882 if (compile_dfunc_ufunc_init(ufunc, outer_cctx, compile_type,
4883 &new_def_function) == FAIL)
Bram Moolenaar96923b72022-03-15 15:57:04 +00004884 return FAIL;
Bram Moolenaar96923b72022-03-15 15:57:04 +00004885
Yegappan Lakshmananf07c10d2024-12-23 10:15:08 +01004886 compile_dfunc_cctx_init(&cctx, outer_cctx, ufunc, compile_type);
Bram Moolenaar985116a2020-07-12 17:31:09 +02004887
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004888 instr = &cctx.ctx_instr;
4889
Bram Moolenaar25e0f582020-05-25 22:36:50 +02004890 // Set the context to the function, it may be compiled when called from
4891 // another script. Set the script version to the most modern one.
4892 // The line number will be set in next_line_from_context().
4893 current_sctx = ufunc->uf_script_ctx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004894 current_sctx.sc_version = SCRIPT_VERSION_VIM9;
4895
Bram Moolenaardc4c2302021-04-25 13:54:42 +02004896 // Don't use the flag from ":legacy" here.
4897 cmdmod.cmod_flags &= ~CMOD_LEGACY;
4898
Bram Moolenaar25e0f582020-05-25 22:36:50 +02004899 // Make sure error messages are OK.
4900 do_estack_push = !estack_top_is_ufunc(ufunc, 1);
4901 if (do_estack_push)
4902 estack_push_ufunc(ufunc, 1);
Bram Moolenaarf4e8cdd2020-10-12 22:07:13 +02004903 estack_compiling = TRUE;
Bram Moolenaar25e0f582020-05-25 22:36:50 +02004904
Yegappan Lakshmananf07c10d2024-12-23 10:15:08 +01004905 // Make sure arguments don't shadow variables in the context
Bram Moolenaar9a015112021-12-31 14:06:45 +00004906 if (check_args_shadowing(ufunc, &cctx) == FAIL)
4907 goto erret;
4908
Yegappan Lakshmananf6c1fb22024-04-25 21:30:56 +02004909 // For an object method and a constructor generate instructions to
4910 // initialize "this" and the object variables.
Bram Moolenaar574950d2023-01-03 19:08:50 +00004911 if (ufunc->uf_flags & (FC_OBJECT|FC_NEW))
Yegappan Lakshmananf6c1fb22024-04-25 21:30:56 +02004912 if (obj_method_prologue(ufunc, &cctx) == FAIL)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004913 goto erret;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004914
Bram Moolenaar170fcfc2020-02-06 17:51:35 +01004915 if (ufunc->uf_def_args.ga_len > 0)
Yegappan Lakshmananf07c10d2024-12-23 10:15:08 +01004916 if (compile_def_function_default_args(ufunc, instr, &cctx) == FAIL)
Yegappan Lakshmananf6c1fb22024-04-25 21:30:56 +02004917 goto erret;
Bram Moolenaare28d9b32021-07-03 18:56:53 +02004918 ufunc->uf_args_visible = ufunc->uf_args.ga_len;
Bram Moolenaar170fcfc2020-02-06 17:51:35 +01004919
Bram Moolenaarb8bebd02023-01-30 20:24:23 +00004920 // Compiling a function in an interface is done to get the function type.
Christian Brabandtded16772024-08-14 22:52:03 +02004921 // No code is actually compiled.
4922 if (ufunc->uf_class != NULL && IS_INTERFACE(ufunc->uf_class))
Bram Moolenaarb8bebd02023-01-30 20:24:23 +00004923 {
4924 ufunc->uf_def_status = UF_NOT_COMPILED;
4925 ret = OK;
4926 goto erret;
4927 }
4928
Yegappan Lakshmananf6c1fb22024-04-25 21:30:56 +02004929 // compile the function body
Yegappan Lakshmananf07c10d2024-12-23 10:15:08 +01004930 if (compile_def_function_body(ufunc->uf_lines.ga_len, check_return_type,
4931 &lines_to_free, &errormsg, &cctx) == FAIL)
Yegappan Lakshmanana16f2512024-04-23 20:14:46 +02004932 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004933
Yegappan Lakshmananf07c10d2024-12-23 10:15:08 +01004934 if (compile_dfunc_scope_end_missing(&cctx))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004935 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004936
Yegappan Lakshmananf07c10d2024-12-23 10:15:08 +01004937 if (compile_dfunc_generate_default_return(ufunc, &cctx) == FAIL)
4938 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004939
Bram Moolenaar599410c2021-04-10 14:03:43 +02004940 // When compiled with ":silent!" and there was an error don't consider the
4941 // function compiled.
4942 if (emsg_silent == 0 || did_emsg_silent == did_emsg_silent_before)
Yegappan Lakshmananf07c10d2024-12-23 10:15:08 +01004943 compile_dfunc_epilogue(outer_cctx, ufunc, instr, &cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004944
4945 ret = OK;
4946
4947erret:
Bram Moolenaar599410c2021-04-10 14:03:43 +02004948 if (ufunc->uf_def_status == UF_COMPILING)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004949 {
Yegappan Lakshmananf07c10d2024-12-23 10:15:08 +01004950 // compilation failed. do cleanup.
4951 compile_dfunc_ufunc_cleanup(ufunc, instr, new_def_function,
4952 errormsg, did_emsg_before, &cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004953 }
4954
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004955 if (cctx.ctx_redir_lhs.lhs_name != NULL)
4956 {
4957 if (ret == OK)
4958 {
4959 emsg(_(e_missing_redir_end));
4960 ret = FAIL;
4961 }
4962 vim_free(cctx.ctx_redir_lhs.lhs_name);
Bram Moolenaar753bcf82021-04-21 14:24:24 +02004963 vim_free(cctx.ctx_redir_lhs.lhs_whole);
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004964 }
4965
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004966 current_sctx = save_current_sctx;
Bram Moolenaarf4e8cdd2020-10-12 22:07:13 +02004967 estack_compiling = save_estack_compiling;
Bram Moolenaardc4c2302021-04-25 13:54:42 +02004968 cmdmod.cmod_flags = save_cmod_flags;
Bram Moolenaar25e0f582020-05-25 22:36:50 +02004969 if (do_estack_push)
4970 estack_pop();
4971
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004972 ga_clear_strings(&lines_to_free);
Bram Moolenaarb84a3812020-05-01 15:44:29 +02004973 free_locals(&cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004974 ga_clear(&cctx.ctx_type_stack);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004975 return ret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004976}
4977
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004978 void
4979set_function_type(ufunc_T *ufunc)
4980{
4981 int varargs = ufunc->uf_va_name != NULL;
4982 int argcount = ufunc->uf_args.ga_len;
4983
4984 // Create a type for the function, with the return type and any
4985 // argument types.
4986 // A vararg is included in uf_args.ga_len but not in uf_arg_types.
4987 // The type is included in "tt_args".
4988 if (argcount > 0 || varargs)
4989 {
Bram Moolenaar18062fc2021-03-05 21:35:47 +01004990 if (ufunc->uf_type_list.ga_itemsize == 0)
4991 ga_init2(&ufunc->uf_type_list, sizeof(type_T *), 10);
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004992 ufunc->uf_func_type = alloc_func_type(ufunc->uf_ret_type,
4993 argcount, &ufunc->uf_type_list);
4994 // Add argument types to the function type.
4995 if (func_type_add_arg_types(ufunc->uf_func_type,
4996 argcount + varargs,
4997 &ufunc->uf_type_list) == FAIL)
4998 return;
4999 ufunc->uf_func_type->tt_argcount = argcount + varargs;
5000 ufunc->uf_func_type->tt_min_argcount =
5001 argcount - ufunc->uf_def_args.ga_len;
5002 if (ufunc->uf_arg_types == NULL)
5003 {
5004 int i;
5005
5006 // lambda does not have argument types.
5007 for (i = 0; i < argcount; ++i)
5008 ufunc->uf_func_type->tt_args[i] = &t_any;
5009 }
5010 else
5011 mch_memmove(ufunc->uf_func_type->tt_args,
5012 ufunc->uf_arg_types, sizeof(type_T *) * argcount);
5013 if (varargs)
5014 {
5015 ufunc->uf_func_type->tt_args[argcount] =
Bram Moolenaar2a389082021-04-09 20:24:31 +02005016 ufunc->uf_va_type == NULL ? &t_list_any : ufunc->uf_va_type;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02005017 ufunc->uf_func_type->tt_flags = TTFLAG_VARARGS;
5018 }
5019 }
5020 else
5021 // No arguments, can use a predefined type.
5022 ufunc->uf_func_type = get_func_type(ufunc->uf_ret_type,
5023 argcount, &ufunc->uf_type_list);
5024}
5025
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005026/*
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01005027 * Free all instructions for "dfunc" except df_name.
Bram Moolenaar20431c92020-03-20 18:39:46 +01005028 */
5029 static void
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01005030delete_def_function_contents(dfunc_T *dfunc, int mark_deleted)
Bram Moolenaar20431c92020-03-20 18:39:46 +01005031{
5032 int idx;
5033
Bram Moolenaard505d172022-12-18 21:42:55 +00005034 // In same cases the instructions may refer to a class in which the
5035 // function is defined and unreferencing the class may call back here
5036 // recursively. Set the df_delete_busy to avoid problems.
5037 if (dfunc->df_delete_busy)
5038 return;
5039 dfunc->df_delete_busy = TRUE;
5040
Bram Moolenaar20431c92020-03-20 18:39:46 +01005041 ga_clear(&dfunc->df_def_args_isn);
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02005042 ga_clear_strings(&dfunc->df_var_names);
Bram Moolenaar20431c92020-03-20 18:39:46 +01005043
5044 if (dfunc->df_instr != NULL)
5045 {
5046 for (idx = 0; idx < dfunc->df_instr_count; ++idx)
5047 delete_instr(dfunc->df_instr + idx);
5048 VIM_CLEAR(dfunc->df_instr);
5049 }
Bram Moolenaarc2dec4c2021-06-13 15:39:00 +02005050 if (dfunc->df_instr_debug != NULL)
5051 {
5052 for (idx = 0; idx < dfunc->df_instr_debug_count; ++idx)
5053 delete_instr(dfunc->df_instr_debug + idx);
5054 VIM_CLEAR(dfunc->df_instr_debug);
Bram Moolenaarc2dec4c2021-06-13 15:39:00 +02005055 }
Bram Moolenaarc05fe072021-01-24 21:30:48 +01005056#ifdef FEAT_PROFILE
5057 if (dfunc->df_instr_prof != NULL)
5058 {
5059 for (idx = 0; idx < dfunc->df_instr_prof_count; ++idx)
5060 delete_instr(dfunc->df_instr_prof + idx);
5061 VIM_CLEAR(dfunc->df_instr_prof);
Bram Moolenaarc05fe072021-01-24 21:30:48 +01005062 }
5063#endif
Bram Moolenaar20431c92020-03-20 18:39:46 +01005064
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01005065 if (mark_deleted)
5066 dfunc->df_deleted = TRUE;
5067 if (dfunc->df_ufunc != NULL)
5068 dfunc->df_ufunc->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaard505d172022-12-18 21:42:55 +00005069
5070 dfunc->df_delete_busy = FALSE;
Bram Moolenaar20431c92020-03-20 18:39:46 +01005071}
5072
5073/*
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02005074 * When a user function is deleted, clear the contents of any associated def
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01005075 * function, unless another user function still uses it.
5076 * The position in def_functions can be re-used.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005077 */
5078 void
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01005079unlink_def_function(ufunc_T *ufunc)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005080{
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00005081 if (ufunc->uf_dfunc_idx <= 0)
5082 return;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005083
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00005084 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
5085 + ufunc->uf_dfunc_idx;
5086
5087 if (--dfunc->df_refcount <= 0)
5088 delete_def_function_contents(dfunc, TRUE);
5089 ufunc->uf_def_status = UF_NOT_COMPILED;
5090 ufunc->uf_dfunc_idx = 0;
5091 if (dfunc->df_ufunc == ufunc)
5092 dfunc->df_ufunc = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005093}
5094
Bram Moolenaarfdeab652020-09-19 15:16:50 +02005095/*
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01005096 * Used when a user function refers to an existing dfunc.
Bram Moolenaarfdeab652020-09-19 15:16:50 +02005097 */
5098 void
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01005099link_def_function(ufunc_T *ufunc)
Bram Moolenaarfdeab652020-09-19 15:16:50 +02005100{
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00005101 if (ufunc->uf_dfunc_idx <= 0)
5102 return;
Bram Moolenaarfdeab652020-09-19 15:16:50 +02005103
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00005104 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
5105 + ufunc->uf_dfunc_idx;
5106
5107 ++dfunc->df_refcount;
Bram Moolenaarfdeab652020-09-19 15:16:50 +02005108}
5109
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005110#if defined(EXITFREE) || defined(PROTO)
Bram Moolenaar20431c92020-03-20 18:39:46 +01005111/*
5112 * Free all functions defined with ":def".
5113 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005114 void
5115free_def_functions(void)
5116{
Bram Moolenaar20431c92020-03-20 18:39:46 +01005117 int idx;
5118
5119 for (idx = 0; idx < def_functions.ga_len; ++idx)
5120 {
5121 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data) + idx;
5122
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01005123 delete_def_function_contents(dfunc, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01005124 vim_free(dfunc->df_name);
Bram Moolenaar20431c92020-03-20 18:39:46 +01005125 }
5126
5127 ga_clear(&def_functions);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005128}
5129#endif
5130
5131
5132#endif // FEAT_EVAL