blob: b8129895db5a4884b234d1d4ae6a0af3738876d5 [file] [log] [blame]
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001/* vi:set ts=8 sts=4 sw=4 noet:
2 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
Bram Moolenaardc7c3662021-12-20 15:04:29 +000011 * vim9compile.c: compiling a :def function
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010012 */
13
14#define USING_FLOAT_STUFF
15#include "vim.h"
16
17#if defined(FEAT_EVAL) || defined(PROTO)
18
Bram Moolenaardc7c3662021-12-20 15:04:29 +000019// When not generating protos this is included in proto.h
20#ifdef PROTO
21# include "vim9.h"
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010022#endif
23
Bram Moolenaardc7c3662021-12-20 15:04:29 +000024// Functions defined with :def are stored in this growarray.
25// They are never removed, so that they can be found by index.
26// Deleted functions have the df_deleted flag set.
27garray_T def_functions = {0, 0, sizeof(dfunc_T), 50, NULL};
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010028
Bram Moolenaarcdc40c42020-12-26 17:43:08 +010029static void delete_def_function_contents(dfunc_T *dfunc, int mark_deleted);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010030
31/*
Bram Moolenaar709664c2020-12-12 14:33:41 +010032 * Lookup variable "name" in the local scope and return it in "lvar".
Bram Moolenaarab360522021-01-10 14:02:28 +010033 * "lvar->lv_from_outer" is incremented accordingly.
Bram Moolenaar709664c2020-12-12 14:33:41 +010034 * If "lvar" is NULL only check if the variable can be found.
35 * Return FAIL if not found.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010036 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +000037 int
Bram Moolenaar709664c2020-12-12 14:33:41 +010038lookup_local(char_u *name, size_t len, lvar_T *lvar, cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010039{
40 int idx;
Bram Moolenaar709664c2020-12-12 14:33:41 +010041 lvar_T *lvp;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010042
Bram Moolenaarae8d2de2020-02-13 21:42:24 +010043 if (len == 0)
Bram Moolenaar709664c2020-12-12 14:33:41 +010044 return FAIL;
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +020045
Bram Moolenaar58b40092023-01-11 15:59:05 +000046 if (((len == 4 && STRNCMP(name, "this", 4) == 0)
47 || (len == 5 && STRNCMP(name, "super", 5) == 0))
Bram Moolenaar00b28d62022-12-08 15:32:33 +000048 && cctx->ctx_ufunc != NULL
Bram Moolenaar574950d2023-01-03 19:08:50 +000049 && (cctx->ctx_ufunc->uf_flags & (FC_OBJECT|FC_NEW)))
Bram Moolenaar00b28d62022-12-08 15:32:33 +000050 {
Bram Moolenaar58b40092023-01-11 15:59:05 +000051 int is_super = *name == 's';
Bram Moolenaar6aa09372023-01-11 17:59:38 +000052 if (is_super)
53 {
54 if (name[5] != '.')
55 {
56 emsg(_(e_super_must_be_followed_by_dot));
57 return FAIL;
58 }
59 if (cctx->ctx_ufunc->uf_class != NULL
60 && cctx->ctx_ufunc->uf_class->class_extends == NULL)
61 {
62 emsg(_(e_using_super_not_in_child_class));
63 return FAIL;
64 }
65 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +000066 if (lvar != NULL)
67 {
68 CLEAR_POINTER(lvar);
Bram Moolenaar486fc252023-01-18 14:51:07 +000069 lvar->lv_loop_depth = -1;
Bram Moolenaar58b40092023-01-11 15:59:05 +000070 lvar->lv_name = (char_u *)(is_super ? "super" : "this");
Bram Moolenaar00b28d62022-12-08 15:32:33 +000071 if (cctx->ctx_ufunc->uf_class != NULL)
Bram Moolenaar58b40092023-01-11 15:59:05 +000072 {
Bram Moolenaarffdaca92022-12-09 21:41:48 +000073 lvar->lv_type = &cctx->ctx_ufunc->uf_class->class_object_type;
Bram Moolenaar58b40092023-01-11 15:59:05 +000074 if (is_super)
75 {
76 type_T *type = get_type_ptr(cctx->ctx_type_list);
77
78 if (type != NULL)
79 {
80 *type = *lvar->lv_type;
81 lvar->lv_type = type;
82 type->tt_flags |= TTFLAG_SUPER;
83 }
84 }
85 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +000086 }
87 return OK;
88 }
89
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +020090 // Find local in current function scope.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010091 for (idx = 0; idx < cctx->ctx_locals.ga_len; ++idx)
92 {
Bram Moolenaar709664c2020-12-12 14:33:41 +010093 lvp = ((lvar_T *)cctx->ctx_locals.ga_data) + idx;
Bram Moolenaara275f2c2022-10-11 20:04:09 +010094 if (lvp->lv_name != NULL
95 && STRNCMP(name, lvp->lv_name, len) == 0
Bram Moolenaar709664c2020-12-12 14:33:41 +010096 && STRLEN(lvp->lv_name) == len)
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +020097 {
Bram Moolenaar709664c2020-12-12 14:33:41 +010098 if (lvar != NULL)
99 {
100 *lvar = *lvp;
Bram Moolenaarab360522021-01-10 14:02:28 +0100101 lvar->lv_from_outer = 0;
Bram Moolenaar65449bd2022-09-19 16:02:43 +0100102 // If the variable was declared inside a loop set
103 // lvar->lv_loop_idx and lvar->lv_loop_depth.
104 get_loop_var_idx(cctx, idx, lvar);
Bram Moolenaar709664c2020-12-12 14:33:41 +0100105 }
106 return OK;
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +0200107 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100108 }
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +0200109
110 // Find local in outer function scope.
111 if (cctx->ctx_outer != NULL)
112 {
Bram Moolenaar709664c2020-12-12 14:33:41 +0100113 if (lookup_local(name, len, lvar, cctx->ctx_outer) == OK)
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +0200114 {
Bram Moolenaar709664c2020-12-12 14:33:41 +0100115 if (lvar != NULL)
116 {
117 cctx->ctx_outer_used = TRUE;
Bram Moolenaarab360522021-01-10 14:02:28 +0100118 ++lvar->lv_from_outer;
Bram Moolenaar709664c2020-12-12 14:33:41 +0100119 }
120 return OK;
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +0200121 }
122 }
123
Bram Moolenaar709664c2020-12-12 14:33:41 +0100124 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100125}
126
127/*
Bram Moolenaar2fd4cd72020-05-03 22:30:49 +0200128 * Lookup an argument in the current function and an enclosing function.
129 * Returns the argument index in "idxp"
130 * Returns the argument type in "type"
131 * Sets "gen_load_outer" to TRUE if found in outer scope.
132 * Returns OK when found, FAIL otherwise.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100133 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +0000134 int
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200135arg_exists(
Bram Moolenaar2fd4cd72020-05-03 22:30:49 +0200136 char_u *name,
137 size_t len,
138 int *idxp,
139 type_T **type,
140 int *gen_load_outer,
141 cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100142{
143 int idx;
Bram Moolenaar2fd4cd72020-05-03 22:30:49 +0200144 char_u *va_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100145
Bram Moolenaarae8d2de2020-02-13 21:42:24 +0100146 if (len == 0)
Bram Moolenaar2fd4cd72020-05-03 22:30:49 +0200147 return FAIL;
Bram Moolenaare28d9b32021-07-03 18:56:53 +0200148 for (idx = 0; idx < cctx->ctx_ufunc->uf_args_visible; ++idx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100149 {
150 char_u *arg = FUNCARG(cctx->ctx_ufunc, idx);
151
Bram Moolenaar2fd4cd72020-05-03 22:30:49 +0200152 if (STRNCMP(name, arg, len) == 0 && arg[len] == NUL)
153 {
154 if (idxp != NULL)
155 {
156 // Arguments are located above the frame pointer. One further
157 // if there is a vararg argument
158 *idxp = idx - (cctx->ctx_ufunc->uf_args.ga_len
159 + STACK_FRAME_SIZE)
160 + (cctx->ctx_ufunc->uf_va_name != NULL ? -1 : 0);
161
162 if (cctx->ctx_ufunc->uf_arg_types != NULL)
163 *type = cctx->ctx_ufunc->uf_arg_types[idx];
164 else
165 *type = &t_any;
166 }
167 return OK;
168 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100169 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100170
Bram Moolenaar2fd4cd72020-05-03 22:30:49 +0200171 va_name = cctx->ctx_ufunc->uf_va_name;
172 if (va_name != NULL
173 && STRNCMP(name, va_name, len) == 0 && va_name[len] == NUL)
174 {
175 if (idxp != NULL)
176 {
177 // varargs is always the last argument
178 *idxp = -STACK_FRAME_SIZE - 1;
179 *type = cctx->ctx_ufunc->uf_va_type;
180 }
181 return OK;
182 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100183
Bram Moolenaar2fd4cd72020-05-03 22:30:49 +0200184 if (cctx->ctx_outer != NULL)
185 {
186 // Lookup the name for an argument of the outer function.
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200187 if (arg_exists(name, len, idxp, type, gen_load_outer, cctx->ctx_outer)
Bram Moolenaar2fd4cd72020-05-03 22:30:49 +0200188 == OK)
189 {
Bram Moolenaar44ec21c2021-02-12 21:50:57 +0100190 if (gen_load_outer != NULL)
191 ++*gen_load_outer;
Bram Moolenaar2fd4cd72020-05-03 22:30:49 +0200192 return OK;
193 }
194 }
195
196 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100197}
198
199/*
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200200 * Lookup a script-local variable in the current script, possibly defined in a
201 * block that contains the function "cctx->ctx_ufunc".
Bram Moolenaar7a3b8022022-02-14 19:53:03 +0000202 * "cctx" is NULL at the script level, "cstack" is NULL in a function.
Bram Moolenaar18062fc2021-03-05 21:35:47 +0100203 * If "len" is <= 0 "name" must be NUL terminated.
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200204 * Return NULL when not found.
205 */
206 static sallvar_T *
Bram Moolenaardce24412022-02-08 20:35:30 +0000207find_script_var(char_u *name, size_t len, cctx_T *cctx, cstack_T *cstack)
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200208{
209 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
210 hashitem_T *hi;
211 int cc;
212 sallvar_T *sav;
213 ufunc_T *ufunc;
214
215 // Find the list of all script variables with the right name.
216 if (len > 0)
217 {
218 cc = name[len];
219 name[len] = NUL;
220 }
221 hi = hash_find(&si->sn_all_vars.dv_hashtab, name);
222 if (len > 0)
223 name[len] = cc;
224 if (HASHITEM_EMPTY(hi))
225 return NULL;
226
227 sav = HI2SAV(hi);
Bram Moolenaar3c77b6a2021-07-25 18:07:00 +0200228 if (sav->sav_block_id == 0)
229 // variable defined in the top script scope is always visible
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200230 return sav;
231
Bram Moolenaar3c77b6a2021-07-25 18:07:00 +0200232 if (cctx == NULL)
233 {
Bram Moolenaar766ae5b2022-09-14 00:30:51 +0100234 if (cstack == NULL)
235 return NULL;
236
Bram Moolenaardce24412022-02-08 20:35:30 +0000237 // Not in a function scope, find variable with block ID equal to or
Bram Moolenaar7a3b8022022-02-14 19:53:03 +0000238 // smaller than the current block id. Use "cstack" to go up the block
239 // scopes.
Bram Moolenaar3c77b6a2021-07-25 18:07:00 +0200240 while (sav != NULL)
241 {
Bram Moolenaar7a3b8022022-02-14 19:53:03 +0000242 int idx;
Bram Moolenaardce24412022-02-08 20:35:30 +0000243
Bram Moolenaar7a3b8022022-02-14 19:53:03 +0000244 for (idx = cstack->cs_idx; idx >= 0; --idx)
245 if (cstack->cs_block_id[idx] == sav->sav_block_id)
Bram Moolenaardce24412022-02-08 20:35:30 +0000246 break;
Bram Moolenaar7a3b8022022-02-14 19:53:03 +0000247 if (idx >= 0)
Bram Moolenaar3c77b6a2021-07-25 18:07:00 +0200248 break;
249 sav = sav->sav_next;
250 }
251 return sav;
252 }
253
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200254 // Go over the variables with this name and find one that was visible
255 // from the function.
256 ufunc = cctx->ctx_ufunc;
257 while (sav != NULL)
258 {
259 int idx;
260
261 // Go over the blocks that this function was defined in. If the
262 // variable block ID matches it was visible to the function.
263 for (idx = 0; idx < ufunc->uf_block_depth; ++idx)
264 if (ufunc->uf_block_ids[idx] == sav->sav_block_id)
265 return sav;
266 sav = sav->sav_next;
267 }
268
Bram Moolenaar58493cf2022-01-06 12:23:30 +0000269 // Not found, variable was not visible.
270 return NULL;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200271}
272
273/*
Bram Moolenaar766ae5b2022-09-14 00:30:51 +0100274 * If "name" can be found in the current script set it's "block_id".
275 */
276 void
277update_script_var_block_id(char_u *name, int block_id)
278{
279 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
280 hashitem_T *hi;
281 sallvar_T *sav;
282
283 hi = hash_find(&si->sn_all_vars.dv_hashtab, name);
284 if (HASHITEM_EMPTY(hi))
285 return;
286 sav = HI2SAV(hi);
287 sav->sav_block_id = block_id;
288}
289
290/*
Bram Moolenaar8e7d6222020-12-18 19:49:56 +0100291 * Return TRUE if the script context is Vim9 script.
Bram Moolenaar84367732020-08-23 15:21:55 +0200292 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +0000293 int
Yegappan Lakshmanana23a11b2023-02-21 14:27:41 +0000294script_is_vim9(void)
Bram Moolenaar84367732020-08-23 15:21:55 +0200295{
296 return SCRIPT_ITEM(current_sctx.sc_sid)->sn_version == SCRIPT_VERSION_VIM9;
297}
298
299/*
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200300 * Lookup a variable (without s: prefix) in the current script.
Bram Moolenaar7a3b8022022-02-14 19:53:03 +0000301 * "cctx" is NULL at the script level, "cstack" is NULL in a function.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100302 * Returns OK or FAIL.
303 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +0000304 int
Bram Moolenaardce24412022-02-08 20:35:30 +0000305script_var_exists(char_u *name, size_t len, cctx_T *cctx, cstack_T *cstack)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100306{
Bram Moolenaar9c4f5522020-09-25 21:47:28 +0200307 if (current_sctx.sc_sid <= 0)
308 return FAIL;
Bram Moolenaar15e5e532021-04-07 21:21:13 +0200309 if (script_is_vim9())
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200310 {
311 // Check script variables that were visible where the function was
312 // defined.
Bram Moolenaardce24412022-02-08 20:35:30 +0000313 if (find_script_var(name, len, cctx, cstack) != NULL)
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200314 return OK;
315 }
316 else
317 {
318 hashtab_T *ht = &SCRIPT_VARS(current_sctx.sc_sid);
319 dictitem_T *di;
320 int cc;
321
322 // Check script variables that are currently visible
323 cc = name[len];
324 name[len] = NUL;
325 di = find_var_in_ht(ht, 0, name, TRUE);
326 name[len] = cc;
327 if (di != NULL)
328 return OK;
329 }
330
331 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100332}
333
Bram Moolenaar5269bd22020-03-09 19:25:27 +0100334/*
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +0200335 * Returns the index of a class method or class variable with name "name"
336 * accessible in the currently compiled function.
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +0200337 * If "cl_ret" is not NULL set it to the class.
338 * Otherwise return -1.
339 */
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +0200340 static int
341cctx_class_midx(
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +0200342 cctx_T *cctx,
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +0200343 int is_method,
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +0200344 char_u *name,
345 size_t len,
346 class_T **cl_ret)
347{
348 if (cctx == NULL || cctx->ctx_ufunc == NULL
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +0200349 || cctx->ctx_ufunc->uf_class == NULL
350 || cctx->ctx_ufunc->uf_defclass == NULL)
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +0200351 return -1;
352
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +0200353 // Search for the class method or variable in the class where the calling
354 // function is defined.
355 class_T *cl = cctx->ctx_ufunc->uf_defclass;
356 int m_idx = is_method ? class_method_idx(cl, name, len)
357 : class_member_idx(cl, name, len);
358 if (m_idx < 0)
359 {
360 cl = cl->class_extends;
361 while (cl != NULL)
362 {
363 m_idx = is_method ? class_method_idx(cl, name, len)
364 : class_member_idx(cl, name, len);
365 if (m_idx >= 0)
366 break;
367 cl = cl->class_extends;
368 }
369 }
370
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +0200371 if (m_idx >= 0)
372 {
373 if (cl_ret != NULL)
374 *cl_ret = cl;
375 }
376
377 return m_idx;
378}
379
380/*
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +0200381 * Returns the index of a class method with name "name" accessible in the
382 * currently compiled function. Returns -1 if not found. The class where the
383 * method is defined is returned in "cl_ret".
384 */
385 int
386cctx_class_method_idx(
387 cctx_T *cctx,
388 char_u *name,
389 size_t len,
390 class_T **cl_ret)
391{
392 return cctx_class_midx(cctx, TRUE, name, len, cl_ret);
393}
394
395/*
396 * Returns the index of a class variable with name "name" accessible in the
397 * currently compiled function. Returns -1 if not found. The class where the
398 * variable is defined is returned in "cl_ret".
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +0200399 */
400 int
401cctx_class_member_idx(
402 cctx_T *cctx,
403 char_u *name,
404 size_t len,
405 class_T **cl_ret)
406{
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +0200407 return cctx_class_midx(cctx, FALSE, name, len, cl_ret);
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +0200408}
409
410/*
Bram Moolenaare0890d62021-02-17 14:52:14 +0100411 * Return TRUE if "name" is a local variable, argument, script variable or
Bram Moolenaarb1e32ac2023-02-21 12:38:51 +0000412 * imported. Also if "name" is "this" and in a class method.
Bram Moolenaare0890d62021-02-17 14:52:14 +0100413 */
414 static int
415variable_exists(char_u *name, size_t len, cctx_T *cctx)
416{
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100417 return (cctx != NULL
418 && (lookup_local(name, len, NULL, cctx) == OK
Bram Moolenaar00b28d62022-12-08 15:32:33 +0000419 || arg_exists(name, len, NULL, NULL, NULL, cctx) == OK
420 || (len == 4
421 && cctx->ctx_ufunc != NULL
Bram Moolenaar574950d2023-01-03 19:08:50 +0000422 && (cctx->ctx_ufunc->uf_flags & (FC_OBJECT|FC_NEW))
Bram Moolenaar00b28d62022-12-08 15:32:33 +0000423 && STRNCMP(name, "this", 4) == 0)))
Bram Moolenaardce24412022-02-08 20:35:30 +0000424 || script_var_exists(name, len, cctx, NULL) == OK
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +0200425 || cctx_class_member_idx(cctx, name, len, NULL) >= 0
Bram Moolenaar4b1d9632022-02-13 21:51:08 +0000426 || find_imported(name, len, FALSE) != NULL;
Bram Moolenaare0890d62021-02-17 14:52:14 +0100427}
428
429/*
Bram Moolenaar6914e872021-03-06 21:01:09 +0100430 * Return TRUE if "name" is a local variable, argument, script variable,
Bram Moolenaar97f8c102022-04-02 19:43:57 +0100431 * imported or function. Or commands are being skipped, a declaration may have
432 * been skipped then.
Bram Moolenaar6914e872021-03-06 21:01:09 +0100433 */
434 static int
Bram Moolenaar77b10ff2021-03-14 13:21:35 +0100435item_exists(char_u *name, size_t len, int cmd UNUSED, cctx_T *cctx)
Bram Moolenaar6914e872021-03-06 21:01:09 +0100436{
Bram Moolenaar0631bb42022-02-13 21:20:21 +0000437 return variable_exists(name, len, cctx);
Bram Moolenaar6914e872021-03-06 21:01:09 +0100438}
439
440/*
Bram Moolenaar5269bd22020-03-09 19:25:27 +0100441 * Check if "p[len]" is already defined, either in script "import_sid" or in
Bram Moolenaar7a3b8022022-02-14 19:53:03 +0000442 * compilation context "cctx".
443 * "cctx" is NULL at the script level, "cstack" is NULL in a function.
Bram Moolenaar0f769812020-09-12 18:32:34 +0200444 * Does not check the global namespace.
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100445 * If "is_arg" is TRUE the error message is for an argument name.
Bram Moolenaar5269bd22020-03-09 19:25:27 +0100446 * Return FAIL and give an error if it defined.
447 */
448 int
Bram Moolenaardce24412022-02-08 20:35:30 +0000449check_defined(
450 char_u *p,
451 size_t len,
452 cctx_T *cctx,
453 cstack_T *cstack,
454 int is_arg)
Bram Moolenaar5269bd22020-03-09 19:25:27 +0100455{
Bram Moolenaar0f769812020-09-12 18:32:34 +0200456 int c = p[len];
457 ufunc_T *ufunc = NULL;
Bram Moolenaarad486a02020-08-01 23:22:18 +0200458
Bram Moolenaarda479c72021-04-10 21:01:38 +0200459 // underscore argument is OK
460 if (len == 1 && *p == '_')
461 return OK;
462
Bram Moolenaardce24412022-02-08 20:35:30 +0000463 if (script_var_exists(p, len, cctx, cstack) == OK)
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100464 {
465 if (is_arg)
466 semsg(_(e_argument_already_declared_in_script_str), p);
467 else
468 semsg(_(e_variable_already_declared_in_script_str), p);
469 return FAIL;
470 }
471
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +0200472 if (cctx_class_member_idx(cctx, p, len, NULL) >= 0)
Bram Moolenaar6acf7572023-01-01 19:53:30 +0000473 {
474 if (is_arg)
475 semsg(_(e_argument_already_declared_in_class_str), p);
476 else
477 semsg(_(e_variable_already_declared_in_class_str), p);
478 return FAIL;
479 }
480
Bram Moolenaarad486a02020-08-01 23:22:18 +0200481 p[len] = NUL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100482 if ((cctx != NULL
Bram Moolenaar709664c2020-12-12 14:33:41 +0100483 && (lookup_local(p, len, NULL, cctx) == OK
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200484 || arg_exists(p, len, NULL, NULL, NULL, cctx) == OK))
Bram Moolenaar4b1d9632022-02-13 21:51:08 +0000485 || find_imported(p, len, FALSE) != NULL
Bram Moolenaaracc4b562022-01-24 13:54:45 +0000486 || (ufunc = find_func_even_dead(p, 0)) != NULL)
Bram Moolenaar5269bd22020-03-09 19:25:27 +0100487 {
Bram Moolenaar0f769812020-09-12 18:32:34 +0200488 // A local or script-local function can shadow a global function.
Bram Moolenaar577dc932021-06-27 15:35:40 +0200489 if (ufunc == NULL || ((ufunc->uf_flags & FC_DEAD) == 0
490 && (!func_is_global(ufunc)
491 || (p[0] == 'g' && p[1] == ':'))))
Bram Moolenaar0f769812020-09-12 18:32:34 +0200492 {
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100493 if (is_arg)
494 semsg(_(e_argument_name_shadows_existing_variable_str), p);
495 else
496 semsg(_(e_name_already_defined_str), p);
Bram Moolenaar0f769812020-09-12 18:32:34 +0200497 p[len] = c;
Bram Moolenaar0f769812020-09-12 18:32:34 +0200498 return FAIL;
499 }
Bram Moolenaar5269bd22020-03-09 19:25:27 +0100500 }
Bram Moolenaarad486a02020-08-01 23:22:18 +0200501 p[len] = c;
Bram Moolenaar5269bd22020-03-09 19:25:27 +0100502 return OK;
503}
504
Bram Moolenaar65b95452020-07-19 14:03:09 +0200505
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100506/*
Bram Moolenaar334a8b42020-10-19 16:07:42 +0200507 * Return TRUE if "actual" could be "expected" and a runtime typecheck is to be
508 * used. Return FALSE if the types will never match.
509 */
Yegappan Lakshmanan8ee52af2021-08-09 19:59:06 +0200510 static int
Bram Moolenaar334a8b42020-10-19 16:07:42 +0200511use_typecheck(type_T *actual, type_T *expected)
512{
513 if (actual->tt_type == VAR_ANY
514 || actual->tt_type == VAR_UNKNOWN
515 || (actual->tt_type == VAR_FUNC
516 && (expected->tt_type == VAR_FUNC
517 || expected->tt_type == VAR_PARTIAL)
Bram Moolenaarfa46ead2021-12-22 13:18:39 +0000518 && (actual->tt_member == &t_any
519 || actual->tt_member == &t_unknown
520 || actual->tt_argcount < 0)
521 && (actual->tt_member == &t_unknown ||
522 (actual->tt_member == &t_void)
Bram Moolenaar328eac22021-01-07 19:23:08 +0100523 == (expected->tt_member == &t_void))))
Bram Moolenaar334a8b42020-10-19 16:07:42 +0200524 return TRUE;
LemonBoy50d48542024-07-04 17:03:17 +0200525 if (actual->tt_type == VAR_OBJECT && expected->tt_type == VAR_OBJECT)
526 return TRUE;
Bram Moolenaar334a8b42020-10-19 16:07:42 +0200527 if ((actual->tt_type == VAR_LIST || actual->tt_type == VAR_DICT)
528 && actual->tt_type == expected->tt_type)
529 // This takes care of a nested list or dict.
530 return use_typecheck(actual->tt_member, expected->tt_member);
531 return FALSE;
532}
533
534/*
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +0200535 * Check that
Bram Moolenaar5e654232020-09-16 15:22:00 +0200536 * - "actual" matches "expected" type or
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +0200537 * - "actual" is a type that can be "expected" type: add a runtime check; or
538 * - return FAIL.
Bram Moolenaar334a8b42020-10-19 16:07:42 +0200539 * If "actual_is_const" is TRUE then the type won't change at runtime, do not
540 * generate a TYPECHECK.
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +0200541 */
Bram Moolenaara1c51952022-02-02 16:20:26 +0000542 int
Bram Moolenaar4270d8b2021-08-07 16:30:42 +0200543need_type_where(
544 type_T *actual,
545 type_T *expected,
Bram Moolenaarc6951a72022-12-29 20:56:24 +0000546 int number_ok, // expect VAR_FLOAT but VAR_NUMBER is OK
Bram Moolenaar4270d8b2021-08-07 16:30:42 +0200547 int offset,
548 where_T where,
549 cctx_T *cctx,
550 int silent,
551 int actual_is_const)
552{
Bram Moolenaar44a89772021-12-18 12:31:33 +0000553 int ret;
554
Ernie Raele75fde62023-12-21 17:18:54 +0100555 if (expected->tt_type != VAR_CLASS && expected->tt_type != VAR_TYPEALIAS)
556 {
557 if (check_type_is_value(actual) == FAIL)
558 return FAIL;
559 }
560
Bram Moolenaar4270d8b2021-08-07 16:30:42 +0200561 if (expected == &t_bool && actual != &t_bool
562 && (actual->tt_flags & TTFLAG_BOOL_OK))
563 {
564 // Using "0", "1" or the result of an expression with "&&" or "||" as a
565 // boolean is OK but requires a conversion.
566 generate_2BOOL(cctx, FALSE, offset);
567 return OK;
568 }
569
Bram Moolenaar44a89772021-12-18 12:31:33 +0000570 ret = check_type_maybe(expected, actual, FALSE, where);
571 if (ret == OK)
Bram Moolenaar4270d8b2021-08-07 16:30:42 +0200572 return OK;
573
Bram Moolenaar8acb9cc2022-03-08 13:18:55 +0000574 // If actual a constant a runtime check makes no sense. If it's
575 // null_function it is OK.
576 if (actual_is_const && ret == MAYBE && actual == &t_func_unknown)
577 return OK;
578
Bram Moolenaar4270d8b2021-08-07 16:30:42 +0200579 // If the actual type can be the expected type add a runtime check.
Bram Moolenaarfa46ead2021-12-22 13:18:39 +0000580 if (!actual_is_const && ret == MAYBE && use_typecheck(actual, expected))
Bram Moolenaar4270d8b2021-08-07 16:30:42 +0200581 {
Bram Moolenaarc6951a72022-12-29 20:56:24 +0000582 generate_TYPECHECK(cctx, expected, number_ok, offset,
LemonBoyc5d27442023-08-19 13:02:35 +0200583 where.wt_kind == WT_VARIABLE, where.wt_index);
Bram Moolenaar4270d8b2021-08-07 16:30:42 +0200584 return OK;
585 }
586
587 if (!silent)
588 type_mismatch_where(expected, actual, where);
589 return FAIL;
590}
591
Bram Moolenaar351ead02021-01-16 16:07:01 +0100592 int
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +0200593need_type(
594 type_T *actual,
595 type_T *expected,
Bram Moolenaarc6951a72022-12-29 20:56:24 +0000596 int number_ok, // when expected is float number is also OK
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +0200597 int offset,
Bram Moolenaar351ead02021-01-16 16:07:01 +0100598 int arg_idx,
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +0200599 cctx_T *cctx,
Bram Moolenaar334a8b42020-10-19 16:07:42 +0200600 int silent,
601 int actual_is_const)
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +0200602{
Bram Moolenaar7a3fe3e2021-07-22 14:58:47 +0200603 where_T where = WHERE_INIT;
Bram Moolenaarf785aa12021-02-11 21:19:34 +0100604
LemonBoyc5d27442023-08-19 13:02:35 +0200605 if (arg_idx > 0)
606 {
607 where.wt_index = arg_idx;
608 where.wt_kind = WT_ARGUMENT;
609 }
Bram Moolenaarc6951a72022-12-29 20:56:24 +0000610 return need_type_where(actual, expected, number_ok, offset, where,
Bram Moolenaar4270d8b2021-08-07 16:30:42 +0200611 cctx, silent, actual_is_const);
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +0200612}
613
614/*
Bram Moolenaarfa103972022-09-29 19:14:42 +0100615 * Set type of variable "lvar" to "type". If the variable is a constant then
616 * the type gets TTFLAG_CONST.
617 */
618 static void
619set_var_type(lvar_T *lvar, type_T *type_arg, cctx_T *cctx)
620{
621 type_T *type = type_arg;
622
Bram Moolenaar6586a012022-09-30 11:04:50 +0100623 if (lvar->lv_const == ASSIGN_CONST && (type->tt_flags & TTFLAG_CONST) == 0)
Bram Moolenaarfa103972022-09-29 19:14:42 +0100624 {
625 if (type->tt_flags & TTFLAG_STATIC)
626 // entry in static_types[] is followed by const type
627 type = type + 1;
628 else
629 {
630 type = copy_type(type, cctx->ctx_type_list);
631 type->tt_flags |= TTFLAG_CONST;
632 }
633 }
634 lvar->lv_type = type;
635}
636
637/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100638 * Reserve space for a local variable.
Bram Moolenaar6586a012022-09-30 11:04:50 +0100639 * "assign" can be ASSIGN_VAR for :var, ASSIGN_CONST for :const and
640 * ASSIGN_FINAL for :final.
Bram Moolenaarb84a3812020-05-01 15:44:29 +0200641 * Return the variable or NULL if it failed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100642 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +0000643 lvar_T *
Bram Moolenaare8211a32020-10-09 22:04:29 +0200644reserve_local(
645 cctx_T *cctx,
646 char_u *name,
647 size_t len,
Bram Moolenaar6586a012022-09-30 11:04:50 +0100648 int assign,
Bram Moolenaare8211a32020-10-09 22:04:29 +0200649 type_T *type)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100650{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100651 lvar_T *lvar;
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +0200652 dfunc_T *dfunc;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100653
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200654 if (arg_exists(name, len, NULL, NULL, NULL, cctx) == OK)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100655 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200656 emsg_namelen(_(e_str_is_used_as_argument), name, (int)len);
Bram Moolenaarb84a3812020-05-01 15:44:29 +0200657 return NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100658 }
659
Bram Moolenaar35578162021-08-02 19:10:38 +0200660 if (GA_GROW_FAILS(&cctx->ctx_locals, 1))
Bram Moolenaarb84a3812020-05-01 15:44:29 +0200661 return NULL;
662 lvar = ((lvar_T *)cctx->ctx_locals.ga_data) + cctx->ctx_locals.ga_len++;
Bram Moolenaare8211a32020-10-09 22:04:29 +0200663 CLEAR_POINTER(lvar);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100664
Bram Moolenaarb84a3812020-05-01 15:44:29 +0200665 // Every local variable uses the next entry on the stack. We could re-use
666 // the last ones when leaving a scope, but then variables used in a closure
667 // might get overwritten. To keep things simple do not re-use stack
668 // entries. This is less efficient, but memory is cheap these days.
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +0200669 dfunc = ((dfunc_T *)def_functions.ga_data) + cctx->ctx_ufunc->uf_dfunc_idx;
670 lvar->lv_idx = dfunc->df_var_names.ga_len;
Bram Moolenaarb84a3812020-05-01 15:44:29 +0200671
Bram Moolenaar71ccd032020-06-12 22:59:11 +0200672 lvar->lv_name = vim_strnsave(name, len == 0 ? STRLEN(name) : len);
Bram Moolenaar6586a012022-09-30 11:04:50 +0100673 lvar->lv_const = assign;
Bram Moolenaarfa103972022-09-29 19:14:42 +0100674 if (type == &t_unknown || type == &t_any)
675 // type not known yet, may be inferred from RHS
676 lvar->lv_type = type;
677 else
678 // may use TTFLAG_CONST
679 set_var_type(lvar, type, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100680
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +0200681 // Remember the name for debugging.
Bram Moolenaar35578162021-08-02 19:10:38 +0200682 if (GA_GROW_FAILS(&dfunc->df_var_names, 1))
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +0200683 return NULL;
684 ((char_u **)dfunc->df_var_names.ga_data)[lvar->lv_idx] =
685 vim_strsave(lvar->lv_name);
686 ++dfunc->df_var_names.ga_len;
687
Bram Moolenaarb84a3812020-05-01 15:44:29 +0200688 return lvar;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100689}
690
691/*
Bram Moolenaar08251752021-01-11 21:20:18 +0100692 * If "check_writable" is ASSIGN_CONST give an error if the variable was
693 * defined with :final or :const, if "check_writable" is ASSIGN_FINAL give an
694 * error if the variable was defined with :const.
695 */
696 static int
697check_item_writable(svar_T *sv, int check_writable, char_u *name)
698{
699 if ((check_writable == ASSIGN_CONST && sv->sv_const != 0)
700 || (check_writable == ASSIGN_FINAL
701 && sv->sv_const == ASSIGN_CONST))
702 {
Bram Moolenaard8e44472021-07-21 22:20:33 +0200703 semsg(_(e_cannot_change_readonly_variable_str), name);
Bram Moolenaar08251752021-01-11 21:20:18 +0100704 return FAIL;
705 }
706 return OK;
707}
708
709/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100710 * Find "name" in script-local items of script "sid".
Bram Moolenaar08251752021-01-11 21:20:18 +0100711 * Pass "check_writable" to check_item_writable().
Bram Moolenaar7a3b8022022-02-14 19:53:03 +0000712 * "cctx" is NULL at the script level, "cstack" is NULL in a function.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100713 * Returns the index in "sn_var_vals" if found.
714 * If found but not in "sn_var_vals" returns -1.
Bram Moolenaar08251752021-01-11 21:20:18 +0100715 * If not found or the variable is not writable returns -2.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100716 */
717 int
Bram Moolenaarb6a138e2022-02-08 21:17:22 +0000718get_script_item_idx(
719 int sid,
720 char_u *name,
721 int check_writable,
722 cctx_T *cctx,
723 cstack_T *cstack)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100724{
725 hashtab_T *ht;
726 dictitem_T *di;
Bram Moolenaar21b9e972020-01-26 19:26:46 +0100727 scriptitem_T *si = SCRIPT_ITEM(sid);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200728 svar_T *sv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100729 int idx;
730
Bram Moolenaare3d46852020-08-29 13:39:17 +0200731 if (!SCRIPT_ID_VALID(sid))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100732 return -1;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200733 if (sid == current_sctx.sc_sid)
734 {
Bram Moolenaarb6a138e2022-02-08 21:17:22 +0000735 sallvar_T *sav = find_script_var(name, 0, cctx, cstack);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200736
737 if (sav == NULL)
738 return -2;
739 idx = sav->sav_var_vals_idx;
740 sv = ((svar_T *)si->sn_var_vals.ga_data) + idx;
Bram Moolenaar08251752021-01-11 21:20:18 +0100741 if (check_item_writable(sv, check_writable, name) == FAIL)
742 return -2;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200743 return idx;
744 }
745
746 // First look the name up in the hashtable.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100747 ht = &SCRIPT_VARS(sid);
748 di = find_var_in_ht(ht, 0, name, TRUE);
749 if (di == NULL)
Bram Moolenaar577bd852022-01-10 18:42:52 +0000750 {
751 if (si->sn_autoload_prefix != NULL)
752 {
753 hashitem_T *hi;
754
755 // A variable exported from an autoload script is in the global
756 // variables, we can find it in the all_vars table.
757 hi = hash_find(&si->sn_all_vars.dv_hashtab, name);
758 if (!HASHITEM_EMPTY(hi))
759 return HI2SAV(hi)->sav_var_vals_idx;
760 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100761 return -2;
Bram Moolenaar577bd852022-01-10 18:42:52 +0000762 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100763
764 // Now find the svar_T index in sn_var_vals.
765 for (idx = 0; idx < si->sn_var_vals.ga_len; ++idx)
766 {
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200767 sv = ((svar_T *)si->sn_var_vals.ga_data) + idx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100768 if (sv->sv_tv == &di->di_tv)
769 {
Bram Moolenaar08251752021-01-11 21:20:18 +0100770 if (check_item_writable(sv, check_writable, name) == FAIL)
771 return -2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100772 return idx;
773 }
774 }
775 return -1;
776}
777
Yegappan Lakshmanan782b43d2022-01-08 18:43:40 +0000778 static imported_T *
779find_imported_in_script(char_u *name, size_t len, int sid)
780{
781 scriptitem_T *si;
782 int idx;
783
784 if (!SCRIPT_ID_VALID(sid))
785 return NULL;
786 si = SCRIPT_ITEM(sid);
787 for (idx = 0; idx < si->sn_imports.ga_len; ++idx)
788 {
789 imported_T *import = ((imported_T *)si->sn_imports.ga_data) + idx;
790
791 if (len == 0 ? STRCMP(name, import->imp_name) == 0
792 : STRLEN(import->imp_name) == len
793 && STRNCMP(name, import->imp_name, len) == 0)
794 return import;
795 }
796 return NULL;
797}
798
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100799/*
Bram Moolenaar4b1d9632022-02-13 21:51:08 +0000800 * Find "name" in imported items of the current script.
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +0100801 * If "len" is 0 use any length that works.
Bram Moolenaardc4451d2022-01-09 21:36:37 +0000802 * If "load" is TRUE and the script was not loaded yet, load it now.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100803 */
804 imported_T *
Bram Moolenaar4b1d9632022-02-13 21:51:08 +0000805find_imported(char_u *name, size_t len, int load)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100806{
Bram Moolenaare3d46852020-08-29 13:39:17 +0200807 if (!SCRIPT_ID_VALID(current_sctx.sc_sid))
Bram Moolenaar8e6cbb72020-07-01 14:38:12 +0200808 return NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100809
Bram Moolenaarb775e722022-11-22 18:12:44 +0000810 // Skip over "s:" before "s:something" to find the import name.
811 int off = name[0] == 's' && name[1] == ':' ? 2 : 0;
812
813 imported_T *ret = find_imported_in_script(name + off, len - off,
814 current_sctx.sc_sid);
Bram Moolenaarb697dc22022-01-22 11:27:29 +0000815 if (ret != NULL && load && (ret->imp_flags & IMP_FLAGS_AUTOLOAD))
Bram Moolenaardc4451d2022-01-09 21:36:37 +0000816 {
Bram Moolenaar753885b2022-08-24 16:30:36 +0100817 scid_T actual_sid = 0;
Bram Moolenaar6809ff92022-07-26 15:10:56 +0100818 int save_emsg_off = emsg_off;
819
820 // "emsg_off" will be set when evaluating an expression silently, but
821 // we do want to know about errors in a script. Also because it then
822 // aborts when an error is encountered.
823 emsg_off = FALSE;
Bram Moolenaar17d36cb2022-01-12 11:46:40 +0000824
Bram Moolenaardc4451d2022-01-09 21:36:37 +0000825 // script found before but not loaded yet
Bram Moolenaarb697dc22022-01-22 11:27:29 +0000826 ret->imp_flags &= ~IMP_FLAGS_AUTOLOAD;
Bram Moolenaardc4451d2022-01-09 21:36:37 +0000827 (void)do_source(SCRIPT_ITEM(ret->imp_sid)->sn_name, FALSE,
Bram Moolenaar753885b2022-08-24 16:30:36 +0100828 DOSO_NONE, &actual_sid);
829 // If the script is a symlink it may be sourced with another name, may
830 // need to adjust the script ID for that.
831 if (actual_sid != 0)
832 ret->imp_sid = actual_sid;
Bram Moolenaar6809ff92022-07-26 15:10:56 +0100833
834 emsg_off = save_emsg_off;
Bram Moolenaardc4451d2022-01-09 21:36:37 +0000835 }
836 return ret;
Bram Moolenaarefa94442020-08-08 22:16:00 +0200837}
838
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100839/*
Bram Moolenaardc7c3662021-12-20 15:04:29 +0000840 * Called when checking for a following operator at "arg". When the rest of
841 * the line is empty or only a comment, peek the next line. If there is a next
842 * line return a pointer to it and set "nextp".
843 * Otherwise skip over white space.
844 */
845 char_u *
846may_peek_next_line(cctx_T *cctx, char_u *arg, char_u **nextp)
847{
848 char_u *p = skipwhite(arg);
849
850 *nextp = NULL;
851 if (*p == NUL || (VIM_ISWHITE(*arg) && vim9_comment_start(p)))
852 {
853 *nextp = peek_next_line_from_context(cctx);
854 if (*nextp != NULL)
855 return *nextp;
856 }
857 return p;
858}
859
860/*
Bram Moolenaar23c55272020-06-21 16:58:13 +0200861 * Return a pointer to the next line that isn't empty or only contains a
862 * comment. Skips over white space.
863 * Returns NULL if there is none.
864 */
Bram Moolenaar7a4b8982020-07-08 17:36:21 +0200865 char_u *
866peek_next_line_from_context(cctx_T *cctx)
Bram Moolenaar23c55272020-06-21 16:58:13 +0200867{
868 int lnum = cctx->ctx_lnum;
869
870 while (++lnum < cctx->ctx_ufunc->uf_lines.ga_len)
871 {
872 char_u *line = ((char_u **)cctx->ctx_ufunc->uf_lines.ga_data)[lnum];
Bram Moolenaaracd4c5e2020-06-22 19:39:03 +0200873 char_u *p;
Bram Moolenaar23c55272020-06-21 16:58:13 +0200874
Bram Moolenaarba60cc42020-08-12 19:15:33 +0200875 // ignore NULLs inserted for continuation lines
876 if (line != NULL)
877 {
878 p = skipwhite(line);
Bram Moolenaar4b3e1962021-03-18 21:37:55 +0100879 if (vim9_bad_comment(p))
880 return NULL;
Bram Moolenaarba60cc42020-08-12 19:15:33 +0200881 if (*p != NUL && !vim9_comment_start(p))
882 return p;
883 }
Bram Moolenaar23c55272020-06-21 16:58:13 +0200884 }
885 return NULL;
886}
887
888/*
Bram Moolenaare6085c52020-04-12 20:19:16 +0200889 * Get the next line of the function from "cctx".
Bram Moolenaar23c55272020-06-21 16:58:13 +0200890 * Skips over empty lines. Skips over comment lines if "skip_comment" is TRUE.
Bram Moolenaare6085c52020-04-12 20:19:16 +0200891 * Returns NULL when at the end.
892 */
Bram Moolenaar7a4b8982020-07-08 17:36:21 +0200893 char_u *
Bram Moolenaar23c55272020-06-21 16:58:13 +0200894next_line_from_context(cctx_T *cctx, int skip_comment)
Bram Moolenaare6085c52020-04-12 20:19:16 +0200895{
Bram Moolenaar7a092242020-04-16 22:10:49 +0200896 char_u *line;
Bram Moolenaare6085c52020-04-12 20:19:16 +0200897
898 do
899 {
900 ++cctx->ctx_lnum;
901 if (cctx->ctx_lnum >= cctx->ctx_ufunc->uf_lines.ga_len)
Bram Moolenaar7a092242020-04-16 22:10:49 +0200902 {
903 line = NULL;
Bram Moolenaare6085c52020-04-12 20:19:16 +0200904 break;
Bram Moolenaar7a092242020-04-16 22:10:49 +0200905 }
Bram Moolenaare6085c52020-04-12 20:19:16 +0200906 line = ((char_u **)cctx->ctx_ufunc->uf_lines.ga_data)[cctx->ctx_lnum];
Bram Moolenaar7a092242020-04-16 22:10:49 +0200907 cctx->ctx_line_start = line;
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200908 SOURCING_LNUM = cctx->ctx_lnum + 1;
Bram Moolenaar23c55272020-06-21 16:58:13 +0200909 } while (line == NULL || *skipwhite(line) == NUL
Bram Moolenaar2dd0a2c2020-08-08 15:10:27 +0200910 || (skip_comment && vim9_comment_start(skipwhite(line))));
Bram Moolenaare6085c52020-04-12 20:19:16 +0200911 return line;
912}
913
914/*
Bram Moolenaar5afd0812021-01-03 18:33:13 +0100915 * Skip over white space at "whitep" and assign to "*arg".
Bram Moolenaar9c7e6dd2020-04-12 20:55:20 +0200916 * If "*arg" is at the end of the line, advance to the next line.
Bram Moolenaar2c330432020-04-13 14:41:35 +0200917 * Also when "whitep" points to white space and "*arg" is on a "#".
Bram Moolenaar9c7e6dd2020-04-12 20:55:20 +0200918 * Return FAIL if beyond the last line, "*arg" is unmodified then.
919 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +0000920 int
Bram Moolenaar2c330432020-04-13 14:41:35 +0200921may_get_next_line(char_u *whitep, char_u **arg, cctx_T *cctx)
Bram Moolenaar9c7e6dd2020-04-12 20:55:20 +0200922{
Bram Moolenaar5afd0812021-01-03 18:33:13 +0100923 *arg = skipwhite(whitep);
Bram Moolenaar4b3e1962021-03-18 21:37:55 +0100924 if (vim9_bad_comment(*arg))
925 return FAIL;
Bram Moolenaarf5be8cd2020-07-17 20:36:00 +0200926 if (**arg == NUL || (VIM_ISWHITE(*whitep) && vim9_comment_start(*arg)))
Bram Moolenaar9c7e6dd2020-04-12 20:55:20 +0200927 {
Bram Moolenaar23c55272020-06-21 16:58:13 +0200928 char_u *next = next_line_from_context(cctx, TRUE);
Bram Moolenaar9c7e6dd2020-04-12 20:55:20 +0200929
930 if (next == NULL)
931 return FAIL;
932 *arg = skipwhite(next);
933 }
934 return OK;
935}
936
Bram Moolenaara7eedf32020-07-10 21:50:41 +0200937/*
938 * Idem, and give an error when failed.
939 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +0000940 int
Bram Moolenaara7eedf32020-07-10 21:50:41 +0200941may_get_next_line_error(char_u *whitep, char_u **arg, cctx_T *cctx)
942{
943 if (may_get_next_line(whitep, arg, cctx) == FAIL)
944 {
Bram Moolenaar8ff16e02020-12-07 21:49:52 +0100945 SOURCING_LNUM = cctx->ctx_lnum + 1;
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200946 emsg(_(e_line_incomplete));
Bram Moolenaara7eedf32020-07-10 21:50:41 +0200947 return FAIL;
948 }
949 return OK;
950}
951
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100952/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200953 * Get a line from the compilation context, compatible with exarg_T getline().
954 * Return a pointer to the line in allocated memory.
955 * Return NULL for end-of-file or some error.
956 */
957 static char_u *
958exarg_getline(
959 int c UNUSED,
960 void *cookie,
961 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +0200962 getline_opt_T options UNUSED)
Bram Moolenaar04b12692020-05-04 23:24:44 +0200963{
964 cctx_T *cctx = (cctx_T *)cookie;
Bram Moolenaar66250c92020-08-20 15:02:42 +0200965 char_u *p;
Bram Moolenaar04b12692020-05-04 23:24:44 +0200966
Bram Moolenaar66250c92020-08-20 15:02:42 +0200967 for (;;)
Bram Moolenaar04b12692020-05-04 23:24:44 +0200968 {
Bram Moolenaar2914a202020-09-27 18:24:03 +0200969 if (cctx->ctx_lnum >= cctx->ctx_ufunc->uf_lines.ga_len - 1)
Bram Moolenaar66250c92020-08-20 15:02:42 +0200970 return NULL;
971 ++cctx->ctx_lnum;
972 p = ((char_u **)cctx->ctx_ufunc->uf_lines.ga_data)[cctx->ctx_lnum];
973 // Comment lines result in NULL pointers, skip them.
974 if (p != NULL)
975 return vim_strsave(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +0200976 }
Bram Moolenaar04b12692020-05-04 23:24:44 +0200977}
978
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100979 void
980fill_exarg_from_cctx(exarg_T *eap, cctx_T *cctx)
981{
Zoltan Arpadffy6fdb6282023-12-19 20:53:07 +0100982 eap->ea_getline = exarg_getline;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100983 eap->cookie = cctx;
Bram Moolenaar4f3321f2022-03-13 13:12:27 +0000984 eap->skip = cctx->ctx_skip == SKIP_YES;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100985}
986
Bram Moolenaar04b12692020-05-04 23:24:44 +0200987/*
Bram Moolenaardc7c3662021-12-20 15:04:29 +0000988 * Return TRUE if "ufunc" should be compiled, taking into account whether
989 * "profile" indicates profiling is to be done.
990 */
991 int
992func_needs_compiling(ufunc_T *ufunc, compiletype_T compile_type)
993{
994 switch (ufunc->uf_def_status)
995 {
996 case UF_TO_BE_COMPILED:
997 return TRUE;
998
999 case UF_COMPILED:
1000 {
1001 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
1002 + ufunc->uf_dfunc_idx;
1003
1004 switch (compile_type)
1005 {
1006 case CT_PROFILE:
1007#ifdef FEAT_PROFILE
1008 return dfunc->df_instr_prof == NULL;
1009#endif
1010 case CT_NONE:
1011 return dfunc->df_instr == NULL;
1012 case CT_DEBUG:
1013 return dfunc->df_instr_debug == NULL;
1014 }
1015 }
1016
1017 case UF_NOT_COMPILED:
1018 case UF_COMPILE_ERROR:
1019 case UF_COMPILING:
1020 break;
1021 }
1022 return FALSE;
1023}
1024
1025/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02001026 * Compile a nested :def command.
1027 */
1028 static char_u *
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00001029compile_nested_function(exarg_T *eap, cctx_T *cctx, garray_T *lines_to_free)
Bram Moolenaar04b12692020-05-04 23:24:44 +02001030{
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001031 int is_global = *eap->arg == 'g' && eap->arg[1] == ':';
Bram Moolenaar04b12692020-05-04 23:24:44 +02001032 char_u *name_start = eap->arg;
Bram Moolenaarbcbf4132020-08-01 22:35:13 +02001033 char_u *name_end = to_name_end(eap->arg, TRUE);
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001034 int off;
1035 char_u *func_name;
Bram Moolenaareef21022020-08-01 22:16:43 +02001036 char_u *lambda_name;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001037 ufunc_T *ufunc;
Bram Moolenaar58a52f22020-12-22 18:56:55 +01001038 int r = FAIL;
Bram Moolenaarffcfddc2021-07-11 20:22:30 +02001039 compiletype_T compile_type;
Yegappan Lakshmanana76fbe62023-09-27 18:51:43 +02001040 int funcref_isn_idx = -1;
Bram Moolenaar1889f492022-08-16 19:34:44 +01001041 lvar_T *lvar = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001042
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +02001043 if (eap->forceit)
Bram Moolenaar8b848ca2020-09-10 22:28:01 +02001044 {
1045 emsg(_(e_cannot_use_bang_with_nested_def));
1046 return NULL;
1047 }
1048
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01001049 if (*name_start == '/')
1050 {
1051 name_end = skip_regexp(name_start + 1, '/', TRUE);
1052 if (*name_end == '/')
1053 ++name_end;
Bram Moolenaar63b91732021-08-05 20:40:03 +02001054 set_nextcmd(eap, name_end);
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01001055 }
1056 if (name_end == name_start || *skipwhite(name_end) != '(')
1057 {
1058 if (!ends_excmd2(name_start, name_end))
1059 {
Bram Moolenaardea5ab02022-02-23 22:12:02 +00001060 if (*skipwhite(name_end) == '.')
1061 semsg(_(e_cannot_define_dict_func_in_vim9_script_str),
1062 eap->cmd);
1063 else
1064 semsg(_(e_invalid_command_str), eap->cmd);
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01001065 return NULL;
1066 }
1067
1068 // "def" or "def Name": list functions
1069 if (generate_DEF(cctx, name_start, name_end - name_start) == FAIL)
1070 return NULL;
1071 return eap->nextcmd == NULL ? (char_u *)"" : eap->nextcmd;
1072 }
1073
Bram Moolenaarbcbf4132020-08-01 22:35:13 +02001074 // Only g:Func() can use a namespace.
1075 if (name_start[1] == ':' && !is_global)
1076 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02001077 semsg(_(e_namespace_not_supported_str), name_start);
Bram Moolenaarbcbf4132020-08-01 22:35:13 +02001078 return NULL;
1079 }
Bram Moolenaar4f3321f2022-03-13 13:12:27 +00001080 if (cctx->ctx_skip != SKIP_YES
1081 && check_defined(name_start, name_end - name_start, cctx,
Bram Moolenaardce24412022-02-08 20:35:30 +00001082 NULL, FALSE) == FAIL)
Bram Moolenaareef21022020-08-01 22:16:43 +02001083 return NULL;
Bram Moolenaarf681cfb2022-02-07 20:30:57 +00001084 if (!ASCII_ISUPPER(is_global ? name_start[2] : name_start[0]))
1085 {
Bram Moolenaar3787f262022-02-07 21:54:01 +00001086 semsg(_(e_function_name_must_start_with_capital_str), name_start);
Bram Moolenaarf681cfb2022-02-07 20:30:57 +00001087 return NULL;
1088 }
Bram Moolenaareef21022020-08-01 22:16:43 +02001089
Bram Moolenaar04b12692020-05-04 23:24:44 +02001090 eap->arg = name_end;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001091 fill_exarg_from_cctx(eap, cctx);
1092
Bram Moolenaar04b12692020-05-04 23:24:44 +02001093 eap->forceit = FALSE;
Bram Moolenaar38453522021-11-28 22:00:12 +00001094 // We use the special <Lamba>99 name, but it's not really a lambda.
Bram Moolenaar58a52f22020-12-22 18:56:55 +01001095 lambda_name = vim_strsave(get_lambda_name());
1096 if (lambda_name == NULL)
1097 return NULL;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001098
1099 // This may free the current line, make a copy of the name.
1100 off = is_global ? 2 : 0;
1101 func_name = vim_strnsave(name_start + off, name_end - name_start - off);
1102 if (func_name == NULL)
1103 {
1104 r = FAIL;
1105 goto theend;
1106 }
1107
Bram Moolenaar39c82ea2023-01-02 13:08:01 +00001108 // Make sure "KeyTyped" is not set, it may cause indent to be written.
1109 int save_KeyTyped = KeyTyped;
1110 KeyTyped = FALSE;
1111
h-eastb895b0f2023-09-24 15:46:31 +02001112 ufunc = define_function(eap, lambda_name, lines_to_free, 0, NULL, 0);
Bram Moolenaar39c82ea2023-01-02 13:08:01 +00001113
1114 KeyTyped = save_KeyTyped;
1115
Bram Moolenaar822ba242020-05-24 23:00:18 +02001116 if (ufunc == NULL)
Bram Moolenaar58a52f22020-12-22 18:56:55 +01001117 {
1118 r = eap->skip ? OK : FAIL;
1119 goto theend;
1120 }
Bram Moolenaar7473a842021-12-28 17:55:26 +00001121 if (eap->nextcmd != NULL)
1122 {
1123 semsg(_(e_text_found_after_str_str),
1124 eap->cmdidx == CMD_def ? "enddef" : "endfunction", eap->nextcmd);
1125 r = FAIL;
Bram Moolenaard2939812021-12-30 17:09:05 +00001126 func_ptr_unref(ufunc);
Bram Moolenaar7473a842021-12-28 17:55:26 +00001127 goto theend;
1128 }
Bram Moolenaar8863bda2021-03-17 18:42:08 +01001129
1130 // copy over the block scope IDs before compiling
1131 if (!is_global && cctx->ctx_ufunc->uf_block_depth > 0)
1132 {
1133 int block_depth = cctx->ctx_ufunc->uf_block_depth;
1134
1135 ufunc->uf_block_ids = ALLOC_MULT(int, block_depth);
1136 if (ufunc->uf_block_ids != NULL)
1137 {
1138 mch_memmove(ufunc->uf_block_ids, cctx->ctx_ufunc->uf_block_ids,
1139 sizeof(int) * block_depth);
1140 ufunc->uf_block_depth = block_depth;
1141 }
1142 }
1143
Bram Moolenaara915fa02022-03-23 11:29:15 +00001144 // Define the funcref before compiling, so that it is found by any
1145 // recursive call.
1146 if (is_global)
1147 {
Bram Moolenaar65449bd2022-09-19 16:02:43 +01001148 r = generate_NEWFUNC(cctx, lambda_name, func_name);
Bram Moolenaara915fa02022-03-23 11:29:15 +00001149 func_name = NULL;
1150 lambda_name = NULL;
1151 }
1152 else
1153 {
1154 // Define a local variable for the function reference.
Bram Moolenaar1889f492022-08-16 19:34:44 +01001155 lvar = reserve_local(cctx, func_name, name_end - name_start,
Bram Moolenaar6586a012022-09-30 11:04:50 +01001156 ASSIGN_CONST, ufunc->uf_func_type);
Bram Moolenaara915fa02022-03-23 11:29:15 +00001157 if (lvar == NULL)
1158 goto theend;
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02001159 if (generate_FUNCREF(cctx, ufunc, NULL, FALSE, 0, &funcref_isn_idx) == FAIL)
Bram Moolenaara915fa02022-03-23 11:29:15 +00001160 goto theend;
1161 r = generate_STORE(cctx, ISN_STORE, lvar->lv_idx, NULL);
1162 }
1163
Bram Moolenaar139575d2022-03-15 19:29:30 +00001164 compile_type = get_compile_type(ufunc);
Bram Moolenaarffcfddc2021-07-11 20:22:30 +02001165#ifdef FEAT_PROFILE
1166 // If the outer function is profiled, also compile the nested function for
1167 // profiling.
1168 if (cctx->ctx_compile_type == CT_PROFILE)
1169 compile_type = CT_PROFILE;
1170#endif
1171 if (func_needs_compiling(ufunc, compile_type)
1172 && compile_def_function(ufunc, TRUE, compile_type, cctx) == FAIL)
Bram Moolenaar4ee711f2020-09-23 18:51:11 +02001173 {
1174 func_ptr_unref(ufunc);
Bram Moolenaar1889f492022-08-16 19:34:44 +01001175 if (lvar != NULL)
1176 // Now the local variable can't be used.
1177 *lvar->lv_name = '/'; // impossible value
Bram Moolenaar58a52f22020-12-22 18:56:55 +01001178 goto theend;
Bram Moolenaar4ee711f2020-09-23 18:51:11 +02001179 }
Bram Moolenaar04b12692020-05-04 23:24:44 +02001180
Bram Moolenaar648594e2021-07-11 17:55:01 +02001181#ifdef FEAT_PROFILE
1182 // When the outer function is compiled for profiling, the nested function
1183 // may be called without profiling. Compile it here in the right context.
Bram Moolenaarffcfddc2021-07-11 20:22:30 +02001184 if (compile_type == CT_PROFILE && func_needs_compiling(ufunc, CT_NONE))
Bram Moolenaar648594e2021-07-11 17:55:01 +02001185 compile_def_function(ufunc, FALSE, CT_NONE, cctx);
1186#endif
1187
Bram Moolenaara915fa02022-03-23 11:29:15 +00001188 // If a FUNCREF instruction was generated, set the index after compiling.
Yegappan Lakshmanana76fbe62023-09-27 18:51:43 +02001189 if (funcref_isn_idx != -1 && ufunc->uf_def_status == UF_COMPILED)
1190 {
1191 isn_T *funcref_isn = ((isn_T *)cctx->ctx_instr.ga_data) +
1192 funcref_isn_idx;
Bram Moolenaara915fa02022-03-23 11:29:15 +00001193 funcref_isn->isn_arg.funcref.fr_dfunc_idx = ufunc->uf_dfunc_idx;
Yegappan Lakshmanana76fbe62023-09-27 18:51:43 +02001194 }
Bram Moolenaar58a52f22020-12-22 18:56:55 +01001195
1196theend:
1197 vim_free(lambda_name);
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001198 vim_free(func_name);
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001199 return r == FAIL ? NULL : (char_u *)"";
Bram Moolenaar04b12692020-05-04 23:24:44 +02001200}
1201
1202/*
Bram Moolenaar0abc2872022-05-10 13:24:30 +01001203 * Compile one Vim expression {expr} in string "p".
1204 * "p" points to the opening "{".
1205 * Return a pointer to the character after "}", NULL for an error.
1206 */
1207 char_u *
1208compile_one_expr_in_str(char_u *p, cctx_T *cctx)
1209{
1210 char_u *block_start;
1211 char_u *block_end;
1212
1213 // Skip the opening {.
1214 block_start = skipwhite(p + 1);
1215 block_end = block_start;
1216 if (*block_start != NUL && skip_expr(&block_end, NULL) == FAIL)
1217 return NULL;
1218 block_end = skipwhite(block_end);
1219 // The block must be closed by a }.
1220 if (*block_end != '}')
1221 {
1222 semsg(_(e_missing_close_curly_str), p);
1223 return NULL;
1224 }
1225 if (compile_expr0(&block_start, cctx) == FAIL)
1226 return NULL;
Yegappan Lakshmananbce51d92024-04-15 19:19:52 +02001227 may_generate_2STRING(-1, TOSTRING_INTERPOLATE, cctx);
Bram Moolenaar0abc2872022-05-10 13:24:30 +01001228
1229 return block_end + 1;
1230}
1231
1232/*
LemonBoy2eaef102022-05-06 13:14:50 +01001233 * Compile a string "str" (either containing a literal string or a mix of
1234 * literal strings and Vim expressions of the form `{expr}`). This is used
1235 * when compiling a heredoc assignment to a variable or an interpolated string
1236 * in a Vim9 def function. Vim9 instructions are generated to push strings,
1237 * evaluate expressions, concatenate them and create a list of lines. When
1238 * "evalstr" is TRUE, Vim expressions in "str" are evaluated.
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01001239 */
1240 int
LemonBoy2eaef102022-05-06 13:14:50 +01001241compile_all_expr_in_str(char_u *str, int evalstr, cctx_T *cctx)
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01001242{
LemonBoy2eaef102022-05-06 13:14:50 +01001243 char_u *p = str;
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01001244 char_u *val;
LemonBoy2eaef102022-05-06 13:14:50 +01001245 int count = 0;
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01001246
1247 if (cctx->ctx_skip == SKIP_YES)
1248 return OK;
1249
LemonBoy2eaef102022-05-06 13:14:50 +01001250 if (!evalstr || *str == NUL)
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01001251 {
LemonBoy2eaef102022-05-06 13:14:50 +01001252 // Literal string, possibly empty.
1253 val = *str != NUL ? vim_strsave(str) : NULL;
1254 return generate_PUSHS(cctx, &val);
1255 }
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01001256
LemonBoy2eaef102022-05-06 13:14:50 +01001257 // Push all the string pieces to the stack, followed by a ISN_CONCAT.
1258 while (*p != NUL)
1259 {
1260 char_u *lit_start;
LemonBoy2eaef102022-05-06 13:14:50 +01001261 int escaped_brace = FALSE;
1262
1263 // Look for a block start.
1264 lit_start = p;
1265 while (*p != '{' && *p != '}' && *p != NUL)
1266 ++p;
1267
1268 if (*p != NUL && *p == p[1])
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01001269 {
LemonBoy2eaef102022-05-06 13:14:50 +01001270 // Escaped brace, unescape and continue.
1271 // Include the brace in the literal string.
1272 ++p;
1273 escaped_brace = TRUE;
1274 }
1275 else if (*p == '}')
1276 {
1277 semsg(_(e_stray_closing_curly_str), str);
1278 return FAIL;
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01001279 }
LemonBoy372bcce2022-04-25 12:43:20 +01001280
LemonBoy2eaef102022-05-06 13:14:50 +01001281 // Append the literal part.
1282 if (p != lit_start)
1283 {
1284 val = vim_strnsave(lit_start, (size_t)(p - lit_start));
1285 if (generate_PUSHS(cctx, &val) == FAIL)
1286 return FAIL;
1287 ++count;
1288 }
1289
1290 if (*p == NUL)
1291 break;
1292
1293 if (escaped_brace)
1294 {
1295 // Skip the second brace.
1296 ++p;
1297 continue;
1298 }
1299
Bram Moolenaar0abc2872022-05-10 13:24:30 +01001300 p = compile_one_expr_in_str(p, cctx);
1301 if (p == NULL)
LemonBoy2eaef102022-05-06 13:14:50 +01001302 return FAIL;
LemonBoy2eaef102022-05-06 13:14:50 +01001303 ++count;
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01001304 }
LemonBoy2eaef102022-05-06 13:14:50 +01001305
1306 // Small optimization, if there's only a single piece skip the ISN_CONCAT.
Bram Moolenaar0abc2872022-05-10 13:24:30 +01001307 if (count > 1)
LemonBoy2eaef102022-05-06 13:14:50 +01001308 return generate_CONCAT(cctx, count);
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01001309
1310 return OK;
1311}
1312
1313/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001314 * Return the length of an assignment operator, or zero if there isn't one.
1315 */
1316 int
1317assignment_len(char_u *p, int *heredoc)
1318{
1319 if (*p == '=')
1320 {
1321 if (p[1] == '<' && p[2] == '<')
1322 {
1323 *heredoc = TRUE;
1324 return 3;
1325 }
1326 return 1;
1327 }
1328 if (vim_strchr((char_u *)"+-*/%", *p) != NULL && p[1] == '=')
1329 return 2;
1330 if (STRNCMP(p, "..=", 3) == 0)
1331 return 3;
1332 return 0;
1333}
1334
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001335/*
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001336 * Generate the load instruction for "name".
1337 */
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02001338 static int
Bram Moolenaard505d172022-12-18 21:42:55 +00001339generate_loadvar(cctx_T *cctx, lhs_T *lhs)
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001340{
Bram Moolenaard505d172022-12-18 21:42:55 +00001341 char_u *name = lhs->lhs_name;
1342 type_T *type = lhs->lhs_type;
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02001343 int res = OK;
Bram Moolenaard505d172022-12-18 21:42:55 +00001344
1345 switch (lhs->lhs_dest)
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001346 {
1347 case dest_option:
Bram Moolenaardcb53be2021-12-09 14:23:43 +00001348 case dest_func_option:
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001349 generate_LOAD(cctx, ISN_LOADOPT, 0, name, type);
1350 break;
1351 case dest_global:
Bram Moolenaar03290b82020-12-19 16:30:44 +01001352 if (vim_strchr(name, AUTOLOAD_CHAR) == NULL)
Bram Moolenaar2e17fef2022-03-18 19:44:48 +00001353 {
1354 if (name[2] == NUL)
1355 generate_instr_type(cctx, ISN_LOADGDICT, &t_dict_any);
1356 else
1357 generate_LOAD(cctx, ISN_LOADG, 0, name + 2, type);
1358 }
Bram Moolenaar03290b82020-12-19 16:30:44 +01001359 else
1360 generate_LOAD(cctx, ISN_LOADAUTO, 0, name, type);
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001361 break;
1362 case dest_buffer:
1363 generate_LOAD(cctx, ISN_LOADB, 0, name + 2, type);
1364 break;
1365 case dest_window:
1366 generate_LOAD(cctx, ISN_LOADW, 0, name + 2, type);
1367 break;
1368 case dest_tab:
1369 generate_LOAD(cctx, ISN_LOADT, 0, name + 2, type);
1370 break;
1371 case dest_script:
Ernie Rael3f821d62024-04-24 20:07:50 +02001372 case dest_script_v9:
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02001373 res = compile_load_scriptvar(cctx,
Bram Moolenaard0132f42022-05-12 11:05:40 +01001374 name + (name[1] == ':' ? 2 : 0), NULL, NULL);
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001375 break;
1376 case dest_env:
1377 // Include $ in the name here
1378 generate_LOAD(cctx, ISN_LOADENV, 0, name, type);
1379 break;
1380 case dest_reg:
1381 generate_LOAD(cctx, ISN_LOADREG, name[1], NULL, &t_string);
1382 break;
1383 case dest_vimvar:
Bram Moolenaarc3caa7f2022-05-25 19:15:10 +01001384 generate_LOADV(cctx, name + 2);
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001385 break;
1386 case dest_local:
Bram Moolenaar4875d6a2022-08-17 15:55:51 +01001387 if (cctx->ctx_skip != SKIP_YES)
1388 {
Bram Moolenaard505d172022-12-18 21:42:55 +00001389 lvar_T *lvar = lhs->lhs_lvar;
Bram Moolenaar4875d6a2022-08-17 15:55:51 +01001390 if (lvar->lv_from_outer > 0)
1391 generate_LOADOUTER(cctx, lvar->lv_idx, lvar->lv_from_outer,
Bram Moolenaar65449bd2022-09-19 16:02:43 +01001392 lvar->lv_loop_depth, lvar->lv_loop_idx, type);
Bram Moolenaar4875d6a2022-08-17 15:55:51 +01001393 else
1394 generate_LOAD(cctx, ISN_LOAD, lvar->lv_idx, NULL, type);
1395 }
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001396 break;
Bram Moolenaard505d172022-12-18 21:42:55 +00001397 case dest_class_member:
1398 generate_CLASSMEMBER(cctx, TRUE, lhs->lhs_class,
1399 lhs->lhs_classmember_idx);
1400 break;
Bram Moolenaardc234ca2020-11-28 18:52:33 +01001401 case dest_expr:
1402 // list or dict value should already be on the stack.
1403 break;
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001404 }
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02001405
1406 return res;
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001407}
1408
Bram Moolenaardc234ca2020-11-28 18:52:33 +01001409/*
1410 * Skip over "[expr]" or ".member".
1411 * Does not check for any errors.
1412 */
1413 static char_u *
1414skip_index(char_u *start)
1415{
1416 char_u *p = start;
1417
1418 if (*p == '[')
1419 {
1420 p = skipwhite(p + 1);
1421 (void)skip_expr(&p, NULL);
1422 p = skipwhite(p);
1423 if (*p == ']')
1424 return p + 1;
1425 return p;
1426 }
1427 // if (*p == '.')
1428 return to_name_end(p + 1, TRUE);
1429}
1430
Bram Moolenaare55b1c02020-06-21 15:52:59 +02001431 void
1432vim9_declare_error(char_u *name)
1433{
1434 char *scope = "";
1435
1436 switch (*name)
1437 {
Bram Moolenaar7fe87552020-06-21 20:38:28 +02001438 case 'g': scope = _("global"); break;
1439 case 'b': scope = _("buffer"); break;
1440 case 'w': scope = _("window"); break;
1441 case 't': scope = _("tab"); break;
1442 case 'v': scope = "v:"; break;
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00001443 case '$': semsg(_(e_cannot_declare_an_environment_variable_str), name);
Bram Moolenaarc2ee44c2020-08-02 16:59:00 +02001444 return;
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00001445 case '&': semsg(_(e_cannot_declare_an_option_str), name);
Bram Moolenaarc2ee44c2020-08-02 16:59:00 +02001446 return;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001447 case '@': semsg(_(e_cannot_declare_a_register_str), name);
Bram Moolenaarc2ee44c2020-08-02 16:59:00 +02001448 return;
Bram Moolenaar7fe87552020-06-21 20:38:28 +02001449 default: return;
Bram Moolenaare55b1c02020-06-21 15:52:59 +02001450 }
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00001451 semsg(_(e_cannot_declare_a_scope_variable_str), scope, name);
Bram Moolenaare55b1c02020-06-21 15:52:59 +02001452}
1453
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001454/*
Bram Moolenaar3558afe2022-10-13 16:12:57 +01001455 * Return TRUE if "name" is a valid register to use.
1456 * Return FALSE and give an error message if not.
1457 */
1458 static int
1459valid_dest_reg(int name)
1460{
1461 if ((name == '@' || valid_yank_reg(name, FALSE)) && name != '.')
1462 return TRUE;
1463 emsg_invreg(name);
1464 return FAIL;
1465}
1466
1467/*
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001468 * For one assignment figure out the type of destination. Return it in "dest".
1469 * When not recognized "dest" is not set.
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001470 * For an option "option_scope" is set.
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001471 * For a v:var "vimvaridx" is set.
1472 * "type" is set to the destination type if known, unchanted otherwise.
1473 * Return FAIL if an error message was given.
1474 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +00001475 int
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001476get_var_dest(
1477 char_u *name,
1478 assign_dest_T *dest,
Bram Moolenaar97f8c102022-04-02 19:43:57 +01001479 cmdidx_T cmdidx,
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001480 int *option_scope,
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001481 int *vimvaridx,
1482 type_T **type,
1483 cctx_T *cctx)
1484{
1485 char_u *p;
1486
1487 if (*name == '&')
1488 {
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001489 int cc;
1490 long numval;
1491 getoption_T opt_type;
Bram Moolenaardcb53be2021-12-09 14:23:43 +00001492 int opt_p_flags;
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001493
1494 *dest = dest_option;
1495 if (cmdidx == CMD_final || cmdidx == CMD_const)
1496 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00001497 emsg(_(e_cannot_lock_option));
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001498 return FAIL;
1499 }
1500 p = name;
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001501 p = find_option_end(&p, option_scope);
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001502 if (p == NULL)
1503 {
1504 // cannot happen?
Bram Moolenaar108010a2021-06-27 22:03:33 +02001505 emsg(_(e_unexpected_characters_in_assignment));
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001506 return FAIL;
1507 }
1508 cc = *p;
1509 *p = NUL;
1510 opt_type = get_option_value(skip_option_env_lead(name),
Bram Moolenaardcb53be2021-12-09 14:23:43 +00001511 &numval, NULL, &opt_p_flags, *option_scope);
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001512 *p = cc;
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001513 switch (opt_type)
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001514 {
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001515 case gov_unknown:
Bram Moolenaare1242042021-12-16 20:56:57 +00001516 semsg(_(e_unknown_option_str), name);
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001517 return FAIL;
1518 case gov_string:
1519 case gov_hidden_string:
Bram Moolenaardcb53be2021-12-09 14:23:43 +00001520 if (opt_p_flags & P_FUNC)
1521 {
1522 // might be a Funcref, check the type later
1523 *type = &t_any;
1524 *dest = dest_func_option;
1525 }
1526 else
1527 {
1528 *type = &t_string;
1529 }
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001530 break;
1531 case gov_bool:
1532 case gov_hidden_bool:
1533 *type = &t_bool;
1534 break;
1535 case gov_number:
1536 case gov_hidden_number:
1537 *type = &t_number;
1538 break;
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001539 }
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001540 }
1541 else if (*name == '$')
1542 {
1543 *dest = dest_env;
1544 *type = &t_string;
1545 }
1546 else if (*name == '@')
1547 {
Bram Moolenaar3558afe2022-10-13 16:12:57 +01001548 if (!valid_dest_reg(name[1]))
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001549 return FAIL;
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001550 *dest = dest_reg;
Bram Moolenaar74f4a962021-06-17 21:03:07 +02001551 *type = name[1] == '#' ? &t_number_or_string : &t_string;
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001552 }
1553 else if (STRNCMP(name, "g:", 2) == 0)
1554 {
1555 *dest = dest_global;
1556 }
1557 else if (STRNCMP(name, "b:", 2) == 0)
1558 {
1559 *dest = dest_buffer;
1560 }
1561 else if (STRNCMP(name, "w:", 2) == 0)
1562 {
1563 *dest = dest_window;
1564 }
1565 else if (STRNCMP(name, "t:", 2) == 0)
1566 {
1567 *dest = dest_tab;
1568 }
1569 else if (STRNCMP(name, "v:", 2) == 0)
1570 {
1571 typval_T *vtv;
1572 int di_flags;
1573
1574 *vimvaridx = find_vim_var(name + 2, &di_flags);
1575 if (*vimvaridx < 0)
1576 {
1577 semsg(_(e_variable_not_found_str), name);
1578 return FAIL;
1579 }
1580 // We use the current value of "sandbox" here, is that OK?
1581 if (var_check_ro(di_flags, name, FALSE))
1582 return FAIL;
1583 *dest = dest_vimvar;
1584 vtv = get_vim_var_tv(*vimvaridx);
1585 *type = typval2type_vimvar(vtv, cctx->ctx_type_list);
1586 }
1587 return OK;
1588}
1589
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02001590 static int
Bram Moolenaar97f8c102022-04-02 19:43:57 +01001591is_decl_command(cmdidx_T cmdidx)
Bram Moolenaar752fc692021-01-04 21:57:11 +01001592{
1593 return cmdidx == CMD_let || cmdidx == CMD_var
1594 || cmdidx == CMD_final || cmdidx == CMD_const;
1595}
1596
1597/*
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02001598 * Returns TRUE if the class or object variable in "lhs" is modifiable.
1599 * "var_start" points to the start of the variable name and "lhs->lhs_varlen"
1600 * has the total length. Note that the "lhs" can be nested an object reference
1601 * (e.g. a.b.c.d.var).
1602 */
1603 static int
1604lhs_class_member_modifiable(lhs_T *lhs, char_u *var_start, cctx_T *cctx)
1605{
1606 size_t varlen = lhs->lhs_varlen;
1607 class_T *cl = lhs->lhs_type->tt_class;
1608 int is_object = lhs->lhs_type->tt_type == VAR_OBJECT;
1609 char_u *name = var_start + varlen + 1;
1610 size_t namelen = lhs->lhs_end - var_start - varlen - 1;
1611 ocmember_T *m;
1612
1613 m = member_lookup(cl, lhs->lhs_type->tt_type, name, namelen, NULL);
1614 if (m == NULL)
1615 {
1616 member_not_found_msg(cl, lhs->lhs_type->tt_type, name, namelen);
1617 return FALSE;
1618 }
1619
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01001620 if (IS_ENUM(cl))
1621 {
1622 semsg(_(e_enumvalue_str_cannot_be_modified), cl->class_name,
1623 m->ocm_name);
1624 return FALSE;
1625 }
1626
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02001627 // If it is private member variable, then accessing it outside the
1628 // class is not allowed.
1629 // If it is a read only class variable, then it can be modified
1630 // only inside the class where it is defined.
1631 if ((m->ocm_access != VIM_ACCESS_ALL) &&
1632 ((is_object && !inside_class(cctx, cl))
1633 || (!is_object && cctx->ctx_ufunc->uf_class != cl)))
1634 {
1635 char *msg = (m->ocm_access == VIM_ACCESS_PRIVATE)
Ernie Rael03042a22023-11-11 08:53:32 +01001636 ? e_cannot_access_protected_variable_str
RestorerZ7fe8f432023-09-24 23:21:24 +02001637 : e_variable_is_not_writable_str;
Ernie Raele6c9aa52023-10-06 19:55:52 +02001638 emsg_var_cl_define(msg, m->ocm_name, 0, cl);
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02001639 return FALSE;
1640 }
1641
1642 return TRUE;
1643}
1644
1645/*
Bram Moolenaar752fc692021-01-04 21:57:11 +01001646 * Figure out the LHS type and other properties for an assignment or one item
1647 * of ":unlet" with an index.
1648 * Returns OK or FAIL.
1649 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +00001650 int
Bram Moolenaar752fc692021-01-04 21:57:11 +01001651compile_lhs(
Bram Moolenaar97f8c102022-04-02 19:43:57 +01001652 char_u *var_start,
1653 lhs_T *lhs,
1654 cmdidx_T cmdidx,
1655 int heredoc,
1656 int has_cmd, // "var" before "var_start"
1657 int oplen,
1658 cctx_T *cctx)
Bram Moolenaar752fc692021-01-04 21:57:11 +01001659{
1660 char_u *var_end;
1661 int is_decl = is_decl_command(cmdidx);
1662
1663 CLEAR_POINTER(lhs);
1664 lhs->lhs_dest = dest_local;
1665 lhs->lhs_vimvaridx = -1;
1666 lhs->lhs_scriptvar_idx = -1;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001667 lhs->lhs_member_idx = -1;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001668
1669 // "dest_end" is the end of the destination, including "[expr]" or
1670 // ".name".
1671 // "var_end" is the end of the variable/option/etc. name.
1672 lhs->lhs_dest_end = skip_var_one(var_start, FALSE);
1673 if (*var_start == '@')
Bram Moolenaar3558afe2022-10-13 16:12:57 +01001674 {
1675 if (!valid_dest_reg(var_start[1]))
1676 return FAIL;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001677 var_end = var_start + 2;
Bram Moolenaar3558afe2022-10-13 16:12:57 +01001678 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01001679 else
1680 {
1681 // skip over the leading "&", "&l:", "&g:" and "$"
1682 var_end = skip_option_env_lead(var_start);
1683 var_end = to_name_end(var_end, TRUE);
1684 }
1685
1686 // "a: type" is declaring variable "a" with a type, not dict "a:".
1687 if (is_decl && lhs->lhs_dest_end == var_start + 2
1688 && lhs->lhs_dest_end[-1] == ':')
1689 --lhs->lhs_dest_end;
1690 if (is_decl && var_end == var_start + 2 && var_end[-1] == ':')
1691 --var_end;
Bram Moolenaarab36e6a2021-11-30 16:14:49 +00001692 lhs->lhs_end = lhs->lhs_dest_end;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001693
1694 // compute the length of the destination without "[expr]" or ".name"
1695 lhs->lhs_varlen = var_end - var_start;
Bram Moolenaar753bcf82021-04-21 14:24:24 +02001696 lhs->lhs_varlen_total = lhs->lhs_varlen;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001697 lhs->lhs_name = vim_strnsave(var_start, lhs->lhs_varlen);
1698 if (lhs->lhs_name == NULL)
1699 return FAIL;
Bram Moolenaar08251752021-01-11 21:20:18 +01001700
1701 if (lhs->lhs_dest_end > var_start + lhs->lhs_varlen)
1702 // Something follows after the variable: "var[idx]" or "var.key".
1703 lhs->lhs_has_index = TRUE;
1704
Bram Moolenaar752fc692021-01-04 21:57:11 +01001705 if (heredoc)
1706 lhs->lhs_type = &t_list_string;
1707 else
1708 lhs->lhs_type = &t_any;
1709
1710 if (cctx->ctx_skip != SKIP_YES)
1711 {
1712 int declare_error = FALSE;
1713
1714 if (get_var_dest(lhs->lhs_name, &lhs->lhs_dest, cmdidx,
1715 &lhs->lhs_opt_flags, &lhs->lhs_vimvaridx,
1716 &lhs->lhs_type, cctx) == FAIL)
1717 return FAIL;
Bram Moolenaard877a572021-04-01 19:42:48 +02001718 if (lhs->lhs_dest != dest_local
1719 && cmdidx != CMD_const && cmdidx != CMD_final)
Bram Moolenaar752fc692021-01-04 21:57:11 +01001720 {
1721 // Specific kind of variable recognized.
1722 declare_error = is_decl;
1723 }
1724 else
1725 {
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02001726 class_T *defcl;
1727
Bram Moolenaar752fc692021-01-04 21:57:11 +01001728 // No specific kind of variable recognized, just a name.
h-east2bd6a092023-05-19 19:01:17 +01001729 if (check_reserved_name(lhs->lhs_name, lhs->lhs_has_index
1730 && *var_end == '.') == FAIL)
Bram Moolenaard0edaf92021-05-28 21:06:08 +02001731 return FAIL;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001732
1733 if (lookup_local(var_start, lhs->lhs_varlen,
1734 &lhs->lhs_local_lvar, cctx) == OK)
Bram Moolenaard505d172022-12-18 21:42:55 +00001735 {
Bram Moolenaar752fc692021-01-04 21:57:11 +01001736 lhs->lhs_lvar = &lhs->lhs_local_lvar;
Bram Moolenaard505d172022-12-18 21:42:55 +00001737 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01001738 else
1739 {
1740 CLEAR_FIELD(lhs->lhs_arg_lvar);
1741 if (arg_exists(var_start, lhs->lhs_varlen,
1742 &lhs->lhs_arg_lvar.lv_idx, &lhs->lhs_arg_lvar.lv_type,
1743 &lhs->lhs_arg_lvar.lv_from_outer, cctx) == OK)
1744 {
1745 if (is_decl)
1746 {
1747 semsg(_(e_str_is_used_as_argument), lhs->lhs_name);
1748 return FAIL;
1749 }
1750 lhs->lhs_lvar = &lhs->lhs_arg_lvar;
1751 }
1752 }
Bram Moolenaard505d172022-12-18 21:42:55 +00001753
Bram Moolenaar752fc692021-01-04 21:57:11 +01001754 if (lhs->lhs_lvar != NULL)
1755 {
1756 if (is_decl)
1757 {
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02001758 // if we come here with what looks like an assignment like
Yegappan Lakshmananb5a07192023-10-05 20:14:43 +02001759 // .= but which has been rejected by assignment_len() from
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02001760 // may_compile_assignment give a better error message
Christian Brabandt504543f2023-09-11 20:08:50 +02001761 char_u *p = skipwhite(lhs->lhs_end);
1762 if (p[0] == '.' && p[1] == '=')
1763 emsg(_(e_dot_equal_not_supported_with_script_version_two));
Yegappan Lakshmananb5a07192023-10-05 20:14:43 +02001764 else if (p[0] == ':')
1765 // type specified in a non-var assignment
1766 semsg(_(e_trailing_characters_str), p);
Christian Brabandt504543f2023-09-11 20:08:50 +02001767 else
1768 semsg(_(e_variable_already_declared_str), lhs->lhs_name);
Bram Moolenaar752fc692021-01-04 21:57:11 +01001769 return FAIL;
1770 }
1771 }
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02001772 else if ((lhs->lhs_classmember_idx = cctx_class_member_idx(
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02001773 cctx, var_start, lhs->lhs_varlen, &defcl)) >= 0)
Bram Moolenaard505d172022-12-18 21:42:55 +00001774 {
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02001775 if (cctx->ctx_ufunc->uf_defclass != defcl)
1776 {
1777 // A class variable can be accessed without the class name
1778 // only inside a class.
RestorerZ7fe8f432023-09-24 23:21:24 +02001779 semsg(_(e_class_variable_str_accessible_only_inside_class_str),
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02001780 lhs->lhs_name, defcl->class_name);
1781 return FAIL;
1782 }
Bram Moolenaar6acf7572023-01-01 19:53:30 +00001783 if (is_decl)
1784 {
1785 semsg(_(e_variable_already_declared_in_class_str),
1786 lhs->lhs_name);
1787 return FAIL;
1788 }
Yegappan Lakshmanane5437c52023-12-16 14:11:19 +01001789
1790 ocmember_T *m =
1791 &defcl->class_class_members[lhs->lhs_classmember_idx];
1792 if (oc_var_check_ro(defcl, m))
1793 return FAIL;
1794
Bram Moolenaard505d172022-12-18 21:42:55 +00001795 lhs->lhs_dest = dest_class_member;
Yegappan Lakshmanan2ed5a112024-04-01 14:50:41 +02001796 // The class variable is defined either in the current class or
1797 // in one of the parent class in the hierarchy.
1798 lhs->lhs_class = defcl;
1799 lhs->lhs_type = oc_member_type_by_idx(defcl, FALSE,
1800 lhs->lhs_classmember_idx);
Bram Moolenaard505d172022-12-18 21:42:55 +00001801 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01001802 else
1803 {
1804 int script_namespace = lhs->lhs_varlen > 1
1805 && STRNCMP(var_start, "s:", 2) == 0;
1806 int script_var = (script_namespace
1807 ? script_var_exists(var_start + 2, lhs->lhs_varlen - 2,
Bram Moolenaardce24412022-02-08 20:35:30 +00001808 cctx, NULL)
Bram Moolenaar752fc692021-01-04 21:57:11 +01001809 : script_var_exists(var_start, lhs->lhs_varlen,
Bram Moolenaardce24412022-02-08 20:35:30 +00001810 cctx, NULL)) == OK;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001811 imported_T *import =
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00001812 find_imported(var_start, lhs->lhs_varlen, FALSE);
Bram Moolenaar752fc692021-01-04 21:57:11 +01001813
1814 if (script_namespace || script_var || import != NULL)
1815 {
1816 char_u *rawname = lhs->lhs_name
1817 + (lhs->lhs_name[1] == ':' ? 2 : 0);
1818
Bram Moolenaarafa048f2022-02-22 20:43:36 +00001819 if (script_namespace && current_script_is_vim9())
1820 {
1821 semsg(_(e_cannot_use_s_colon_in_vim9_script_str),
1822 var_start);
1823 return FAIL;
1824 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01001825 if (is_decl)
1826 {
1827 if (script_namespace)
Bram Moolenaara749a422022-02-12 19:52:25 +00001828 semsg(_(e_cannot_declare_script_variable_in_function_str),
Bram Moolenaar752fc692021-01-04 21:57:11 +01001829 lhs->lhs_name);
1830 else
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001831 semsg(_(e_variable_already_declared_in_script_str),
Bram Moolenaar752fc692021-01-04 21:57:11 +01001832 lhs->lhs_name);
1833 return FAIL;
1834 }
1835 else if (cctx->ctx_ufunc->uf_script_ctx_version
1836 == SCRIPT_VERSION_VIM9
1837 && script_namespace
1838 && !script_var && import == NULL)
1839 {
1840 semsg(_(e_unknown_variable_str), lhs->lhs_name);
1841 return FAIL;
1842 }
1843
Ernie Rael3f821d62024-04-24 20:07:50 +02001844 lhs->lhs_dest = current_script_is_vim9()
1845 ? dest_script_v9 : dest_script;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001846
1847 // existing script-local variables should have a type
1848 lhs->lhs_scriptvar_sid = current_sctx.sc_sid;
1849 if (import != NULL)
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001850 {
1851 char_u *dot = vim_strchr(var_start, '.');
1852 char_u *p;
1853
1854 // for an import the name is what comes after the dot
1855 if (dot == NULL)
1856 {
1857 semsg(_(e_no_dot_after_imported_name_str),
1858 var_start);
1859 return FAIL;
1860 }
1861 p = skipwhite(dot + 1);
1862 var_end = to_name_end(p, TRUE);
1863 if (var_end == p)
1864 {
1865 semsg(_(e_missing_name_after_imported_name_str),
1866 var_start);
1867 return FAIL;
1868 }
1869 vim_free(lhs->lhs_name);
1870 lhs->lhs_varlen = var_end - p;
1871 lhs->lhs_name = vim_strnsave(p, lhs->lhs_varlen);
1872 if (lhs->lhs_name == NULL)
1873 return FAIL;
1874 rawname = lhs->lhs_name;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001875 lhs->lhs_scriptvar_sid = import->imp_sid;
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001876 // TODO: where do we check this name is exported?
1877
1878 // Check if something follows: "exp.var[idx]" or
1879 // "exp.var.key".
1880 lhs->lhs_has_index = lhs->lhs_dest_end
1881 > skipwhite(var_end);
1882 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01001883 if (SCRIPT_ID_VALID(lhs->lhs_scriptvar_sid))
1884 {
Bram Moolenaar08251752021-01-11 21:20:18 +01001885 // Check writable only when no index follows.
Bram Moolenaar752fc692021-01-04 21:57:11 +01001886 lhs->lhs_scriptvar_idx = get_script_item_idx(
Bram Moolenaar08251752021-01-11 21:20:18 +01001887 lhs->lhs_scriptvar_sid, rawname,
1888 lhs->lhs_has_index ? ASSIGN_FINAL : ASSIGN_CONST,
Bram Moolenaarb6a138e2022-02-08 21:17:22 +00001889 cctx, NULL);
Bram Moolenaar752fc692021-01-04 21:57:11 +01001890 if (lhs->lhs_scriptvar_idx >= 0)
1891 {
1892 scriptitem_T *si = SCRIPT_ITEM(
1893 lhs->lhs_scriptvar_sid);
1894 svar_T *sv =
1895 ((svar_T *)si->sn_var_vals.ga_data)
1896 + lhs->lhs_scriptvar_idx;
1897 lhs->lhs_type = sv->sv_type;
1898 }
1899 }
1900 }
Bram Moolenaardce24412022-02-08 20:35:30 +00001901 else if (check_defined(var_start, lhs->lhs_varlen, cctx,
1902 NULL, FALSE) == FAIL)
Bram Moolenaar752fc692021-01-04 21:57:11 +01001903 return FAIL;
1904 }
1905 }
1906
1907 if (declare_error)
1908 {
1909 vim9_declare_error(lhs->lhs_name);
1910 return FAIL;
1911 }
1912 }
1913
Bram Moolenaarab36e6a2021-11-30 16:14:49 +00001914 // handle "a:name" as a name, not index "name" in "a"
Bram Moolenaar752fc692021-01-04 21:57:11 +01001915 if (lhs->lhs_varlen > 1 || var_start[lhs->lhs_varlen] != ':')
1916 var_end = lhs->lhs_dest_end;
1917
Bram Moolenaardcb53be2021-12-09 14:23:43 +00001918 if (lhs->lhs_dest != dest_option && lhs->lhs_dest != dest_func_option)
Bram Moolenaar752fc692021-01-04 21:57:11 +01001919 {
Bram Moolenaarce93d162023-01-30 21:12:34 +00001920 if (is_decl && *skipwhite(var_end) == ':')
Bram Moolenaar752fc692021-01-04 21:57:11 +01001921 {
1922 char_u *p;
1923
1924 // parse optional type: "let var: type = expr"
Bram Moolenaarce93d162023-01-30 21:12:34 +00001925 if (VIM_ISWHITE(*var_end))
1926 {
1927 semsg(_(e_no_white_space_allowed_before_colon_str), var_end);
1928 return FAIL;
1929 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01001930 if (!VIM_ISWHITE(var_end[1]))
1931 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +01001932 semsg(_(e_white_space_required_after_str_str), ":", var_end);
Bram Moolenaar752fc692021-01-04 21:57:11 +01001933 return FAIL;
1934 }
1935 p = skipwhite(var_end + 1);
1936 lhs->lhs_type = parse_type(&p, cctx->ctx_type_list, TRUE);
1937 if (lhs->lhs_type == NULL)
1938 return FAIL;
1939 lhs->lhs_has_type = TRUE;
Bram Moolenaarab36e6a2021-11-30 16:14:49 +00001940 lhs->lhs_end = p;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001941 }
1942 else if (lhs->lhs_lvar != NULL)
1943 lhs->lhs_type = lhs->lhs_lvar->lv_type;
1944 }
1945
Bram Moolenaare42939a2021-04-05 17:11:17 +02001946 if (oplen == 3 && !heredoc
1947 && lhs->lhs_dest != dest_global
1948 && !lhs->lhs_has_index
1949 && lhs->lhs_type->tt_type != VAR_STRING
1950 && lhs->lhs_type->tt_type != VAR_ANY)
Bram Moolenaar752fc692021-01-04 21:57:11 +01001951 {
1952 emsg(_(e_can_only_concatenate_to_string));
1953 return FAIL;
1954 }
1955
1956 if (lhs->lhs_lvar == NULL && lhs->lhs_dest == dest_local
1957 && cctx->ctx_skip != SKIP_YES)
1958 {
1959 if (oplen > 1 && !heredoc)
1960 {
1961 // +=, /=, etc. require an existing variable
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00001962 semsg(_(e_cannot_use_operator_on_new_variable_str), lhs->lhs_name);
Bram Moolenaar752fc692021-01-04 21:57:11 +01001963 return FAIL;
1964 }
Bram Moolenaar97f8c102022-04-02 19:43:57 +01001965 if (!is_decl || (lhs->lhs_has_index && !has_cmd
1966 && cctx->ctx_skip != SKIP_YES))
Bram Moolenaar752fc692021-01-04 21:57:11 +01001967 {
1968 semsg(_(e_unknown_variable_str), lhs->lhs_name);
1969 return FAIL;
1970 }
1971
Bram Moolenaar3f327882021-03-17 20:56:38 +01001972 // Check the name is valid for a funcref.
Bram Moolenaar752fc692021-01-04 21:57:11 +01001973 if ((lhs->lhs_type->tt_type == VAR_FUNC
1974 || lhs->lhs_type->tt_type == VAR_PARTIAL)
Bram Moolenaar3f327882021-03-17 20:56:38 +01001975 && var_wrong_func_name(lhs->lhs_name, TRUE))
Bram Moolenaar752fc692021-01-04 21:57:11 +01001976 return FAIL;
Bram Moolenaar3f327882021-03-17 20:56:38 +01001977
1978 // New local variable.
Bram Moolenaar6586a012022-09-30 11:04:50 +01001979 int assign = cmdidx == CMD_final ? ASSIGN_FINAL
1980 : cmdidx == CMD_const ? ASSIGN_CONST : ASSIGN_VAR;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001981 lhs->lhs_lvar = reserve_local(cctx, var_start, lhs->lhs_varlen,
Bram Moolenaar6586a012022-09-30 11:04:50 +01001982 assign, lhs->lhs_type);
Bram Moolenaar752fc692021-01-04 21:57:11 +01001983 if (lhs->lhs_lvar == NULL)
1984 return FAIL;
1985 lhs->lhs_new_local = TRUE;
1986 }
1987
1988 lhs->lhs_member_type = lhs->lhs_type;
Bram Moolenaar08251752021-01-11 21:20:18 +01001989 if (lhs->lhs_has_index)
Bram Moolenaar752fc692021-01-04 21:57:11 +01001990 {
Bram Moolenaarc750d912021-11-29 22:02:12 +00001991 char_u *after = var_start + lhs->lhs_varlen;
1992 char_u *p;
1993
Bram Moolenaar752fc692021-01-04 21:57:11 +01001994 // Something follows after the variable: "var[idx]" or "var.key".
Bram Moolenaar97f8c102022-04-02 19:43:57 +01001995 if (is_decl && cctx->ctx_skip != SKIP_YES)
Bram Moolenaar752fc692021-01-04 21:57:11 +01001996 {
Bram Moolenaar97f8c102022-04-02 19:43:57 +01001997 if (has_cmd)
1998 emsg(_(e_cannot_use_index_when_declaring_variable));
1999 else
2000 semsg(_(e_unknown_variable_str), lhs->lhs_name);
Bram Moolenaar752fc692021-01-04 21:57:11 +01002001 return FAIL;
2002 }
2003
Bram Moolenaarc750d912021-11-29 22:02:12 +00002004 // Now: var_start[lhs->lhs_varlen] is '[' or '.'
2005 // Only the last index is used below, if there are others
2006 // before it generate code for the expression. Thus for
2007 // "ll[1][2]" the expression is "ll[1]" and "[2]" is the index.
2008 for (;;)
Bram Moolenaar752fc692021-01-04 21:57:11 +01002009 {
Bram Moolenaarc750d912021-11-29 22:02:12 +00002010 p = skip_index(after);
2011 if (*p != '[' && *p != '.')
Bram Moolenaar752fc692021-01-04 21:57:11 +01002012 {
Bram Moolenaarc750d912021-11-29 22:02:12 +00002013 lhs->lhs_varlen_total = p - var_start;
2014 break;
Bram Moolenaar752fc692021-01-04 21:57:11 +01002015 }
Bram Moolenaarc750d912021-11-29 22:02:12 +00002016 after = p;
Bram Moolenaar752fc692021-01-04 21:57:11 +01002017 }
Bram Moolenaarc750d912021-11-29 22:02:12 +00002018 if (after > var_start + lhs->lhs_varlen)
2019 {
2020 lhs->lhs_varlen = after - var_start;
2021 lhs->lhs_dest = dest_expr;
2022 // We don't know the type before evaluating the expression,
2023 // use "any" until then.
2024 lhs->lhs_type = &t_any;
2025 }
2026
Bram Moolenaar666cb9c2023-02-22 12:35:17 +00002027 int use_class = lhs->lhs_type != NULL
2028 && (lhs->lhs_type->tt_type == VAR_CLASS
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02002029 || lhs->lhs_type->tt_type == VAR_OBJECT);
Bram Moolenaarb1e32ac2023-02-21 12:38:51 +00002030 if (lhs->lhs_type == NULL
2031 || (use_class ? lhs->lhs_type->tt_class == NULL
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02002032 : lhs->lhs_type->tt_member == NULL))
Bram Moolenaarb1e32ac2023-02-21 12:38:51 +00002033 {
Bram Moolenaarc750d912021-11-29 22:02:12 +00002034 lhs->lhs_member_type = &t_any;
Bram Moolenaarb1e32ac2023-02-21 12:38:51 +00002035 }
2036 else if (use_class)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002037 {
2038 // for an object or class member get the type of the member
Yegappan Lakshmananeb91e242023-08-31 18:10:46 +02002039 class_T *cl = lhs->lhs_type->tt_class;
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02002040 int is_object = lhs->lhs_type->tt_type == VAR_OBJECT;
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002041 char_u *name = var_start + lhs->lhs_varlen + 1;
2042 size_t namelen = lhs->lhs_end - var_start - lhs->lhs_varlen - 1;
Yegappan Lakshmananeb91e242023-08-31 18:10:46 +02002043
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002044 ocmember_T *m = member_lookup(cl, lhs->lhs_type->tt_type,
2045 name, namelen, &lhs->lhs_member_idx);
2046 if (m == NULL)
2047 {
2048 member_not_found_msg(cl, lhs->lhs_type->tt_type, name, namelen);
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02002049 return FAIL;
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002050 }
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02002051
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002052 if (IS_ENUM(cl))
2053 {
2054 if (!inside_class(cctx, cl))
2055 {
2056 semsg(_(e_enumvalue_str_cannot_be_modified),
2057 cl->class_name, m->ocm_name);
2058 return FALSE;
2059 }
2060 if (lhs->lhs_type->tt_type == VAR_OBJECT &&
2061 lhs->lhs_member_idx < 2)
2062 {
2063 char *msg = lhs->lhs_member_idx == 0 ?
2064 e_enum_str_name_cannot_be_modified :
2065 e_enum_str_ordinal_cannot_be_modified;
2066 semsg(_(msg), cl->class_name);
2067 return FALSE;
2068 }
2069 }
2070
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002071 // If it is private member variable, then accessing it outside the
2072 // class is not allowed.
2073 // If it is a read only class variable, then it can be modified
2074 // only inside the class where it is defined.
2075 if ((m->ocm_access != VIM_ACCESS_ALL) &&
2076 ((is_object && !inside_class(cctx, cl))
2077 || (!is_object && cctx->ctx_ufunc->uf_class != cl)))
2078 {
2079 char *msg = (m->ocm_access == VIM_ACCESS_PRIVATE)
Ernie Rael03042a22023-11-11 08:53:32 +01002080 ? e_cannot_access_protected_variable_str
2081 : e_variable_is_not_writable_str;
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002082 emsg_var_cl_define(msg, m->ocm_name, 0, cl);
Yegappan Lakshmananeb91e242023-08-31 18:10:46 +02002083 return FAIL;
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002084 }
2085
Yegappan Lakshmanane5437c52023-12-16 14:11:19 +01002086 if (!IS_CONSTRUCTOR_METHOD(cctx->ctx_ufunc)
2087 && oc_var_check_ro(cl, m))
2088 return FAIL;
2089
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002090 lhs->lhs_member_type = m->ocm_type;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002091 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01002092 else
Bram Moolenaarc750d912021-11-29 22:02:12 +00002093 lhs->lhs_member_type = lhs->lhs_type->tt_member;
Bram Moolenaar752fc692021-01-04 21:57:11 +01002094 }
2095 return OK;
2096}
2097
2098/*
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002099 * Figure out the LHS and check a few errors.
2100 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +00002101 int
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002102compile_assign_lhs(
Bram Moolenaar97f8c102022-04-02 19:43:57 +01002103 char_u *var_start,
2104 lhs_T *lhs,
2105 cmdidx_T cmdidx,
2106 int is_decl,
2107 int heredoc,
2108 int has_cmd, // "var" before "var_start"
2109 int oplen,
2110 cctx_T *cctx)
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002111{
Bram Moolenaar97f8c102022-04-02 19:43:57 +01002112 if (compile_lhs(var_start, lhs, cmdidx, heredoc, has_cmd, oplen, cctx)
2113 == FAIL)
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002114 return FAIL;
2115
2116 if (!lhs->lhs_has_index && lhs->lhs_lvar == &lhs->lhs_arg_lvar)
2117 {
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00002118 semsg(_(e_cannot_assign_to_argument_str), lhs->lhs_name);
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002119 return FAIL;
2120 }
2121 if (!is_decl && lhs->lhs_lvar != NULL
Bram Moolenaar6586a012022-09-30 11:04:50 +01002122 && lhs->lhs_lvar->lv_const != ASSIGN_VAR
2123 && !lhs->lhs_has_index)
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002124 {
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00002125 semsg(_(e_cannot_assign_to_constant_str), lhs->lhs_name);
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002126 return FAIL;
2127 }
2128 return OK;
2129}
2130
2131/*
Bram Moolenaar4f0884d2021-08-11 21:49:23 +02002132 * Return TRUE if "lhs" has a range index: "[expr : expr]".
2133 */
2134 static int
2135has_list_index(char_u *idx_start, cctx_T *cctx)
2136{
2137 char_u *p = idx_start;
2138 int save_skip;
2139
2140 if (*p != '[')
2141 return FALSE;
2142
2143 p = skipwhite(p + 1);
2144 if (*p == ':')
2145 return TRUE;
2146
2147 save_skip = cctx->ctx_skip;
2148 cctx->ctx_skip = SKIP_YES;
2149 (void)compile_expr0(&p, cctx);
2150 cctx->ctx_skip = save_skip;
2151 return *skipwhite(p) == ':';
2152}
2153
2154/*
Bram Moolenaare42939a2021-04-05 17:11:17 +02002155 * For an assignment with an index, compile the "idx" in "var[idx]" or "key" in
2156 * "var.key".
Bram Moolenaar752fc692021-01-04 21:57:11 +01002157 */
2158 static int
Bram Moolenaare42939a2021-04-05 17:11:17 +02002159compile_assign_index(
Bram Moolenaar752fc692021-01-04 21:57:11 +01002160 char_u *var_start,
2161 lhs_T *lhs,
Bram Moolenaare42939a2021-04-05 17:11:17 +02002162 int *range,
Bram Moolenaar752fc692021-01-04 21:57:11 +01002163 cctx_T *cctx)
2164{
Bram Moolenaar752fc692021-01-04 21:57:11 +01002165 size_t varlen = lhs->lhs_varlen;
Bram Moolenaare42939a2021-04-05 17:11:17 +02002166 char_u *p;
2167 int r = OK;
Bram Moolenaar68452172021-04-12 21:21:02 +02002168 int need_white_before = TRUE;
2169 int empty_second;
Bram Moolenaar752fc692021-01-04 21:57:11 +01002170
Bram Moolenaar752fc692021-01-04 21:57:11 +01002171 p = var_start + varlen;
2172 if (*p == '[')
2173 {
2174 p = skipwhite(p + 1);
Bram Moolenaar68452172021-04-12 21:21:02 +02002175 if (*p == ':')
2176 {
2177 // empty first index, push zero
2178 r = generate_PUSHNR(cctx, 0);
2179 need_white_before = FALSE;
2180 }
2181 else
2182 r = compile_expr0(&p, cctx);
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002183
2184 if (r == OK && *skipwhite(p) == ':')
2185 {
2186 // unlet var[idx : idx]
Bram Moolenaar68452172021-04-12 21:21:02 +02002187 // blob[idx : idx] = value
Bram Moolenaare42939a2021-04-05 17:11:17 +02002188 *range = TRUE;
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002189 p = skipwhite(p);
Bram Moolenaar68452172021-04-12 21:21:02 +02002190 empty_second = *skipwhite(p + 1) == ']';
2191 if ((need_white_before && !IS_WHITE_OR_NUL(p[-1]))
2192 || (!empty_second && !IS_WHITE_OR_NUL(p[1])))
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002193 {
2194 semsg(_(e_white_space_required_before_and_after_str_at_str),
2195 ":", p);
2196 return FAIL;
2197 }
2198 p = skipwhite(p + 1);
Bram Moolenaar68452172021-04-12 21:21:02 +02002199 if (*p == ']')
2200 // empty second index, push "none"
2201 r = generate_PUSHSPEC(cctx, VVAL_NONE);
2202 else
2203 r = compile_expr0(&p, cctx);
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002204 }
2205
Bram Moolenaar752fc692021-01-04 21:57:11 +01002206 if (r == OK && *skipwhite(p) != ']')
2207 {
2208 // this should not happen
Bram Moolenaare1242042021-12-16 20:56:57 +00002209 emsg(_(e_missing_closing_square_brace));
Bram Moolenaar752fc692021-01-04 21:57:11 +01002210 r = FAIL;
2211 }
2212 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002213 else if (lhs->lhs_member_idx >= 0)
2214 {
2215 // object member index
2216 r = generate_PUSHNR(cctx, lhs->lhs_member_idx);
2217 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01002218 else // if (*p == '.')
2219 {
2220 char_u *key_end = to_name_end(p + 1, TRUE);
2221 char_u *key = vim_strnsave(p + 1, key_end - p - 1);
2222
Zdenek Dohnal9fe17d42021-08-04 22:30:52 +02002223 r = generate_PUSHS(cctx, &key);
Bram Moolenaar752fc692021-01-04 21:57:11 +01002224 }
Bram Moolenaare42939a2021-04-05 17:11:17 +02002225 return r;
2226}
2227
2228/*
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002229 * For a LHS with an index, load the variable to be indexed.
2230 */
2231 static int
2232compile_load_lhs(
2233 lhs_T *lhs,
2234 char_u *var_start,
2235 type_T *rhs_type,
2236 cctx_T *cctx)
2237{
2238 if (lhs->lhs_dest == dest_expr)
2239 {
2240 size_t varlen = lhs->lhs_varlen;
2241 int c = var_start[varlen];
Bram Moolenaare97976b2021-08-01 13:17:17 +02002242 int lines_len = cctx->ctx_ufunc->uf_lines.ga_len;
Bram Moolenaare97976b2021-08-01 13:17:17 +02002243 int res;
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002244
Bram Moolenaare97976b2021-08-01 13:17:17 +02002245 // Evaluate "ll[expr]" of "ll[expr][idx]". End the line with a NUL and
2246 // limit the lines array length to avoid skipping to a following line.
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002247 var_start[varlen] = NUL;
Bram Moolenaare97976b2021-08-01 13:17:17 +02002248 cctx->ctx_ufunc->uf_lines.ga_len = cctx->ctx_lnum + 1;
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002249 char_u *p = var_start;
Bram Moolenaare97976b2021-08-01 13:17:17 +02002250 res = compile_expr0(&p, cctx);
2251 var_start[varlen] = c;
2252 cctx->ctx_ufunc->uf_lines.ga_len = lines_len;
2253 if (res == FAIL || p != var_start + varlen)
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002254 {
2255 // this should not happen
Bram Moolenaare97976b2021-08-01 13:17:17 +02002256 if (res != FAIL)
Bram Moolenaare1242042021-12-16 20:56:57 +00002257 emsg(_(e_missing_closing_square_brace));
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002258 return FAIL;
2259 }
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002260
Bram Moolenaar078a4612022-01-04 15:17:03 +00002261 lhs->lhs_type = cctx->ctx_type_stack.ga_len == 0 ? &t_void
2262 : get_type_on_stack(cctx, 0);
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02002263
2264 if (lhs->lhs_type->tt_type == VAR_OBJECT)
2265 {
2266 // Check whether the object variable is modifiable
2267 if (!lhs_class_member_modifiable(lhs, var_start, cctx))
2268 return FAIL;
2269 }
2270
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002271 // Now we can properly check the type. The variable is indexed, thus
2272 // we need the member type. For a class or object we don't know the
2273 // type yet, it depends on what member is used.
Yegappan Lakshmananc229a6a2023-10-26 23:05:07 +02002274 // The top item in the stack is the Dict, followed by the key and then
2275 // the type of the value.
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002276 vartype_T vartype = lhs->lhs_type->tt_type;
2277 type_T *member_type = lhs->lhs_type->tt_member;
2278 if (rhs_type != NULL && member_type != NULL
2279 && vartype != VAR_OBJECT && vartype != VAR_CLASS
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002280 && rhs_type != &t_void
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002281 && need_type(rhs_type, member_type, FALSE,
Yegappan Lakshmananc229a6a2023-10-26 23:05:07 +02002282 -3, 0, cctx, FALSE, FALSE) == FAIL)
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002283 return FAIL;
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02002284
2285 return OK;
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002286 }
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02002287
2288 return generate_loadvar(cctx, lhs);
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002289}
2290
2291/*
Bram Moolenaara369c3d2021-04-21 16:00:10 +02002292 * Produce code for loading "lhs" and also take care of an index.
2293 * Return OK/FAIL.
2294 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +00002295 int
Bram Moolenaara369c3d2021-04-21 16:00:10 +02002296compile_load_lhs_with_index(lhs_T *lhs, char_u *var_start, cctx_T *cctx)
2297{
Bram Moolenaar4cae8452023-01-15 15:51:48 +00002298 if (lhs->lhs_type->tt_type == VAR_OBJECT)
2299 {
Bram Moolenaar22363c62023-04-24 17:15:25 +01002300 // "this.value": load "this" object and get the value at index for an
2301 // object or class member get the type of the member.
2302 // Also for "obj.value".
Yegappan Lakshmananff6f0d52023-12-21 16:46:18 +01002303 char_u *dot = vim_strchr(var_start, '.');
2304 if (dot == NULL)
2305 {
2306 semsg(_(e_missing_dot_after_object_str), lhs->lhs_name);
2307 return FAIL;
2308 }
Bram Moolenaar22363c62023-04-24 17:15:25 +01002309
Yegappan Lakshmananeb91e242023-08-31 18:10:46 +02002310 class_T *cl = lhs->lhs_type->tt_class;
Yegappan Lakshmanan1ea42882023-10-11 21:43:52 +02002311 type_T *type = oc_member_type(cl, TRUE, dot + 1,
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02002312 lhs->lhs_end, &lhs->lhs_member_idx);
Bram Moolenaar4cae8452023-01-15 15:51:48 +00002313 if (lhs->lhs_member_idx < 0)
2314 return FAIL;
2315
Bram Moolenaar22363c62023-04-24 17:15:25 +01002316 if (dot - var_start == 4 && STRNCMP(var_start, "this", 4) == 0)
2317 {
2318 // load "this"
Yegappan Lakshmanand990bf02024-03-22 19:56:17 +01002319 lvar_T *lvar = lhs->lhs_lvar;
2320 int rc;
2321
2322 if (lvar->lv_from_outer > 0)
2323 rc = generate_LOADOUTER(cctx, lvar->lv_idx,
2324 lvar->lv_from_outer, lvar->lv_loop_depth,
2325 lvar->lv_loop_idx, type);
2326 else
2327 rc = generate_LOAD(cctx, ISN_LOAD, lvar->lv_idx, NULL, type);
2328
2329 if (rc == FAIL)
Bram Moolenaar22363c62023-04-24 17:15:25 +01002330 return FAIL;
2331 }
2332 else
2333 {
2334 // load object variable or argument
2335 if (compile_load_lhs(lhs, var_start, lhs->lhs_type, cctx) == FAIL)
2336 return FAIL;
2337 }
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002338 if (IS_INTERFACE(cl))
Yegappan Lakshmanan5a05d372023-09-29 19:43:11 +02002339 return generate_GET_ITF_MEMBER(cctx, cl, lhs->lhs_member_idx, type);
2340 return generate_GET_OBJ_MEMBER(cctx, lhs->lhs_member_idx, type);
Bram Moolenaar4cae8452023-01-15 15:51:48 +00002341 }
Yegappan Lakshmanan1ea42882023-10-11 21:43:52 +02002342 else if (lhs->lhs_type->tt_type == VAR_CLASS)
2343 {
2344 // "<classname>.value": load class variable "classname.value"
Yegappan Lakshmananff6f0d52023-12-21 16:46:18 +01002345 char_u *dot = vim_strchr(var_start, '.');
2346 if (dot == NULL)
2347 {
2348 check_type_is_value(lhs->lhs_type);
2349 return FAIL;
2350 }
Yegappan Lakshmanan1ea42882023-10-11 21:43:52 +02002351
2352 class_T *cl = lhs->lhs_type->tt_class;
2353 ocmember_T *m = class_member_lookup(cl, dot + 1,
2354 lhs->lhs_end - dot - 1,
2355 &lhs->lhs_member_idx);
2356 if (m == NULL)
2357 return FAIL;
2358
2359 return generate_CLASSMEMBER(cctx, TRUE, cl, lhs->lhs_member_idx);
2360 }
Bram Moolenaar4cae8452023-01-15 15:51:48 +00002361
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02002362 if (compile_load_lhs(lhs, var_start, NULL, cctx) == FAIL)
2363 return FAIL;
Bram Moolenaara369c3d2021-04-21 16:00:10 +02002364
2365 if (lhs->lhs_has_index)
2366 {
2367 int range = FALSE;
2368
2369 // Get member from list or dict. First compile the
2370 // index value.
2371 if (compile_assign_index(var_start, lhs, &range, cctx) == FAIL)
2372 return FAIL;
2373 if (range)
2374 {
2375 semsg(_(e_cannot_use_range_with_assignment_operator_str),
2376 var_start);
2377 return FAIL;
2378 }
2379
2380 // Get the member.
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02002381 if (compile_member(FALSE, NULL, cctx) == FAIL)
Bram Moolenaara369c3d2021-04-21 16:00:10 +02002382 return FAIL;
2383 }
2384 return OK;
2385}
2386
2387/*
Bram Moolenaare42939a2021-04-05 17:11:17 +02002388 * Assignment to a list or dict member, or ":unlet" for the item, using the
2389 * information in "lhs".
2390 * Returns OK or FAIL.
2391 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +00002392 int
Bram Moolenaare42939a2021-04-05 17:11:17 +02002393compile_assign_unlet(
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002394 char_u *var_start,
2395 lhs_T *lhs,
2396 int is_assign,
2397 type_T *rhs_type,
2398 cctx_T *cctx)
Bram Moolenaare42939a2021-04-05 17:11:17 +02002399{
Bram Moolenaare42939a2021-04-05 17:11:17 +02002400 vartype_T dest_type;
Bram Moolenaare42939a2021-04-05 17:11:17 +02002401 int range = FALSE;
2402
Bram Moolenaar68452172021-04-12 21:21:02 +02002403 if (compile_assign_index(var_start, lhs, &range, cctx) == FAIL)
Bram Moolenaar752fc692021-01-04 21:57:11 +01002404 return FAIL;
Bram Moolenaar4f0884d2021-08-11 21:49:23 +02002405 if (is_assign && range
2406 && lhs->lhs_type->tt_type != VAR_LIST
2407 && lhs->lhs_type != &t_blob
2408 && lhs->lhs_type != &t_any)
Bram Moolenaar68452172021-04-12 21:21:02 +02002409 {
2410 semsg(_(e_cannot_use_range_with_assignment_str), var_start);
2411 return FAIL;
2412 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01002413
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002414 if (lhs->lhs_type == NULL || lhs->lhs_type == &t_any)
Bram Moolenaar752fc692021-01-04 21:57:11 +01002415 {
2416 // Index on variable of unknown type: check at runtime.
2417 dest_type = VAR_ANY;
2418 }
2419 else
2420 {
2421 dest_type = lhs->lhs_type->tt_type;
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002422 if (dest_type == VAR_DICT && range)
2423 {
zeertzjq276410e2023-05-07 21:59:33 +01002424 emsg(_(e_cannot_use_range_with_dictionary));
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002425 return FAIL;
2426 }
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02002427 if (dest_type == VAR_DICT
Yegappan Lakshmananbce51d92024-04-15 19:19:52 +02002428 && may_generate_2STRING(-1, TOSTRING_NONE, cctx) == FAIL)
Bram Moolenaar752fc692021-01-04 21:57:11 +01002429 return FAIL;
Bram Moolenaar51e93322021-04-17 20:44:56 +02002430 if (dest_type == VAR_LIST || dest_type == VAR_BLOB)
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002431 {
Bram Moolenaar51e93322021-04-17 20:44:56 +02002432 type_T *type;
2433
2434 if (range)
2435 {
Bram Moolenaar078a4612022-01-04 15:17:03 +00002436 type = get_type_on_stack(cctx, 1);
Bram Moolenaarc6951a72022-12-29 20:56:24 +00002437 if (need_type(type, &t_number, FALSE,
Bram Moolenaar2995e5c2022-03-18 21:41:47 +00002438 -2, 0, cctx, FALSE, FALSE) == FAIL)
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002439 return FAIL;
Bram Moolenaar51e93322021-04-17 20:44:56 +02002440 }
Bram Moolenaar078a4612022-01-04 15:17:03 +00002441 type = get_type_on_stack(cctx, 0);
Bram Moolenaar53ba6ca2022-03-10 19:23:28 +00002442 if ((dest_type != VAR_BLOB && type->tt_type != VAR_SPECIAL)
Bram Moolenaarc6951a72022-12-29 20:56:24 +00002443 && need_type(type, &t_number, FALSE,
Bram Moolenaar51e93322021-04-17 20:44:56 +02002444 -1, 0, cctx, FALSE, FALSE) == FAIL)
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002445 return FAIL;
2446 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01002447 }
2448
Bram Moolenaar4875d6a2022-08-17 15:55:51 +01002449 if (cctx->ctx_skip == SKIP_YES)
2450 return OK;
2451
Bram Moolenaar22363c62023-04-24 17:15:25 +01002452 // Load the dict, list or object. On the stack we then have:
Bram Moolenaar752fc692021-01-04 21:57:11 +01002453 // - value (for assignment, not for :unlet)
2454 // - index
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002455 // - for [a : b] second index
Bram Moolenaar752fc692021-01-04 21:57:11 +01002456 // - variable
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002457 if (compile_load_lhs(lhs, var_start, rhs_type, cctx) == FAIL)
2458 return FAIL;
Bram Moolenaar752fc692021-01-04 21:57:11 +01002459
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002460 if (dest_type == VAR_LIST
2461 || dest_type == VAR_DICT
2462 || dest_type == VAR_BLOB
2463 || dest_type == VAR_CLASS
2464 || dest_type == VAR_OBJECT
2465 || dest_type == VAR_ANY)
Bram Moolenaar752fc692021-01-04 21:57:11 +01002466 {
2467 if (is_assign)
2468 {
Bram Moolenaar68452172021-04-12 21:21:02 +02002469 if (range)
2470 {
2471 if (generate_instr_drop(cctx, ISN_STORERANGE, 4) == NULL)
2472 return FAIL;
2473 }
2474 else
2475 {
2476 isn_T *isn = generate_instr_drop(cctx, ISN_STOREINDEX, 3);
Bram Moolenaar752fc692021-01-04 21:57:11 +01002477
Bram Moolenaar68452172021-04-12 21:21:02 +02002478 if (isn == NULL)
2479 return FAIL;
Bram Moolenaarf7d1c6e2023-01-16 20:47:57 +00002480 isn->isn_arg.storeindex.si_vartype = dest_type;
2481 isn->isn_arg.storeindex.si_class = NULL;
2482
2483 if (dest_type == VAR_OBJECT)
2484 {
Bram Moolenaarb1e32ac2023-02-21 12:38:51 +00002485 class_T *cl = lhs->lhs_type->tt_class;
Bram Moolenaarf7d1c6e2023-01-16 20:47:57 +00002486
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002487 if (IS_INTERFACE(cl))
Bram Moolenaarf7d1c6e2023-01-16 20:47:57 +00002488 {
2489 // "this.value": load "this" object and get the value
2490 // at index for an object or class member get the type
2491 // of the member
2492 isn->isn_arg.storeindex.si_class = cl;
2493 ++cl->class_refcount;
2494 }
2495 }
Bram Moolenaar68452172021-04-12 21:21:02 +02002496 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01002497 }
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002498 else if (range)
2499 {
2500 if (generate_instr_drop(cctx, ISN_UNLETRANGE, 3) == NULL)
2501 return FAIL;
2502 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01002503 else
2504 {
2505 if (generate_instr_drop(cctx, ISN_UNLETINDEX, 2) == NULL)
2506 return FAIL;
2507 }
2508 }
2509 else
2510 {
2511 emsg(_(e_indexable_type_required));
2512 return FAIL;
2513 }
2514
2515 return OK;
2516}
2517
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01002518/*
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00002519 * Generate an instruction to push the default value for "vartype".
2520 * if "dest_local" is TRUE then for some types no instruction is generated.
2521 * "skip_store" is set to TRUE if no PUSH instruction is generated.
2522 * Returns OK or FAIL.
2523 */
2524 static int
2525push_default_value(
2526 cctx_T *cctx,
2527 vartype_T vartype,
2528 int dest_is_local,
2529 int *skip_store)
2530{
2531 int r = OK;
2532
2533 switch (vartype)
2534 {
2535 case VAR_BOOL:
2536 r = generate_PUSHBOOL(cctx, VVAL_FALSE);
2537 break;
2538 case VAR_FLOAT:
2539 r = generate_PUSHF(cctx, 0.0);
2540 break;
2541 case VAR_STRING:
2542 r = generate_PUSHS(cctx, NULL);
2543 break;
2544 case VAR_BLOB:
2545 r = generate_PUSHBLOB(cctx, blob_alloc());
2546 break;
2547 case VAR_FUNC:
2548 r = generate_PUSHFUNC(cctx, NULL, &t_func_void, TRUE);
2549 break;
2550 case VAR_LIST:
2551 r = generate_NEWLIST(cctx, 0, FALSE);
2552 break;
2553 case VAR_DICT:
2554 r = generate_NEWDICT(cctx, 0, FALSE);
2555 break;
2556 case VAR_JOB:
2557 r = generate_PUSHJOB(cctx);
2558 break;
2559 case VAR_CHANNEL:
2560 r = generate_PUSHCHANNEL(cctx);
2561 break;
Ernie Rael5c018be2023-08-27 18:40:26 +02002562 case VAR_OBJECT:
2563 r = generate_PUSHOBJ(cctx);
2564 break;
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00002565 case VAR_NUMBER:
2566 case VAR_UNKNOWN:
2567 case VAR_ANY:
2568 case VAR_PARTIAL:
2569 case VAR_VOID:
2570 case VAR_INSTR:
2571 case VAR_CLASS:
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02002572 case VAR_TYPEALIAS:
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00002573 case VAR_SPECIAL: // cannot happen
2574 // This is skipped for local variables, they are always
2575 // initialized to zero. But in a "for" or "while" loop
2576 // the value may have been changed.
2577 if (dest_is_local && !inside_loop_scope(cctx))
2578 *skip_store = TRUE;
2579 else
2580 r = generate_PUSHNR(cctx, 0);
2581 break;
2582 }
2583 return r;
2584}
2585
2586/*
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002587 * Compile assignment context. Used when compiling an assignment statement.
2588 */
2589typedef struct cac_S cac_T;
2590struct cac_S
2591{
2592 cmdidx_T cac_cmdidx; // assignment command
2593 char_u *cac_nextc; // next character to parse
2594 lhs_T cac_lhs; // lhs of the assignment
2595 type_T *cac_rhs_type; // rhs type of an assignment
2596 char_u *cac_op; // assignment operator
2597 int cac_oplen; // assignment operator length
2598 char_u *cac_var_start; // start of the variable names
2599 char_u *cac_var_end; // end of the variable names
2600 int cac_var_count; // number of variables in assignment
2601 int cac_var_idx; // variable index in a list
2602 int cac_semicolon; // semicolon in [var1, var2; var3]
2603 garray_T *cac_instr;
2604 int cac_instr_count;
2605 int cac_incdec;
2606 int cac_did_generate_slice;
2607 int cac_is_decl;
2608 int cac_is_const;
2609 int cac_start_lnum;
2610 type_T *cac_inferred_type;
2611 int cac_skip_store;
2612};
2613
2614/*
2615 * Initialize the compile assignment context.
2616 */
2617 static void
2618compile_assign_context_init(cac_T *cac, cctx_T *cctx, int cmdidx, char_u *arg)
2619{
2620 CLEAR_FIELD(*cac);
2621 cac->cac_cmdidx = cmdidx;
2622 cac->cac_instr = &cctx->ctx_instr;
2623 cac->cac_rhs_type = &t_any;
2624 cac->cac_is_decl = is_decl_command(cmdidx);
2625 cac->cac_start_lnum = SOURCING_LNUM;
2626 cac->cac_instr_count = -1;
2627 cac->cac_var_end = arg;
2628}
2629
2630/*
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01002631 * Compile an object member variable assignment in the arguments passed to a
2632 * class new() method.
2633 *
2634 * Instruction format:
2635 *
2636 * ifargisset <n> this.<varname> = <value>
2637 *
2638 * where <n> is the index of the default argument.
2639 *
2640 * Generates the ISN_JUMP_IF_ARG_NOT_SET instruction to skip the assignment if
2641 * the value is passed as an argument to the new() method call.
2642 *
2643 * Returns OK on success.
2644 */
2645 static int
2646compile_assign_obj_new_arg(char_u **argp, cctx_T *cctx)
2647{
2648 char_u *arg = *argp;
2649
2650 arg += 11; // skip "ifargisset"
2651 int def_arg_idx = getdigits(&arg);
2652 arg = skipwhite(arg);
2653
2654 // Use a JUMP_IF_ARG_NOT_SET instruction to skip if the value was not
2655 // given and the default value is "v:none".
2656 int stack_offset = STACK_FRAME_SIZE +
2657 (cctx->ctx_ufunc->uf_va_name != NULL ? 1 : 0);
2658 int def_arg_count = cctx->ctx_ufunc->uf_def_args.ga_len;
2659 int arg_offset = def_arg_idx - def_arg_count - stack_offset;
2660
2661 if (generate_JUMP_IF_ARG(cctx, ISN_JUMP_IF_ARG_NOT_SET,
2662 arg_offset) == FAIL)
2663 return FAIL;
2664
2665 *argp = arg;
2666 return OK;
2667}
2668
2669/*
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002670 * Translate the increment (++) and decrement (--) operators to the
2671 * corresponding compound operators (+= or -=).
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01002672 *
2673 * Returns OK on success and FAIL on syntax error.
2674 */
2675 static int
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002676translate_incdec_op(exarg_T *eap, cac_T *cac)
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01002677{
2678 if (VIM_ISWHITE(eap->cmd[2]))
2679 {
2680 semsg(_(e_no_white_space_allowed_after_str_str),
2681 eap->cmdidx == CMD_increment ? "++" : "--", eap->cmd);
2682 return FAIL;
2683 }
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002684 cac->cac_op = (char_u *)(eap->cmdidx == CMD_increment ? "+=" : "-=");
2685 cac->cac_oplen = 2;
2686 cac->cac_incdec = TRUE;
2687
2688 return OK;
2689}
2690
2691/*
2692 * Process the operator in an assignment statement.
2693 */
2694 static int
2695compile_assign_process_operator(
2696 exarg_T *eap,
2697 char_u *arg,
2698 cac_T *cac,
2699 int *heredoc,
2700 char_u **retstr)
2701{
2702 *retstr = NULL;
2703
2704 if (eap->cmdidx == CMD_increment || eap->cmdidx == CMD_decrement)
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002705 // Change an unary operator to a compound operator
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01002706 return translate_incdec_op(eap, cac);
2707
2708 char_u *sp = cac->cac_nextc;
2709 cac->cac_nextc = skipwhite(cac->cac_nextc);
2710 cac->cac_op = cac->cac_nextc;
2711 cac->cac_oplen = assignment_len(cac->cac_nextc, heredoc);
2712
2713 if (cac->cac_var_count > 0 && cac->cac_oplen == 0)
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002714 {
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01002715 // can be something like "[1, 2]->func()"
2716 *retstr = arg;
2717 return FAIL;
2718 }
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002719
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01002720 // need white space before and after the operator
2721 if (cac->cac_oplen > 0 && (!VIM_ISWHITE(*sp)
2722 || !IS_WHITE_OR_NUL(cac->cac_op[cac->cac_oplen])))
2723 {
2724 error_white_both(cac->cac_op, cac->cac_oplen);
2725 return FAIL;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002726 }
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01002727
2728 return OK;
2729}
2730
2731/*
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01002732 * Find the start of an assignment statement.
2733 */
2734 static char_u *
2735compile_assign_compute_start(char_u *arg, int var_count)
2736{
2737 if (var_count > 0)
2738 // [var1, var2] = [val1, val2]
2739 // skip over the "["
2740 return skipwhite(arg + 1);
2741
2742 return arg;
2743}
2744
2745/*
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01002746 * Parse a heredoc assignment starting at "p". Returns a pointer to the
2747 * beginning of the heredoc content.
2748 */
2749 static char_u *
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002750parse_heredoc_assignment(exarg_T *eap, cctx_T *cctx, cac_T *cac)
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01002751{
2752 // [let] varname =<< [trim] {end}
2753 eap->ea_getline = exarg_getline;
2754 eap->cookie = cctx;
2755
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002756 list_T *l = heredoc_get(eap, cac->cac_nextc + 3, FALSE, TRUE);
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01002757 if (l == NULL)
2758 return NULL;
2759
2760 list_free(l);
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002761 cac->cac_nextc += STRLEN(cac->cac_nextc);
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01002762
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002763 return cac->cac_nextc;
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01002764}
2765
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002766/*
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01002767 * Check the type of a RHS expression in a list assignment statement.
2768 * The RHS expression is already compiled. So the type is on the stack.
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002769 */
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01002770 static int
2771compile_assign_list_check_rhs_type(cctx_T *cctx, cac_T *cac)
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01002772{
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002773 type_T *stacktype;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002774
2775 stacktype = cctx->ctx_type_stack.ga_len == 0 ? &t_void
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01002776 : get_type_on_stack(cctx, 0);
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002777 if (stacktype->tt_type == VAR_VOID)
2778 {
2779 emsg(_(e_cannot_use_void_value));
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01002780 return FAIL;
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01002781 }
2782
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002783 if (need_type(stacktype, &t_list_any, FALSE, -1, 0, cctx,
2784 FALSE, FALSE) == FAIL)
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01002785 return FAIL;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002786
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01002787 if (stacktype->tt_member != NULL)
2788 cac->cac_rhs_type = stacktype->tt_member;
2789
2790 return OK;
2791}
2792
2793/*
2794 * In a list assignment statement, if a constant list was used, check the
2795 * length. Returns OK if the length check succeeds. Returns FAIL otherwise.
2796 */
2797 static int
2798compile_assign_list_check_length(cctx_T *cctx, cac_T *cac)
2799{
2800 int needed_list_len;
2801 int did_check = FALSE;
2802
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002803 needed_list_len = cac->cac_semicolon
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01002804 ? cac->cac_var_count - 1
2805 : cac->cac_var_count;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002806 if (cac->cac_instr->ga_len > 0)
2807 {
2808 isn_T *isn = ((isn_T *)cac->cac_instr->ga_data) +
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01002809 cac->cac_instr->ga_len - 1;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002810
2811 if (isn->isn_type == ISN_NEWLIST)
2812 {
2813 did_check = TRUE;
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01002814 if (cac->cac_semicolon ?
2815 isn->isn_arg.number < needed_list_len
2816 : isn->isn_arg.number != needed_list_len)
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002817 {
2818 semsg(_(e_expected_nr_items_but_got_nr),
2819 needed_list_len, (int)isn->isn_arg.number);
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01002820 return FAIL;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002821 }
2822 }
2823 }
2824
2825 if (!did_check)
2826 generate_CHECKLEN(cctx, needed_list_len, cac->cac_semicolon);
2827
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01002828 return OK;
2829}
2830
2831/*
2832 * Evaluate the expression for "[var, var] = expr" assignment.
2833 * A line break may follow the assignment operator "=".
2834 */
2835 static char_u *
2836compile_assign_list_expr(cctx_T *cctx, cac_T *cac)
2837{
2838 char_u *whitep;
2839
2840 whitep = cac->cac_op + cac->cac_oplen;
2841
2842 if (may_get_next_line_error(whitep, &cac->cac_nextc, cctx) == FAIL)
2843 return NULL;
2844
2845 // compile RHS expression
2846 if (compile_expr0(&cac->cac_nextc, cctx) == FAIL)
2847 return NULL;
2848
2849 if (cctx->ctx_skip == SKIP_YES)
2850 // no need to parse more when skipping
2851 return cac->cac_nextc;
2852
2853 if (compile_assign_list_check_rhs_type(cctx, cac) == FAIL)
2854 return NULL;
2855
2856 // If a constant list was used we can check the length right here.
2857 if (compile_assign_list_check_length(cctx, cac) == FAIL)
2858 return FAIL;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002859
2860 return cac->cac_nextc;
2861}
2862
2863/*
2864 * Find and return the end of a heredoc or a list of variables assignment
2865 * statement. For a single variable assignment statement, returns the current
2866 * end.
2867 * Returns NULL on failure.
2868 */
2869 static char_u *
2870compile_assign_compute_end(
2871 exarg_T *eap,
2872 cctx_T *cctx,
2873 cac_T *cac,
2874 int heredoc)
2875{
2876 if (heredoc)
2877 {
2878 cac->cac_nextc = parse_heredoc_assignment(eap, cctx, cac);
2879 return cac->cac_nextc;
2880 }
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01002881
2882 if (cac->cac_var_count > 0)
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002883 {
2884 // for "[var, var] = expr" evaluate the expression. The list of
2885 // variables are processed later.
2886 // A line break may follow the "=".
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01002887 cac->cac_nextc = compile_assign_list_expr(cctx, cac);
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002888 return cac->cac_nextc;
2889 }
2890
2891 return cac->cac_var_end;
2892}
2893
2894/*
2895 * For "var = expr" evaluate the expression.
2896 */
2897 static int
2898compile_assign_single_eval_expr(cctx_T *cctx, cac_T *cac)
2899{
2900 int ret = OK;
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01002901 char_u *whitep;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002902 lhs_T *lhs = &cac->cac_lhs;
2903
2904 // Compile the expression.
2905 if (cac->cac_incdec)
2906 return generate_PUSHNR(cctx, 1);
2907
2908 // Temporarily hide the new local variable here, it is
2909 // not available to this expression.
2910 if (lhs->lhs_new_local)
2911 --cctx->ctx_locals.ga_len;
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01002912 whitep = cac->cac_op + cac->cac_oplen;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002913
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01002914 if (may_get_next_line_error(whitep, &cac->cac_nextc, cctx) == FAIL)
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002915 {
2916 if (lhs->lhs_new_local)
2917 ++cctx->ctx_locals.ga_len;
2918 return FAIL;
2919 }
2920
2921 ret = compile_expr0_ext(&cac->cac_nextc, cctx, &cac->cac_is_const);
2922 if (lhs->lhs_new_local)
2923 ++cctx->ctx_locals.ga_len;
2924
2925 return ret;
2926}
2927
2928/*
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01002929 * When compiling an assignment, set the LHS type to the RHS type.
2930 */
2931 static int
2932compile_assign_set_lhs_type_from_rhs(
2933 cctx_T *cctx,
2934 cac_T *cac,
2935 lhs_T *lhs,
2936 type_T *rhs_type)
2937{
2938 if (rhs_type->tt_type == VAR_VOID)
2939 {
2940 emsg(_(e_cannot_use_void_value));
2941 return FAIL;
2942 }
2943
2944 type_T *type;
2945
2946 // An empty list or dict has a &t_unknown member, for a variable that
2947 // implies &t_any.
2948 if (rhs_type == &t_list_empty)
2949 type = &t_list_any;
2950 else if (rhs_type == &t_dict_empty)
2951 type = &t_dict_any;
2952 else if (rhs_type == &t_unknown)
2953 type = &t_any;
2954 else
2955 {
2956 type = rhs_type;
2957 cac->cac_inferred_type = rhs_type;
2958 }
2959
2960 set_var_type(lhs->lhs_lvar, type, cctx);
2961
2962 return OK;
2963}
2964
2965/*
2966 * Returns TRUE if the "rhs_type" can be assigned to the "lhs" variable.
2967 * Used when compiling an assignment statement.
2968 */
2969 static int
2970compile_assign_valid_rhs_type(
2971 cctx_T *cctx,
2972 cac_T *cac,
2973 lhs_T *lhs,
2974 type_T *rhs_type)
2975{
2976 type_T *use_type = lhs->lhs_lvar->lv_type;
2977 where_T where = WHERE_INIT;
2978
2979 // Without operator check type here, otherwise below.
2980 // Use the line number of the assignment.
2981 SOURCING_LNUM = cac->cac_start_lnum;
2982 if (cac->cac_var_count > 0)
2983 {
2984 where.wt_index = cac->cac_var_idx + 1;
2985 where.wt_kind = WT_VARIABLE;
2986 }
2987
2988 // If assigning to a list or dict member, use the member type.
2989 // Not for "list[:] =".
2990 if (lhs->lhs_has_index &&
2991 !has_list_index(cac->cac_var_start + lhs->lhs_varlen, cctx))
2992 use_type = lhs->lhs_member_type;
2993
2994 if (need_type_where(rhs_type, use_type, FALSE, -1, where, cctx, FALSE,
2995 cac->cac_is_const) == FAIL)
2996 return FALSE;
2997
2998 return TRUE;
2999}
3000
3001/*
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003002 * Compare the LHS type with the RHS type in an assignment.
3003 */
3004 static int
3005compile_assign_check_type(cctx_T *cctx, cac_T *cac)
3006{
3007 lhs_T *lhs = &cac->cac_lhs;
3008 type_T *rhs_type;
3009
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003010 rhs_type = cctx->ctx_type_stack.ga_len == 0
3011 ? &t_void
3012 : get_type_on_stack(cctx, 0);
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003013 cac->cac_rhs_type = rhs_type;
3014
3015 if (check_type_is_value(rhs_type) == FAIL)
3016 return FAIL;
3017
3018 if (lhs->lhs_lvar != NULL && (cac->cac_is_decl || !lhs->lhs_has_type))
3019 {
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003020 if (rhs_type->tt_type == VAR_FUNC
3021 || rhs_type->tt_type == VAR_PARTIAL)
3022 {
3023 // Make sure the variable name can be used as a funcref
3024 if (!lhs->lhs_has_index
3025 && var_wrong_func_name(lhs->lhs_name, TRUE))
3026 return FAIL;
3027 }
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003028
3029 if (lhs->lhs_new_local && !lhs->lhs_has_type)
3030 {
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003031 // The LHS variable doesn't have a type. Set it to the RHS type.
3032 if (compile_assign_set_lhs_type_from_rhs(cctx, cac, lhs, rhs_type)
3033 == FAIL)
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003034 return FAIL;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003035 }
3036 else if (*cac->cac_op == '=')
3037 {
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003038 if (!compile_assign_valid_rhs_type(cctx, cac, lhs, rhs_type))
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003039 return FAIL;
3040 }
3041 }
3042 else
3043 {
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003044 // Assigning to a register using @r = "abc"
3045
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003046 type_T *lhs_type = lhs->lhs_member_type;
3047
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003048 // Special case: assigning to @# can use a number or a string.
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003049 // Also: can assign a number to a float.
3050 if ((lhs_type == &t_number_or_string || lhs_type == &t_float)
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003051 && rhs_type->tt_type == VAR_NUMBER)
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003052 lhs_type = &t_number;
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003053
3054 if (*cac->cac_nextc != '=')
3055 {
3056 if (need_type(rhs_type, lhs_type, FALSE, -1, 0, cctx, FALSE,
3057 FALSE) == FAIL)
3058 return FAIL;
3059 }
3060 }
3061
3062 return OK;
3063}
3064
3065/*
3066 * Compile the RHS expression in an assignment statement and generate the
3067 * instructions.
3068 */
3069 static int
3070compile_assign_rhs_expr(cctx_T *cctx, cac_T *cac)
3071{
3072 cac->cac_is_const = FALSE;
3073
3074 // for "+=", "*=", "..=" etc. first load the current value
3075 if (*cac->cac_op != '='
3076 && compile_load_lhs_with_index(&cac->cac_lhs, cac->cac_var_start,
3077 cctx) == FAIL)
3078 return FAIL;
3079
3080 // For "var = expr" evaluate the expression.
3081 if (cac->cac_var_count == 0)
3082 {
3083 int ret;
3084
3085 // Compile the expression.
3086 cac->cac_instr_count = cac->cac_instr->ga_len;
3087 ret = compile_assign_single_eval_expr(cctx, cac);
3088 if (ret == FAIL)
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003089 return FAIL;
3090 }
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003091 else if (cac->cac_semicolon && cac->cac_var_idx == cac->cac_var_count - 1)
3092 {
3093 // For "[var; var] = expr" get the rest of the list
3094 cac->cac_did_generate_slice = TRUE;
3095 if (generate_SLICE(cctx, cac->cac_var_count - 1) == FAIL)
3096 return FAIL;
3097 }
3098 else
3099 {
3100 // For "[var, var] = expr" get the "var_idx" item from the
3101 // list.
3102 int with_op = *cac->cac_op != '=';
3103 if (generate_GETITEM(cctx, cac->cac_var_idx, with_op) == FAIL)
3104 return FAIL;
3105 }
3106
3107 if (compile_assign_check_type(cctx, cac) == FAIL)
3108 return FAIL;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003109
3110 return OK;
3111}
3112
3113/*
3114 * Compile the RHS expression in an assignment
3115 */
3116 static int
3117compile_assign_rhs(cctx_T *cctx, cac_T *cac)
3118{
3119 lhs_T *lhs = &cac->cac_lhs;
3120
3121 if (cctx->ctx_skip == SKIP_YES)
3122 {
3123 if (cac->cac_oplen > 0 && cac->cac_var_count == 0)
3124 {
3125 // skip over the "=" and the expression
3126 cac->cac_nextc = skipwhite(cac->cac_op + cac->cac_oplen);
3127 (void)compile_expr0(&cac->cac_nextc, cctx);
3128 }
3129 return OK;
3130 }
3131
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003132 // If RHS is specified, then generate instructions for RHS expression
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003133 if (cac->cac_oplen > 0)
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003134 return compile_assign_rhs_expr(cctx, cac);
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003135
3136 if (cac->cac_cmdidx == CMD_final)
3137 {
3138 emsg(_(e_final_requires_a_value));
3139 return FAIL;
3140 }
3141
3142 if (cac->cac_cmdidx == CMD_const)
3143 {
3144 emsg(_(e_const_requires_a_value));
3145 return FAIL;
3146 }
3147
3148 if (!lhs->lhs_has_type || lhs->lhs_dest == dest_option
3149 || lhs->lhs_dest == dest_func_option)
3150 {
3151 emsg(_(e_type_or_initialization_required));
3152 return FAIL;
3153 }
3154
3155 // variables are always initialized
3156 if (GA_GROW_FAILS(cac->cac_instr, 1))
3157 return FAIL;
3158
3159 cac->cac_instr_count = cac->cac_instr->ga_len;
3160
3161 return push_default_value(cctx, lhs->lhs_member_type->tt_type,
3162 lhs->lhs_dest == dest_local,
3163 &cac->cac_skip_store);
3164}
3165
3166/*
3167 * Compile a compound op assignment statement (+=, -=, *=, %=, etc.)
3168 */
3169 static int
3170compile_assign_compound_op(cctx_T *cctx, cac_T *cac)
3171{
3172 lhs_T *lhs = &cac->cac_lhs;
3173 type_T *expected;
3174 type_T *stacktype = NULL;
3175
3176 if (*cac->cac_op == '.')
3177 {
3178 if (may_generate_2STRING(-1, TOSTRING_NONE, cctx) == FAIL)
3179 return FAIL;
3180 }
3181 else
3182 {
3183 expected = lhs->lhs_member_type;
3184 stacktype = get_type_on_stack(cctx, 0);
3185 if (
3186 // If variable is float operation with number is OK.
3187 !(expected == &t_float && (stacktype == &t_number
3188 || stacktype == &t_number_bool))
3189 && need_type(stacktype, expected, TRUE, -1, 0, cctx,
3190 FALSE, FALSE) == FAIL)
3191 return FAIL;
3192 }
3193
3194 if (*cac->cac_op == '.')
3195 {
3196 if (generate_CONCAT(cctx, 2) == FAIL)
3197 return FAIL;
3198 }
3199 else if (*cac->cac_op == '+')
3200 {
3201 if (generate_add_instr(cctx,
3202 operator_type(lhs->lhs_member_type, stacktype),
3203 lhs->lhs_member_type, stacktype,
3204 EXPR_APPEND) == FAIL)
3205 return FAIL;
3206 }
3207 else if (generate_two_op(cctx, cac->cac_op) == FAIL)
3208 return FAIL;
3209
3210 return OK;
3211}
3212
3213/*
3214 * Generate the STORE and SETTYPE instructions for an assignment statement.
3215 */
3216 static int
3217compile_assign_generate_store(cctx_T *cctx, cac_T *cac)
3218{
3219 lhs_T *lhs = &cac->cac_lhs;
3220 int save_lnum;
3221
3222 // Use the line number of the assignment for store instruction.
3223 save_lnum = cctx->ctx_lnum;
3224 cctx->ctx_lnum = cac->cac_start_lnum - 1;
3225
3226 if (lhs->lhs_has_index)
3227 {
3228 // Use the info in "lhs" to store the value at the index in the
3229 // list, dict or object.
3230 if (compile_assign_unlet(cac->cac_var_start, &cac->cac_lhs,
3231 TRUE, cac->cac_rhs_type, cctx) == FAIL)
3232 {
3233 cctx->ctx_lnum = save_lnum;
3234 return FAIL;
3235 }
3236 }
3237 else
3238 {
3239 if (cac->cac_is_decl && cac->cac_cmdidx == CMD_const &&
3240 (lhs->lhs_dest == dest_script
3241 || lhs->lhs_dest == dest_script_v9
3242 || lhs->lhs_dest == dest_global
3243 || lhs->lhs_dest == dest_local))
3244 // ":const var": lock the value, but not referenced variables
3245 generate_LOCKCONST(cctx);
3246
3247 type_T *inferred_type = cac->cac_inferred_type;
3248
3249 if ((lhs->lhs_type->tt_type == VAR_DICT
3250 || lhs->lhs_type->tt_type == VAR_LIST)
3251 && lhs->lhs_type->tt_member != NULL
3252 && lhs->lhs_type->tt_member != &t_any
3253 && lhs->lhs_type->tt_member != &t_unknown)
3254 // Set the type in the list or dict, so that it can be checked,
3255 // also in legacy script.
3256 generate_SETTYPE(cctx, lhs->lhs_type);
3257 else if (inferred_type != NULL
3258 && (inferred_type->tt_type == VAR_DICT
3259 || inferred_type->tt_type == VAR_LIST)
3260 && inferred_type->tt_member != NULL
3261 && inferred_type->tt_member != &t_unknown
3262 && inferred_type->tt_member != &t_any)
3263 // Set the type in the list or dict, so that it can be checked,
3264 // also in legacy script.
3265 generate_SETTYPE(cctx, inferred_type);
3266
3267 if (!cac->cac_skip_store &&
3268 generate_store_lhs(cctx, &cac->cac_lhs,
3269 cac->cac_instr_count,
3270 cac->cac_is_decl) == FAIL)
3271 {
3272 cctx->ctx_lnum = save_lnum;
3273 return FAIL;
3274 }
3275 }
3276
3277 cctx->ctx_lnum = save_lnum;
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003278
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003279 return OK;
3280}
3281
3282/*
3283 * Process the variable(s) in an assignment statement
3284 */
3285 static int
3286compile_assign_process_variables(
3287 cctx_T *cctx,
3288 cac_T *cac,
3289 int cmdidx,
3290 int heredoc,
3291 int has_cmd,
3292 int has_argisset_prefix,
3293 int jump_instr_idx)
3294{
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003295 /*
3296 * Loop over variables in "[var, var] = expr".
3297 * For "name = expr" and "var name: type" this is done only once.
3298 */
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003299 for (cac->cac_var_idx = 0; cac->cac_var_idx == 0 ||
3300 cac->cac_var_idx < cac->cac_var_count; cac->cac_var_idx++)
3301 {
3302 if (cac->cac_var_start[0] == '_'
3303 && !eval_isnamec(cac->cac_var_start[1]))
3304 {
3305 // Ignore underscore in "[a, _, b] = list".
3306 if (cac->cac_var_count > 0)
3307 {
3308 cac->cac_var_start = skipwhite(cac->cac_var_start + 2);
3309 continue;
3310 }
3311 emsg(_(e_cannot_use_underscore_here));
3312 return FAIL;
3313 }
3314 vim_free(cac->cac_lhs.lhs_name);
3315
3316 /*
3317 * Figure out the LHS type and other properties.
3318 */
3319 if (compile_assign_lhs(cac->cac_var_start, &cac->cac_lhs, cmdidx,
3320 cac->cac_is_decl, heredoc, has_cmd,
3321 cac->cac_oplen, cctx) == FAIL)
3322 return FAIL;
3323
3324 // Compile the RHS expression
3325 if (heredoc)
3326 {
3327 SOURCING_LNUM = cac->cac_start_lnum;
3328 if (cac->cac_lhs.lhs_has_type
3329 && need_type(&t_list_string, cac->cac_lhs.lhs_type,
3330 FALSE, -1, 0, cctx, FALSE, FALSE) == FAIL)
3331 return FAIL;
3332 }
3333 else
3334 {
3335 if (compile_assign_rhs(cctx, cac) == FAIL)
3336 return FAIL;
3337 if (cac->cac_var_count == 0)
3338 cac->cac_var_end = cac->cac_nextc;
3339 }
3340
3341 // no need to parse more when skipping
3342 if (cctx->ctx_skip == SKIP_YES)
3343 break;
3344
3345 if (cac->cac_oplen > 0 && *cac->cac_op != '=')
3346 {
3347 if (compile_assign_compound_op(cctx, cac) == FAIL)
3348 return FAIL;
3349 }
3350
3351 // generate the store instructions
3352 if (compile_assign_generate_store(cctx, cac) == FAIL)
3353 return FAIL;
3354
3355 if (cac->cac_var_idx + 1 < cac->cac_var_count)
3356 cac->cac_var_start = skipwhite(cac->cac_lhs.lhs_end + 1);
3357
3358 if (has_argisset_prefix)
3359 {
3360 // set instruction index in JUMP_IF_ARG_SET to here
3361 isn_T *isn = ((isn_T *)cac->cac_instr->ga_data) + jump_instr_idx;
3362 isn->isn_arg.jumparg.jump_where = cac->cac_instr->ga_len;
3363 }
3364 }
3365
3366 return OK;
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01003367}
3368
3369/*
Bram Moolenaar47a519a2020-06-14 23:05:10 +02003370 * Compile declaration and assignment:
Bram Moolenaar30fd8202020-09-26 15:09:30 +02003371 * "let name"
3372 * "var name = expr"
3373 * "final name = expr"
3374 * "const name = expr"
3375 * "name = expr"
3376 * "arg" points to "name".
Bram Moolenaarbdc0f1c2021-04-24 19:08:24 +02003377 * "++arg" and "--arg"
Bram Moolenaar47a519a2020-06-14 23:05:10 +02003378 * Return NULL for an error.
3379 * Return "arg" if it does not look like a variable list.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003380 */
3381 static char_u *
Bram Moolenaar65b0d162022-12-13 18:43:22 +00003382compile_assignment(
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003383 char_u *arg_start,
3384 exarg_T *eap,
3385 cmdidx_T cmdidx,
3386 cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003387{
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003388 cac_T cac;
Bram Moolenaar65b0d162022-12-13 18:43:22 +00003389 char_u *arg = arg_start;
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003390 char_u *retstr = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003391 int heredoc = FALSE;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003392 int jump_instr_idx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003393
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003394 compile_assign_context_init(&cac, cctx, cmdidx, arg);
3395
3396 jump_instr_idx = cac.cac_instr->ga_len;
3397
3398 // process object variable initialization in a new() constructor method
3399 int has_argisset_prefix = STRNCMP(arg, "ifargisset ", 11) == 0;
3400 if (has_argisset_prefix &&
3401 compile_assign_obj_new_arg(&arg, cctx) == FAIL)
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01003402 goto theend;
Bram Moolenaar65b0d162022-12-13 18:43:22 +00003403
Bram Moolenaare1d12112022-03-05 11:37:48 +00003404 // Skip over the "varname" or "[varname, varname]" to get to any "=".
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003405 cac.cac_nextc = skip_var_list(arg, TRUE, &cac.cac_var_count,
3406 &cac.cac_semicolon, TRUE);
3407 if (cac.cac_nextc == NULL)
Bram Moolenaar47a519a2020-06-14 23:05:10 +02003408 return *arg == '[' ? arg : NULL;
3409
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003410 if (compile_assign_process_operator(eap, arg, &cac, &heredoc,
3411 &retstr) == FAIL)
3412 return retstr;
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01003413
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003414 // Compute the start of the assignment
3415 cac.cac_var_start = compile_assign_compute_start(arg, cac.cac_var_count);
3416
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003417 // Compute the end of the assignment
3418 cac.cac_var_end = compile_assign_compute_end(eap, cctx, &cac, heredoc);
3419 if (cac.cac_var_end == NULL)
3420 return NULL;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02003421
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003422 int has_cmd = cac.cac_var_start > eap->cmd;
Bram Moolenaar752fc692021-01-04 21:57:11 +01003423
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003424 /* process the variable(s) */
3425 if (compile_assign_process_variables(cctx, &cac, cmdidx, heredoc,
3426 has_cmd, has_argisset_prefix,
3427 jump_instr_idx) == FAIL)
3428 goto theend;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02003429
Bram Moolenaar4d5dfe22021-06-26 13:59:29 +02003430 // For "[var, var] = expr" drop the "expr" value.
3431 // Also for "[var, var; _] = expr".
Yegappan Lakshmanane2038412024-12-14 19:59:24 +01003432 if (cctx->ctx_skip != SKIP_YES && cac.cac_var_count > 0 &&
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003433 (!cac.cac_semicolon || !cac.cac_did_generate_slice))
Bram Moolenaar9af78762020-06-16 11:34:42 +02003434 {
Bram Moolenaarec792292020-12-13 21:26:56 +01003435 if (generate_instr_drop(cctx, ISN_DROP, 1) == NULL)
Bram Moolenaar9af78762020-06-16 11:34:42 +02003436 goto theend;
3437 }
Bram Moolenaar47a519a2020-06-14 23:05:10 +02003438
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003439 retstr = skipwhite(cac.cac_var_end);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003440
3441theend:
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003442 vim_free(cac.cac_lhs.lhs_name);
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003443 return retstr;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003444}
3445
3446/*
Bram Moolenaar17126b12021-01-07 22:03:02 +01003447 * Check for an assignment at "eap->cmd", compile it if found.
3448 * Return NOTDONE if there is none, FAIL for failure, OK if done.
3449 */
3450 static int
3451may_compile_assignment(exarg_T *eap, char_u **line, cctx_T *cctx)
3452{
3453 char_u *pskip;
3454 char_u *p;
3455
3456 // Assuming the command starts with a variable or function name,
3457 // find what follows.
3458 // Skip over "var.member", "var[idx]" and the like.
3459 // Also "&opt = val", "$ENV = val" and "@r = val".
3460 pskip = (*eap->cmd == '&' || *eap->cmd == '$' || *eap->cmd == '@')
3461 ? eap->cmd + 1 : eap->cmd;
3462 p = to_name_end(pskip, TRUE);
3463 if (p > eap->cmd && *p != NUL)
3464 {
3465 char_u *var_end;
3466 int oplen;
3467 int heredoc;
3468
3469 if (eap->cmd[0] == '@')
3470 var_end = eap->cmd + 2;
3471 else
3472 var_end = find_name_end(pskip, NULL, NULL,
3473 FNE_CHECK_START | FNE_INCL_BR);
3474 oplen = assignment_len(skipwhite(var_end), &heredoc);
3475 if (oplen > 0)
3476 {
3477 size_t len = p - eap->cmd;
3478
3479 // Recognize an assignment if we recognize the variable
3480 // name:
Bram Moolenaar17126b12021-01-07 22:03:02 +01003481 // "&opt = expr"
3482 // "$ENV = expr"
3483 // "@r = expr"
Bram Moolenaar2e17fef2022-03-18 19:44:48 +00003484 // "g:var = expr"
3485 // "g:[key] = expr"
3486 // "local = expr" where "local" is a local var.
3487 // "script = expr" where "script" is a script-local var.
3488 // "import = expr" where "import" is an imported var
Bram Moolenaar17126b12021-01-07 22:03:02 +01003489 if (*eap->cmd == '&'
3490 || *eap->cmd == '$'
3491 || *eap->cmd == '@'
3492 || ((len) > 2 && eap->cmd[1] == ':')
Bram Moolenaar2e17fef2022-03-18 19:44:48 +00003493 || STRNCMP(eap->cmd, "g:[", 3) == 0
Bram Moolenaare0890d62021-02-17 14:52:14 +01003494 || variable_exists(eap->cmd, len, cctx))
Bram Moolenaar17126b12021-01-07 22:03:02 +01003495 {
3496 *line = compile_assignment(eap->cmd, eap, CMD_SIZE, cctx);
3497 if (*line == NULL || *line == eap->cmd)
3498 return FAIL;
3499 return OK;
3500 }
3501 }
3502 }
3503
Bram Moolenaar65b0d162022-12-13 18:43:22 +00003504 // might be "[var, var] = expr" or "ifargisset this.member = expr"
3505 if (*eap->cmd == '[' || STRNCMP(eap->cmd, "ifargisset ", 11) == 0)
Bram Moolenaar17126b12021-01-07 22:03:02 +01003506 {
Bram Moolenaar17126b12021-01-07 22:03:02 +01003507 *line = compile_assignment(eap->cmd, eap, CMD_SIZE, cctx);
3508 if (*line == NULL)
3509 return FAIL;
3510 if (*line != eap->cmd)
3511 return OK;
3512 }
3513 return NOTDONE;
3514}
3515
Bram Moolenaar9a015112021-12-31 14:06:45 +00003516/*
3517 * Check if arguments of "ufunc" shadow variables in "cctx".
3518 * Return OK or FAIL.
3519 */
3520 static int
3521check_args_shadowing(ufunc_T *ufunc, cctx_T *cctx)
3522{
3523 int i;
3524 char_u *arg;
3525 int r = OK;
3526
3527 // Make sure arguments are not found when compiling a second time.
3528 ufunc->uf_args_visible = 0;
3529
3530 // Check for arguments shadowing variables from the context.
3531 for (i = 0; i < ufunc->uf_args.ga_len; ++i)
3532 {
3533 arg = ((char_u **)(ufunc->uf_args.ga_data))[i];
Bram Moolenaardce24412022-02-08 20:35:30 +00003534 if (check_defined(arg, STRLEN(arg), cctx, NULL, TRUE) == FAIL)
Bram Moolenaar9a015112021-12-31 14:06:45 +00003535 {
3536 r = FAIL;
3537 break;
3538 }
3539 }
3540 ufunc->uf_args_visible = ufunc->uf_args.ga_len;
3541 return r;
3542}
3543
Bram Moolenaarfcb86b02022-10-07 22:46:24 +01003544#ifdef HAS_MESSAGE_WINDOW
Bram Moolenaar139575d2022-03-15 19:29:30 +00003545/*
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003546 * Get a count before a command. Can only be a number.
3547 * Returns zero if there is no count.
3548 * Returns -1 if there is something wrong.
3549 */
3550 static long
3551get_cmd_count(char_u *line, exarg_T *eap)
3552{
3553 char_u *p;
3554
3555 // skip over colons and white space
3556 for (p = line; *p == ':' || VIM_ISWHITE(*p); ++p)
3557 ;
Keith Thompson184f71c2024-01-04 21:19:04 +01003558 if (!SAFE_isdigit(*p))
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003559 {
Bram Moolenaar2435adf2022-10-21 12:05:46 +01003560 // The command or modifiers must be following. Assume a lower case
3561 // character means there is a modifier.
3562 if (p < eap->cmd && !vim_islower(*p))
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003563 {
3564 emsg(_(e_invalid_range));
3565 return -1;
3566 }
3567 return 0;
3568 }
3569 return atol((char *)p);
3570}
Bram Moolenaarfcb86b02022-10-07 22:46:24 +01003571#endif
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003572
3573/*
Bram Moolenaar139575d2022-03-15 19:29:30 +00003574 * Get the compilation type that should be used for "ufunc".
3575 * Keep in sync with INSTRUCTIONS().
3576 */
3577 compiletype_T
3578get_compile_type(ufunc_T *ufunc)
3579{
3580 // Update uf_has_breakpoint if needed.
3581 update_has_breakpoint(ufunc);
3582
3583 if (debug_break_level > 0 || may_break_in_function(ufunc))
3584 return CT_DEBUG;
3585#ifdef FEAT_PROFILE
3586 if (do_profiling == PROF_YES)
3587 {
Ernie Rael21d32122023-09-02 15:09:18 +02003588 if (!ufunc->uf_profiling && has_profiling(FALSE, ufunc->uf_name, NULL,
3589 &ufunc->uf_hash))
Bram Moolenaar139575d2022-03-15 19:29:30 +00003590 func_do_profile(ufunc);
3591 if (ufunc->uf_profiling)
3592 return CT_PROFILE;
3593 }
3594#endif
3595 return CT_NONE;
3596}
3597
Bram Moolenaar7b829262021-10-13 15:04:34 +01003598
3599/*
Bram Moolenaar09689a02020-05-09 22:50:08 +02003600 * Add a function to the list of :def functions.
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003601 * This sets "ufunc->uf_dfunc_idx" but the function isn't compiled yet.
Bram Moolenaar09689a02020-05-09 22:50:08 +02003602 */
Bram Moolenaar822ba242020-05-24 23:00:18 +02003603 static int
Bram Moolenaar09689a02020-05-09 22:50:08 +02003604add_def_function(ufunc_T *ufunc)
3605{
3606 dfunc_T *dfunc;
3607
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003608 if (def_functions.ga_len == 0)
3609 {
3610 // The first position is not used, so that a zero uf_dfunc_idx means it
3611 // wasn't set.
Bram Moolenaar35578162021-08-02 19:10:38 +02003612 if (GA_GROW_FAILS(&def_functions, 1))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003613 return FAIL;
3614 ++def_functions.ga_len;
3615 }
3616
Bram Moolenaar09689a02020-05-09 22:50:08 +02003617 // Add the function to "def_functions".
Bram Moolenaar35578162021-08-02 19:10:38 +02003618 if (GA_GROW_FAILS(&def_functions, 1))
Bram Moolenaar09689a02020-05-09 22:50:08 +02003619 return FAIL;
3620 dfunc = ((dfunc_T *)def_functions.ga_data) + def_functions.ga_len;
3621 CLEAR_POINTER(dfunc);
3622 dfunc->df_idx = def_functions.ga_len;
3623 ufunc->uf_dfunc_idx = dfunc->df_idx;
3624 dfunc->df_ufunc = ufunc;
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01003625 dfunc->df_name = vim_strsave(ufunc->uf_name);
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02003626 ga_init2(&dfunc->df_var_names, sizeof(char_u *), 10);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01003627 ++dfunc->df_refcount;
Bram Moolenaar09689a02020-05-09 22:50:08 +02003628 ++def_functions.ga_len;
3629 return OK;
3630}
3631
3632/*
Yegappan Lakshmananf6c1fb22024-04-25 21:30:56 +02003633 * For an object constructor, generate instruction to setup "this" (the first
3634 * local variable) and to initialize the object variables.
3635 */
3636 static int
3637obj_constructor_prologue(ufunc_T *ufunc, cctx_T *cctx)
3638{
3639 generate_CONSTRUCT(cctx, ufunc->uf_class);
3640
3641 for (int i = 0; i < ufunc->uf_class->class_obj_member_count; ++i)
3642 {
3643 ocmember_T *m = &ufunc->uf_class->class_obj_members[i];
3644
3645 if (i < 2 && IS_ENUM(ufunc->uf_class))
3646 // The first two object variables in an enum are the name
3647 // and the ordinal. These are set by the ISN_CONSTRUCT
3648 // instruction. So don't generate instructions to set
3649 // these variables.
3650 continue;
3651
3652 if (m->ocm_init != NULL)
3653 {
3654 char_u *expr = m->ocm_init;
3655
3656 if (compile_expr0(&expr, cctx) == FAIL)
3657 return FAIL;
3658
3659 if (!ends_excmd2(m->ocm_init, expr))
3660 {
3661 semsg(_(e_trailing_characters_str), expr);
3662 return FAIL;
3663 }
3664
3665 type_T *type = get_type_on_stack(cctx, 0);
3666 if (m->ocm_type->tt_type == VAR_ANY
3667 && !(m->ocm_flags & OCMFLAG_HAS_TYPE)
3668 && type->tt_type != VAR_SPECIAL)
3669 {
3670 // If the member variable type is not yet set, then use
3671 // the initialization expression type.
3672 m->ocm_type = type;
3673 }
LemonBoyf4af3312024-07-04 13:43:12 +02003674 else
Yegappan Lakshmananf6c1fb22024-04-25 21:30:56 +02003675 {
3676 // The type of the member initialization expression is
3677 // determined at run time. Add a runtime type check.
3678 where_T where = WHERE_INIT;
3679 where.wt_kind = WT_MEMBER;
3680 where.wt_func_name = (char *)m->ocm_name;
3681 if (need_type_where(type, m->ocm_type, FALSE, -1,
3682 where, cctx, FALSE, FALSE) == FAIL)
3683 return FAIL;
3684 }
3685 }
3686 else
3687 push_default_value(cctx, m->ocm_type->tt_type, FALSE, NULL);
3688
LemonBoyf4af3312024-07-04 13:43:12 +02003689 if ((m->ocm_type->tt_type == VAR_DICT
3690 || m->ocm_type->tt_type == VAR_LIST)
3691 && m->ocm_type->tt_member != NULL
3692 && m->ocm_type->tt_member != &t_any
3693 && m->ocm_type->tt_member != &t_unknown)
3694 // Set the type in the list or dict, so that it can be checked,
3695 // also in legacy script.
3696 generate_SETTYPE(cctx, m->ocm_type);
3697
Yegappan Lakshmananf6c1fb22024-04-25 21:30:56 +02003698 generate_STORE_THIS(cctx, i);
3699 }
3700
3701 return OK;
3702}
3703
3704/*
3705 * For an object method and an constructor, generate instruction to setup
3706 * "this" (the first local variable). For a constructor, generate instructions
3707 * to initialize the object variables.
3708 */
3709 static int
3710obj_method_prologue(ufunc_T *ufunc, cctx_T *cctx)
3711{
3712 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data) + ufunc->uf_dfunc_idx;
3713
3714 if (GA_GROW_FAILS(&dfunc->df_var_names, 1))
3715 return FAIL;
3716
3717 ((char_u **)dfunc->df_var_names.ga_data)[0] =
3718 vim_strsave((char_u *)"this");
3719 ++dfunc->df_var_names.ga_len;
3720
3721 // In the constructor allocate memory for the object and initialize the
3722 // object members.
3723 if (IS_CONSTRUCTOR_METHOD(ufunc))
3724 return obj_constructor_prologue(ufunc, cctx);
3725
3726 return OK;
3727}
3728
3729/*
3730 * Produce instructions for the default values of optional arguments.
3731 */
3732 static int
3733compile_def_function_default_args(
3734 ufunc_T *ufunc,
3735 cctx_T *cctx,
3736 garray_T *instr)
3737{
3738 int count = ufunc->uf_def_args.ga_len;
3739 int first_def_arg = ufunc->uf_args.ga_len - count;
3740 int i;
3741 int off = STACK_FRAME_SIZE + (ufunc->uf_va_name != NULL ? 1 : 0);
3742 int did_set_arg_type = FALSE;
3743
3744 // Produce instructions for the default values of optional arguments.
3745 SOURCING_LNUM = 0; // line number unknown
3746 for (i = 0; i < count; ++i)
3747 {
3748 char_u *arg = ((char_u **)(ufunc->uf_def_args.ga_data))[i];
3749 if (STRCMP(arg, "v:none") == 0)
3750 // "arg = v:none" means the argument is optional without
3751 // setting a value when the argument is missing.
3752 continue;
3753
3754 type_T *val_type;
3755 int arg_idx = first_def_arg + i;
3756 where_T where = WHERE_INIT;
3757 int jump_instr_idx = instr->ga_len;
3758 isn_T *isn;
3759
3760 // Use a JUMP_IF_ARG_SET instruction to skip if the value was given.
3761 if (generate_JUMP_IF_ARG(cctx, ISN_JUMP_IF_ARG_SET,
3762 i - count - off) == FAIL)
3763 return FAIL;
3764
3765 // Make sure later arguments are not found.
3766 ufunc->uf_args_visible = arg_idx;
3767
3768 int r = compile_expr0(&arg, cctx);
3769 if (r == FAIL)
3770 return FAIL;
3771
3772 // If no type specified use the type of the default value.
3773 // Otherwise check that the default value type matches the
3774 // specified type.
3775 val_type = get_type_on_stack(cctx, 0);
3776 where.wt_index = arg_idx + 1;
3777 where.wt_kind = WT_ARGUMENT;
3778 if (ufunc->uf_arg_types[arg_idx] == &t_unknown)
3779 {
3780 did_set_arg_type = TRUE;
3781 ufunc->uf_arg_types[arg_idx] = val_type;
3782 }
3783 else if (need_type_where(val_type, ufunc->uf_arg_types[arg_idx],
3784 FALSE, -1, where, cctx, FALSE, FALSE) == FAIL)
3785 return FAIL;
3786
3787 if (generate_STORE(cctx, ISN_STORE, i - count - off, NULL) == FAIL)
3788 return FAIL;
3789
3790 // set instruction index in JUMP_IF_ARG_SET to here
3791 isn = ((isn_T *)instr->ga_data) + jump_instr_idx;
3792 isn->isn_arg.jumparg.jump_where = instr->ga_len;
3793 }
3794
3795 if (did_set_arg_type)
3796 set_function_type(ufunc);
3797
3798 return OK;
3799}
3800
3801/*
Yegappan Lakshmanana16f2512024-04-23 20:14:46 +02003802 * Compile def function body. Loop over all the lines in the function and
3803 * generate instructions.
3804 */
3805 static int
3806compile_def_function_body(
3807 cctx_T *cctx,
3808 int last_func_lnum,
3809 int check_return_type,
3810 garray_T *lines_to_free,
3811 char **errormsg)
3812{
3813 char_u *line = NULL;
3814 char_u *p;
3815 int did_emsg_before = did_emsg;
3816#ifdef FEAT_PROFILE
3817 int prof_lnum = -1;
3818#endif
3819 int debug_lnum = -1;
3820
3821 for (;;)
3822 {
3823 exarg_T ea;
3824 int starts_with_colon = FALSE;
3825 char_u *cmd;
3826 cmdmod_T local_cmdmod;
3827
3828 // Bail out on the first error to avoid a flood of errors and report
3829 // the right line number when inside try/catch.
3830 if (did_emsg_before != did_emsg)
3831 return FAIL;
3832
3833 if (line != NULL && *line == '|')
3834 // the line continues after a '|'
3835 ++line;
3836 else if (line != NULL && *skipwhite(line) != NUL
3837 && !(*line == '#' && (line == cctx->ctx_line_start
3838 || VIM_ISWHITE(line[-1]))))
3839 {
3840 semsg(_(e_trailing_characters_str), line);
3841 return FAIL;
3842 }
3843 else if (line != NULL && vim9_bad_comment(skipwhite(line)))
3844 return FAIL;
3845 else
3846 {
3847 line = next_line_from_context(cctx, FALSE);
3848 if (cctx->ctx_lnum >= last_func_lnum)
3849 {
3850 // beyond the last line
3851#ifdef FEAT_PROFILE
3852 if (cctx->ctx_skip != SKIP_YES)
3853 may_generate_prof_end(cctx, prof_lnum);
3854#endif
3855 break;
3856 }
3857 // Make a copy, splitting off nextcmd and removing trailing spaces
3858 // may change it.
3859 if (line != NULL)
3860 {
3861 line = vim_strsave(line);
3862 if (ga_add_string(lines_to_free, line) == FAIL)
3863 return FAIL;
3864 }
3865 }
3866
3867 CLEAR_FIELD(ea);
3868 ea.cmdlinep = &line;
3869 ea.cmd = skipwhite(line);
3870 ea.skip = cctx->ctx_skip == SKIP_YES;
3871
3872 if (*ea.cmd == '#')
3873 {
3874 // "#" starts a comment, but "#{" is an error
3875 if (vim9_bad_comment(ea.cmd))
3876 return FAIL;
3877 line = (char_u *)"";
3878 continue;
3879 }
3880
3881#ifdef FEAT_PROFILE
3882 if (cctx->ctx_compile_type == CT_PROFILE && cctx->ctx_lnum != prof_lnum
3883 && cctx->ctx_skip != SKIP_YES)
3884 {
3885 may_generate_prof_end(cctx, prof_lnum);
3886
3887 prof_lnum = cctx->ctx_lnum;
3888 generate_instr(cctx, ISN_PROF_START);
3889 }
3890#endif
3891 if (cctx->ctx_compile_type == CT_DEBUG && cctx->ctx_lnum != debug_lnum
3892 && cctx->ctx_skip != SKIP_YES)
3893 {
3894 debug_lnum = cctx->ctx_lnum;
3895 generate_instr_debug(cctx);
3896 }
3897 cctx->ctx_prev_lnum = cctx->ctx_lnum + 1;
3898
3899 // Some things can be recognized by the first character.
3900 switch (*ea.cmd)
3901 {
3902 case '}':
3903 {
3904 // "}" ends a block scope
3905 scopetype_T stype = cctx->ctx_scope == NULL
3906 ? NO_SCOPE : cctx->ctx_scope->se_type;
3907
3908 if (stype == BLOCK_SCOPE)
3909 {
3910 compile_endblock(cctx);
3911 line = ea.cmd;
3912 }
3913 else
3914 {
3915 emsg(_(e_using_rcurly_outside_if_block_scope));
3916 return FAIL;
3917 }
3918 if (line != NULL)
3919 line = skipwhite(ea.cmd + 1);
3920 continue;
3921 }
3922
3923 case '{':
3924 // "{" starts a block scope
3925 // "{'a': 1}->func() is something else
3926 if (ends_excmd(*skipwhite(ea.cmd + 1)))
3927 {
3928 line = compile_block(ea.cmd, cctx);
3929 continue;
3930 }
3931 break;
3932 }
3933
3934 /*
3935 * COMMAND MODIFIERS
3936 */
3937 cctx->ctx_has_cmdmod = FALSE;
3938 if (parse_command_modifiers(&ea, errormsg, &local_cmdmod, FALSE)
3939 == FAIL)
3940 return FAIL;
3941 generate_cmdmods(cctx, &local_cmdmod);
3942 undo_cmdmod(&local_cmdmod);
3943
3944 // Check if there was a colon after the last command modifier or before
3945 // the current position.
3946 for (p = ea.cmd; p >= line; --p)
3947 {
3948 if (*p == ':')
3949 starts_with_colon = TRUE;
3950 if (p < ea.cmd && !VIM_ISWHITE(*p))
3951 break;
3952 }
3953
3954 // Skip ":call" to get to the function name, unless using :legacy
3955 p = ea.cmd;
3956 if (!(local_cmdmod.cmod_flags & CMOD_LEGACY))
3957 {
3958 if (checkforcmd(&ea.cmd, "call", 3))
3959 {
3960 if (*ea.cmd == '(')
3961 // not for "call()"
3962 ea.cmd = p;
3963 else
3964 ea.cmd = skipwhite(ea.cmd);
3965 }
3966
3967 if (!starts_with_colon)
3968 {
3969 int assign;
3970
3971 // Check for assignment after command modifiers.
3972 assign = may_compile_assignment(&ea, &line, cctx);
3973 if (assign == OK)
3974 goto nextline;
3975 if (assign == FAIL)
3976 return FAIL;
3977 }
3978 }
3979
3980 /*
3981 * COMMAND after range
3982 * 'text'->func() should not be confused with 'a mark
3983 * 0z1234->func() should not be confused with a zero line number
3984 * "++nr" and "--nr" are eval commands
3985 * in "$ENV->func()" the "$" is not a range
3986 * "123->func()" is a method call
3987 */
3988 cmd = ea.cmd;
3989 if ((*cmd != '$' || starts_with_colon)
3990 && (starts_with_colon
3991 || !(*cmd == '\''
3992 || (cmd[0] == '0' && cmd[1] == 'z')
3993 || (cmd[0] != NUL && cmd[0] == cmd[1]
3994 && (*cmd == '+' || *cmd == '-'))
3995 || number_method(cmd))))
3996 {
3997 ea.cmd = skip_range(ea.cmd, TRUE, NULL);
3998 if (ea.cmd > cmd)
3999 {
4000 if (!starts_with_colon
4001 && !(local_cmdmod.cmod_flags & CMOD_LEGACY))
4002 {
4003 semsg(_(e_colon_required_before_range_str), cmd);
4004 return FAIL;
4005 }
4006 ea.addr_count = 1;
4007 if (ends_excmd2(line, ea.cmd))
4008 {
4009 // A range without a command: jump to the line.
4010 generate_EXEC(cctx, ISN_EXECRANGE,
4011 vim_strnsave(cmd, ea.cmd - cmd));
4012 line = ea.cmd;
4013 goto nextline;
4014 }
4015 }
4016 }
4017 p = find_ex_command(&ea, NULL,
4018 starts_with_colon || (local_cmdmod.cmod_flags & CMOD_LEGACY)
4019 ? NULL : item_exists, cctx);
4020
4021 if (p == NULL)
4022 {
4023 if (cctx->ctx_skip != SKIP_YES)
4024 semsg(_(e_ambiguous_use_of_user_defined_command_str), ea.cmd);
4025 return FAIL;
4026 }
4027
4028 // When using ":legacy cmd" always use compile_exec().
4029 if (local_cmdmod.cmod_flags & CMOD_LEGACY)
4030 {
4031 char_u *start = ea.cmd;
4032
4033 switch (ea.cmdidx)
4034 {
4035 case CMD_if:
4036 case CMD_elseif:
4037 case CMD_else:
4038 case CMD_endif:
4039 case CMD_for:
4040 case CMD_endfor:
4041 case CMD_continue:
4042 case CMD_break:
4043 case CMD_while:
4044 case CMD_endwhile:
4045 case CMD_try:
4046 case CMD_catch:
4047 case CMD_finally:
4048 case CMD_endtry:
4049 semsg(_(e_cannot_use_legacy_with_command_str), ea.cmd);
4050 return FAIL;
4051 default: break;
4052 }
4053
4054 // ":legacy return expr" needs to be handled differently.
4055 if (checkforcmd(&start, "return", 4))
4056 ea.cmdidx = CMD_return;
4057 else
4058 ea.cmdidx = CMD_legacy;
4059 }
4060
4061 if (p == ea.cmd && ea.cmdidx != CMD_SIZE)
4062 {
4063 // "eval" is used for "val->func()" and "var" for "var = val", then
4064 // "p" is equal to "ea.cmd" for a valid command.
4065 if (ea.cmdidx == CMD_eval || ea.cmdidx == CMD_var)
4066 ;
4067 else if (cctx->ctx_skip == SKIP_YES)
4068 {
4069 line += STRLEN(line);
4070 goto nextline;
4071 }
4072 else
4073 {
4074 semsg(_(e_command_not_recognized_str), ea.cmd);
4075 return FAIL;
4076 }
4077 }
4078
4079 if ((cctx->ctx_had_return || cctx->ctx_had_throw)
4080 && ea.cmdidx != CMD_elseif
4081 && ea.cmdidx != CMD_else
4082 && ea.cmdidx != CMD_endif
4083 && ea.cmdidx != CMD_endfor
4084 && ea.cmdidx != CMD_endwhile
4085 && ea.cmdidx != CMD_catch
4086 && ea.cmdidx != CMD_finally
4087 && ea.cmdidx != CMD_endtry
4088 && !ignore_unreachable_code_for_testing)
4089 {
4090 semsg(_(e_unreachable_code_after_str),
4091 cctx->ctx_had_return ? "return" : "throw");
4092 return FAIL;
4093 }
4094 cctx->ctx_had_throw = FALSE;
4095
4096 p = skipwhite(p);
4097 if (ea.cmdidx != CMD_SIZE
4098 && ea.cmdidx != CMD_write && ea.cmdidx != CMD_read)
4099 {
4100 if (ea.cmdidx >= 0)
4101 ea.argt = excmd_get_argt(ea.cmdidx);
4102 if ((ea.argt & EX_BANG) && *p == '!')
4103 {
4104 ea.forceit = TRUE;
4105 p = skipwhite(p + 1);
4106 }
4107 if ((ea.argt & EX_RANGE) == 0 && ea.addr_count > 0)
4108 {
4109 emsg(_(e_no_range_allowed));
4110 return FAIL;
4111 }
4112 }
4113
4114 switch (ea.cmdidx)
4115 {
4116 case CMD_def:
4117 case CMD_function:
4118 ea.arg = p;
4119 line = compile_nested_function(&ea, cctx, lines_to_free);
4120 break;
4121
4122 case CMD_return:
4123 line = compile_return(p, check_return_type,
4124 local_cmdmod.cmod_flags & CMOD_LEGACY, cctx);
4125 cctx->ctx_had_return = TRUE;
4126 break;
4127
4128 case CMD_let:
4129 emsg(_(e_cannot_use_let_in_vim9_script));
4130 break;
4131 case CMD_var:
4132 case CMD_final:
4133 case CMD_const:
4134 case CMD_increment:
4135 case CMD_decrement:
4136 line = compile_assignment(p, &ea, ea.cmdidx, cctx);
4137 if (line == p)
4138 {
4139 emsg(_(e_invalid_assignment));
4140 line = NULL;
4141 }
4142 break;
4143
4144 case CMD_unlet:
4145 case CMD_unlockvar:
4146 case CMD_lockvar:
4147 line = compile_unletlock(p, &ea, cctx);
4148 break;
4149
4150 case CMD_import:
4151 emsg(_(e_import_can_only_be_used_in_script));
4152 line = NULL;
4153 break;
4154
4155 case CMD_if:
4156 line = compile_if(p, cctx);
4157 break;
4158 case CMD_elseif:
4159 line = compile_elseif(p, cctx);
4160 cctx->ctx_had_return = FALSE;
4161 break;
4162 case CMD_else:
4163 line = compile_else(p, cctx);
4164 cctx->ctx_had_return = FALSE;
4165 break;
4166 case CMD_endif:
4167 line = compile_endif(p, cctx);
4168 break;
4169
4170 case CMD_while:
4171 line = compile_while(p, cctx);
4172 break;
4173 case CMD_endwhile:
4174 line = compile_endwhile(p, cctx);
4175 cctx->ctx_had_return = FALSE;
4176 break;
4177
4178 case CMD_for:
4179 line = compile_for(p, cctx);
4180 break;
4181 case CMD_endfor:
4182 line = compile_endfor(p, cctx);
4183 cctx->ctx_had_return = FALSE;
4184 break;
4185 case CMD_continue:
4186 line = compile_continue(p, cctx);
4187 break;
4188 case CMD_break:
4189 line = compile_break(p, cctx);
4190 break;
4191
4192 case CMD_try:
4193 line = compile_try(p, cctx);
4194 break;
4195 case CMD_catch:
4196 line = compile_catch(p, cctx);
4197 cctx->ctx_had_return = FALSE;
4198 break;
4199 case CMD_finally:
4200 line = compile_finally(p, cctx);
4201 cctx->ctx_had_return = FALSE;
4202 break;
4203 case CMD_endtry:
4204 line = compile_endtry(p, cctx);
4205 break;
4206 case CMD_throw:
4207 line = compile_throw(p, cctx);
4208 cctx->ctx_had_throw = TRUE;
4209 break;
4210
4211 case CMD_eval:
4212 line = compile_eval(p, cctx);
4213 break;
4214
4215 case CMD_defer:
4216 line = compile_defer(p, cctx);
4217 break;
4218
4219#ifdef HAS_MESSAGE_WINDOW
4220 case CMD_echowindow:
4221 {
4222 long cmd_count = get_cmd_count(line, &ea);
4223 if (cmd_count < 0)
4224 line = NULL;
4225 else
4226 line = compile_mult_expr(p, ea.cmdidx,
4227 cmd_count, cctx);
4228 }
4229 break;
4230#endif
4231 case CMD_echo:
4232 case CMD_echon:
4233 case CMD_echoconsole:
4234 case CMD_echoerr:
4235 case CMD_echomsg:
4236 case CMD_execute:
4237 line = compile_mult_expr(p, ea.cmdidx, 0, cctx);
4238 break;
4239
4240 case CMD_put:
4241 ea.cmd = cmd;
4242 line = compile_put(p, &ea, cctx);
4243 break;
4244
4245 case CMD_substitute:
4246 if (check_global_and_subst(ea.cmd, p) == FAIL)
4247 return FAIL;
4248 if (cctx->ctx_skip == SKIP_YES)
4249 line = (char_u *)"";
4250 else
4251 {
4252 ea.arg = p;
4253 line = compile_substitute(line, &ea, cctx);
4254 }
4255 break;
4256
4257 case CMD_redir:
4258 ea.arg = p;
4259 line = compile_redir(line, &ea, cctx);
4260 break;
4261
4262 case CMD_cexpr:
4263 case CMD_lexpr:
4264 case CMD_caddexpr:
4265 case CMD_laddexpr:
4266 case CMD_cgetexpr:
4267 case CMD_lgetexpr:
4268#ifdef FEAT_QUICKFIX
4269 ea.arg = p;
4270 line = compile_cexpr(line, &ea, cctx);
4271#else
4272 ex_ni(&ea);
4273 line = NULL;
4274#endif
4275 break;
4276
4277 case CMD_append:
4278 case CMD_change:
4279 case CMD_insert:
4280 case CMD_k:
4281 case CMD_t:
4282 case CMD_xit:
4283 not_in_vim9(&ea);
4284 return FAIL;
4285
4286 case CMD_SIZE:
4287 if (cctx->ctx_skip != SKIP_YES)
4288 {
4289 semsg(_(e_invalid_command_str), ea.cmd);
4290 return FAIL;
4291 }
4292 // We don't check for a next command here.
4293 line = (char_u *)"";
4294 break;
4295
4296 case CMD_lua:
4297 case CMD_mzscheme:
4298 case CMD_perl:
4299 case CMD_py3:
4300 case CMD_python3:
4301 case CMD_python:
4302 case CMD_pythonx:
4303 case CMD_ruby:
4304 case CMD_tcl:
4305 ea.arg = p;
4306 if (vim_strchr(line, '\n') == NULL)
4307 line = compile_exec(line, &ea, cctx);
4308 else
4309 // heredoc lines have been concatenated with NL
4310 // characters in get_function_body()
4311 line = compile_script(line, cctx);
4312 break;
4313
4314 case CMD_vim9script:
4315 if (cctx->ctx_skip != SKIP_YES)
4316 {
4317 emsg(_(e_vim9script_can_only_be_used_in_script));
4318 return FAIL;
4319 }
4320 line = (char_u *)"";
4321 break;
4322
4323 case CMD_class:
4324 emsg(_(e_class_can_only_be_used_in_script));
4325 return FAIL;
4326
4327 case CMD_type:
4328 emsg(_(e_type_can_only_be_used_in_script));
4329 return FAIL;
4330
4331 case CMD_global:
4332 if (check_global_and_subst(ea.cmd, p) == FAIL)
4333 return FAIL;
4334 // FALLTHROUGH
4335 default:
4336 // Not recognized, execute with do_cmdline_cmd().
4337 ea.arg = p;
4338 line = compile_exec(line, &ea, cctx);
4339 break;
4340 }
4341nextline:
4342 if (line == NULL)
4343 return FAIL;
4344 line = skipwhite(line);
4345
4346 // Undo any command modifiers.
4347 generate_undo_cmdmods(cctx);
4348
4349 if (cctx->ctx_type_stack.ga_len < 0)
4350 {
4351 iemsg("Type stack underflow");
4352 return FAIL;
4353 }
4354 } // END of the loop over all the function body lines.
4355
4356 return OK;
4357}
4358
4359/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004360 * After ex_function() has collected all the function lines: parse and compile
4361 * the lines into instructions.
4362 * Adds the function to "def_functions".
Bram Moolenaar9e68c322020-12-25 12:38:04 +01004363 * When "check_return_type" is set then set ufunc->uf_ret_type to the type of
4364 * the return statement (used for lambda). When uf_ret_type is already set
4365 * then check that it matches.
Bram Moolenaarb2049902021-01-24 12:53:53 +01004366 * When "profiling" is true add ISN_PROF_START instructions.
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +02004367 * "outer_cctx" is set for a nested function.
Bram Moolenaar05afcee2020-03-31 23:32:31 +02004368 * This can be used recursively through compile_lambda(), which may reallocate
4369 * "def_functions".
Bram Moolenaar822ba242020-05-24 23:00:18 +02004370 * Returns OK or FAIL.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004371 */
Bram Moolenaar822ba242020-05-24 23:00:18 +02004372 int
Bram Moolenaarb2049902021-01-24 12:53:53 +01004373compile_def_function(
Bram Moolenaare99d4222021-06-13 14:01:26 +02004374 ufunc_T *ufunc,
4375 int check_return_type,
4376 compiletype_T compile_type,
4377 cctx_T *outer_cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004378{
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004379 garray_T lines_to_free;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004380 char *errormsg = NULL; // error message
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004381 cctx_T cctx;
4382 garray_T *instr;
Bram Moolenaard66960b2020-10-30 20:46:26 +01004383 int did_emsg_before = did_emsg;
Bram Moolenaar599410c2021-04-10 14:03:43 +02004384 int did_emsg_silent_before = did_emsg_silent;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004385 int ret = FAIL;
4386 sctx_T save_current_sctx = current_sctx;
Bram Moolenaarf4e8cdd2020-10-12 22:07:13 +02004387 int save_estack_compiling = estack_compiling;
Bram Moolenaardc4c2302021-04-25 13:54:42 +02004388 int save_cmod_flags = cmdmod.cmod_flags;
Bram Moolenaar25e0f582020-05-25 22:36:50 +02004389 int do_estack_push;
Bram Moolenaar6c4bfe42020-07-23 18:26:30 +02004390 int new_def_function = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004391
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004392 // allocated lines are freed at the end
4393 ga_init2(&lines_to_free, sizeof(char_u *), 50);
4394
Bram Moolenaar25e0f582020-05-25 22:36:50 +02004395 // When using a function that was compiled before: Free old instructions.
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004396 // The index is reused. Otherwise add a new entry in "def_functions".
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004397 if (ufunc->uf_dfunc_idx > 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004398 {
Bram Moolenaar09689a02020-05-09 22:50:08 +02004399 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
4400 + ufunc->uf_dfunc_idx;
Bram Moolenaar3b814af2021-06-15 10:22:17 +02004401 isn_T *instr_dest = NULL;
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02004402
4403 switch (compile_type)
4404 {
4405 case CT_PROFILE:
4406#ifdef FEAT_PROFILE
4407 instr_dest = dfunc->df_instr_prof; break;
4408#endif
4409 case CT_NONE: instr_dest = dfunc->df_instr; break;
4410 case CT_DEBUG: instr_dest = dfunc->df_instr_debug; break;
4411 }
4412 if (instr_dest != NULL)
4413 // Was compiled in this mode before: Free old instructions.
4414 delete_def_function_contents(dfunc, FALSE);
4415 ga_clear_strings(&dfunc->df_var_names);
Bram Moolenaar1d84f762022-09-03 21:35:53 +01004416 dfunc->df_defer_var_idx = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004417 }
Bram Moolenaar6c4bfe42020-07-23 18:26:30 +02004418 else
4419 {
4420 if (add_def_function(ufunc) == FAIL)
4421 return FAIL;
4422 new_def_function = TRUE;
4423 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004424
Bram Moolenaar96923b72022-03-15 15:57:04 +00004425 if ((ufunc->uf_flags & FC_CLOSURE) && outer_cctx == NULL)
4426 {
4427 semsg(_(e_compiling_closure_without_context_str),
4428 printable_func_name(ufunc));
4429 return FAIL;
4430 }
4431
Bram Moolenaar985116a2020-07-12 17:31:09 +02004432 ufunc->uf_def_status = UF_COMPILING;
4433
Bram Moolenaara80faa82020-04-12 19:37:17 +02004434 CLEAR_FIELD(cctx);
Bram Moolenaarb2049902021-01-24 12:53:53 +01004435
Bram Moolenaare99d4222021-06-13 14:01:26 +02004436 cctx.ctx_compile_type = compile_type;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004437 cctx.ctx_ufunc = ufunc;
4438 cctx.ctx_lnum = -1;
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +02004439 cctx.ctx_outer = outer_cctx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004440 ga_init2(&cctx.ctx_locals, sizeof(lvar_T), 10);
Bram Moolenaar078a4612022-01-04 15:17:03 +00004441 // Each entry on the type stack consists of two type pointers.
4442 ga_init2(&cctx.ctx_type_stack, sizeof(type2_T), 50);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004443 cctx.ctx_type_list = &ufunc->uf_type_list;
4444 ga_init2(&cctx.ctx_instr, sizeof(isn_T), 50);
4445 instr = &cctx.ctx_instr;
4446
Bram Moolenaar25e0f582020-05-25 22:36:50 +02004447 // Set the context to the function, it may be compiled when called from
4448 // another script. Set the script version to the most modern one.
4449 // The line number will be set in next_line_from_context().
4450 current_sctx = ufunc->uf_script_ctx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004451 current_sctx.sc_version = SCRIPT_VERSION_VIM9;
4452
Bram Moolenaardc4c2302021-04-25 13:54:42 +02004453 // Don't use the flag from ":legacy" here.
4454 cmdmod.cmod_flags &= ~CMOD_LEGACY;
4455
Bram Moolenaar25e0f582020-05-25 22:36:50 +02004456 // Make sure error messages are OK.
4457 do_estack_push = !estack_top_is_ufunc(ufunc, 1);
4458 if (do_estack_push)
4459 estack_push_ufunc(ufunc, 1);
Bram Moolenaarf4e8cdd2020-10-12 22:07:13 +02004460 estack_compiling = TRUE;
Bram Moolenaar25e0f582020-05-25 22:36:50 +02004461
Bram Moolenaar9a015112021-12-31 14:06:45 +00004462 if (check_args_shadowing(ufunc, &cctx) == FAIL)
4463 goto erret;
4464
Yegappan Lakshmananf6c1fb22024-04-25 21:30:56 +02004465 // For an object method and a constructor generate instructions to
4466 // initialize "this" and the object variables.
Bram Moolenaar574950d2023-01-03 19:08:50 +00004467 if (ufunc->uf_flags & (FC_OBJECT|FC_NEW))
Yegappan Lakshmananf6c1fb22024-04-25 21:30:56 +02004468 if (obj_method_prologue(ufunc, &cctx) == FAIL)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004469 goto erret;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004470
Bram Moolenaar170fcfc2020-02-06 17:51:35 +01004471 if (ufunc->uf_def_args.ga_len > 0)
Yegappan Lakshmananf6c1fb22024-04-25 21:30:56 +02004472 if (compile_def_function_default_args(ufunc, &cctx, instr) == FAIL)
4473 goto erret;
Bram Moolenaare28d9b32021-07-03 18:56:53 +02004474 ufunc->uf_args_visible = ufunc->uf_args.ga_len;
Bram Moolenaar170fcfc2020-02-06 17:51:35 +01004475
Bram Moolenaarb8bebd02023-01-30 20:24:23 +00004476 // Compiling a function in an interface is done to get the function type.
Christian Brabandtded16772024-08-14 22:52:03 +02004477 // No code is actually compiled.
4478 if (ufunc->uf_class != NULL && IS_INTERFACE(ufunc->uf_class))
Bram Moolenaarb8bebd02023-01-30 20:24:23 +00004479 {
4480 ufunc->uf_def_status = UF_NOT_COMPILED;
4481 ret = OK;
4482 goto erret;
4483 }
4484
Yegappan Lakshmananf6c1fb22024-04-25 21:30:56 +02004485 // compile the function body
Yegappan Lakshmanana16f2512024-04-23 20:14:46 +02004486 if (compile_def_function_body(&cctx, ufunc->uf_lines.ga_len,
4487 check_return_type, &lines_to_free, &errormsg) == FAIL)
4488 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004489
4490 if (cctx.ctx_scope != NULL)
4491 {
4492 if (cctx.ctx_scope->se_type == IF_SCOPE)
Bram Moolenaar1a992222021-12-31 17:25:48 +00004493 emsg(_(e_missing_endif));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004494 else if (cctx.ctx_scope->se_type == WHILE_SCOPE)
Bram Moolenaar1a992222021-12-31 17:25:48 +00004495 emsg(_(e_missing_endwhile));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004496 else if (cctx.ctx_scope->se_type == FOR_SCOPE)
Bram Moolenaar1a992222021-12-31 17:25:48 +00004497 emsg(_(e_missing_endfor));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004498 else
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004499 emsg(_(e_missing_rcurly));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004500 goto erret;
4501 }
4502
Bram Moolenaara2c00282023-05-14 22:05:15 +01004503 // TODO: if a function ends in "throw" but there was a return elsewhere we
4504 // should not assume the return type is "void".
4505 if (!cctx.ctx_had_return && !cctx.ctx_had_throw)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004506 {
Bram Moolenaare6174fd2021-06-12 18:30:56 +02004507 if (ufunc->uf_ret_type->tt_type == VAR_UNKNOWN)
4508 ufunc->uf_ret_type = &t_void;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004509 else if (ufunc->uf_ret_type->tt_type != VAR_VOID
Yegappan Lakshmanan1db15142023-09-19 20:34:05 +02004510 && !IS_CONSTRUCTOR_METHOD(ufunc))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004511 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004512 emsg(_(e_missing_return_statement));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004513 goto erret;
4514 }
4515
Bram Moolenaarf57b43c2021-06-15 22:13:27 +02004516 // Return void if there is no return at the end.
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004517 // For a constructor return the object.
Yegappan Lakshmanan1db15142023-09-19 20:34:05 +02004518 if (IS_CONSTRUCTOR_METHOD(ufunc))
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00004519 {
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004520 generate_instr(&cctx, ISN_RETURN_OBJECT);
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00004521 ufunc->uf_ret_type = &ufunc->uf_class->class_object_type;
4522 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004523 else
4524 generate_instr(&cctx, ISN_RETURN_VOID);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004525 }
4526
Bram Moolenaar599410c2021-04-10 14:03:43 +02004527 // When compiled with ":silent!" and there was an error don't consider the
4528 // function compiled.
4529 if (emsg_silent == 0 || did_emsg_silent == did_emsg_silent_before)
Bram Moolenaar05afcee2020-03-31 23:32:31 +02004530 {
4531 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
4532 + ufunc->uf_dfunc_idx;
4533 dfunc->df_deleted = FALSE;
Bram Moolenaar4aab88d2020-12-24 21:56:41 +01004534 dfunc->df_script_seq = current_sctx.sc_seq;
Bram Moolenaarf002a412021-01-24 13:34:18 +01004535#ifdef FEAT_PROFILE
Bram Moolenaare99d4222021-06-13 14:01:26 +02004536 if (cctx.ctx_compile_type == CT_PROFILE)
Bram Moolenaarb2049902021-01-24 12:53:53 +01004537 {
4538 dfunc->df_instr_prof = instr->ga_data;
4539 dfunc->df_instr_prof_count = instr->ga_len;
4540 }
4541 else
Bram Moolenaarf002a412021-01-24 13:34:18 +01004542#endif
Bram Moolenaare99d4222021-06-13 14:01:26 +02004543 if (cctx.ctx_compile_type == CT_DEBUG)
4544 {
4545 dfunc->df_instr_debug = instr->ga_data;
4546 dfunc->df_instr_debug_count = instr->ga_len;
4547 }
4548 else
Bram Moolenaarb2049902021-01-24 12:53:53 +01004549 {
4550 dfunc->df_instr = instr->ga_data;
4551 dfunc->df_instr_count = instr->ga_len;
4552 }
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02004553 dfunc->df_varcount = dfunc->df_var_names.ga_len;
Bram Moolenaar148ce7a2020-09-23 21:57:23 +02004554 dfunc->df_has_closure = cctx.ctx_has_closure;
Bram Moolenaarb46c0832022-09-15 17:19:37 +01004555
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +02004556 if (cctx.ctx_outer_used)
Bram Moolenaarb46c0832022-09-15 17:19:37 +01004557 {
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +02004558 ufunc->uf_flags |= FC_CLOSURE;
Bram Moolenaarb46c0832022-09-15 17:19:37 +01004559 if (outer_cctx != NULL)
4560 ++outer_cctx->ctx_closure_count;
4561 }
4562
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004563 ufunc->uf_def_status = UF_COMPILED;
Bram Moolenaar05afcee2020-03-31 23:32:31 +02004564 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004565
4566 ret = OK;
4567
4568erret:
Bram Moolenaar599410c2021-04-10 14:03:43 +02004569 if (ufunc->uf_def_status == UF_COMPILING)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004570 {
Bram Moolenaar05afcee2020-03-31 23:32:31 +02004571 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
4572 + ufunc->uf_dfunc_idx;
Bram Moolenaar20431c92020-03-20 18:39:46 +01004573
Bram Moolenaarcaf1a2f2021-06-15 11:27:21 +02004574 // Compiling aborted, free the generated instructions.
Bram Moolenaar8238f082021-04-20 21:10:48 +02004575 clear_instr_ga(instr);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01004576 VIM_CLEAR(dfunc->df_name);
Bram Moolenaarcaf1a2f2021-06-15 11:27:21 +02004577 ga_clear_strings(&dfunc->df_var_names);
Bram Moolenaar20431c92020-03-20 18:39:46 +01004578
Bram Moolenaar6c4bfe42020-07-23 18:26:30 +02004579 // If using the last entry in the table and it was added above, we
4580 // might as well remove it.
4581 if (!dfunc->df_deleted && new_def_function
Bram Moolenaar45a15082020-05-25 00:28:33 +02004582 && ufunc->uf_dfunc_idx == def_functions.ga_len - 1)
Bram Moolenaar6c4bfe42020-07-23 18:26:30 +02004583 {
Bram Moolenaar20431c92020-03-20 18:39:46 +01004584 --def_functions.ga_len;
Bram Moolenaar6c4bfe42020-07-23 18:26:30 +02004585 ufunc->uf_dfunc_idx = 0;
4586 }
Bram Moolenaar701cc6c2021-04-10 13:33:48 +02004587 ufunc->uf_def_status = UF_COMPILE_ERROR;
Bram Moolenaar20431c92020-03-20 18:39:46 +01004588
Bram Moolenaar3cca2992020-04-02 22:57:36 +02004589 while (cctx.ctx_scope != NULL)
4590 drop_scope(&cctx);
4591
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004592 if (errormsg != NULL)
4593 emsg(errormsg);
Bram Moolenaard66960b2020-10-30 20:46:26 +01004594 else if (did_emsg == did_emsg_before)
Bram Moolenaare13bdec2020-10-16 23:16:47 +02004595 emsg(_(e_compiling_def_function_failed));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004596 }
4597
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004598 if (cctx.ctx_redir_lhs.lhs_name != NULL)
4599 {
4600 if (ret == OK)
4601 {
4602 emsg(_(e_missing_redir_end));
4603 ret = FAIL;
4604 }
4605 vim_free(cctx.ctx_redir_lhs.lhs_name);
Bram Moolenaar753bcf82021-04-21 14:24:24 +02004606 vim_free(cctx.ctx_redir_lhs.lhs_whole);
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004607 }
4608
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004609 current_sctx = save_current_sctx;
Bram Moolenaarf4e8cdd2020-10-12 22:07:13 +02004610 estack_compiling = save_estack_compiling;
Bram Moolenaardc4c2302021-04-25 13:54:42 +02004611 cmdmod.cmod_flags = save_cmod_flags;
Bram Moolenaar25e0f582020-05-25 22:36:50 +02004612 if (do_estack_push)
4613 estack_pop();
4614
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004615 ga_clear_strings(&lines_to_free);
Bram Moolenaarb84a3812020-05-01 15:44:29 +02004616 free_locals(&cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004617 ga_clear(&cctx.ctx_type_stack);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004618 return ret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004619}
4620
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004621 void
4622set_function_type(ufunc_T *ufunc)
4623{
4624 int varargs = ufunc->uf_va_name != NULL;
4625 int argcount = ufunc->uf_args.ga_len;
4626
4627 // Create a type for the function, with the return type and any
4628 // argument types.
4629 // A vararg is included in uf_args.ga_len but not in uf_arg_types.
4630 // The type is included in "tt_args".
4631 if (argcount > 0 || varargs)
4632 {
Bram Moolenaar18062fc2021-03-05 21:35:47 +01004633 if (ufunc->uf_type_list.ga_itemsize == 0)
4634 ga_init2(&ufunc->uf_type_list, sizeof(type_T *), 10);
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004635 ufunc->uf_func_type = alloc_func_type(ufunc->uf_ret_type,
4636 argcount, &ufunc->uf_type_list);
4637 // Add argument types to the function type.
4638 if (func_type_add_arg_types(ufunc->uf_func_type,
4639 argcount + varargs,
4640 &ufunc->uf_type_list) == FAIL)
4641 return;
4642 ufunc->uf_func_type->tt_argcount = argcount + varargs;
4643 ufunc->uf_func_type->tt_min_argcount =
4644 argcount - ufunc->uf_def_args.ga_len;
4645 if (ufunc->uf_arg_types == NULL)
4646 {
4647 int i;
4648
4649 // lambda does not have argument types.
4650 for (i = 0; i < argcount; ++i)
4651 ufunc->uf_func_type->tt_args[i] = &t_any;
4652 }
4653 else
4654 mch_memmove(ufunc->uf_func_type->tt_args,
4655 ufunc->uf_arg_types, sizeof(type_T *) * argcount);
4656 if (varargs)
4657 {
4658 ufunc->uf_func_type->tt_args[argcount] =
Bram Moolenaar2a389082021-04-09 20:24:31 +02004659 ufunc->uf_va_type == NULL ? &t_list_any : ufunc->uf_va_type;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004660 ufunc->uf_func_type->tt_flags = TTFLAG_VARARGS;
4661 }
4662 }
4663 else
4664 // No arguments, can use a predefined type.
4665 ufunc->uf_func_type = get_func_type(ufunc->uf_ret_type,
4666 argcount, &ufunc->uf_type_list);
4667}
4668
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004669/*
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01004670 * Free all instructions for "dfunc" except df_name.
Bram Moolenaar20431c92020-03-20 18:39:46 +01004671 */
4672 static void
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004673delete_def_function_contents(dfunc_T *dfunc, int mark_deleted)
Bram Moolenaar20431c92020-03-20 18:39:46 +01004674{
4675 int idx;
4676
Bram Moolenaard505d172022-12-18 21:42:55 +00004677 // In same cases the instructions may refer to a class in which the
4678 // function is defined and unreferencing the class may call back here
4679 // recursively. Set the df_delete_busy to avoid problems.
4680 if (dfunc->df_delete_busy)
4681 return;
4682 dfunc->df_delete_busy = TRUE;
4683
Bram Moolenaar20431c92020-03-20 18:39:46 +01004684 ga_clear(&dfunc->df_def_args_isn);
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02004685 ga_clear_strings(&dfunc->df_var_names);
Bram Moolenaar20431c92020-03-20 18:39:46 +01004686
4687 if (dfunc->df_instr != NULL)
4688 {
4689 for (idx = 0; idx < dfunc->df_instr_count; ++idx)
4690 delete_instr(dfunc->df_instr + idx);
4691 VIM_CLEAR(dfunc->df_instr);
4692 }
Bram Moolenaarc2dec4c2021-06-13 15:39:00 +02004693 if (dfunc->df_instr_debug != NULL)
4694 {
4695 for (idx = 0; idx < dfunc->df_instr_debug_count; ++idx)
4696 delete_instr(dfunc->df_instr_debug + idx);
4697 VIM_CLEAR(dfunc->df_instr_debug);
Bram Moolenaarc2dec4c2021-06-13 15:39:00 +02004698 }
Bram Moolenaarc05fe072021-01-24 21:30:48 +01004699#ifdef FEAT_PROFILE
4700 if (dfunc->df_instr_prof != NULL)
4701 {
4702 for (idx = 0; idx < dfunc->df_instr_prof_count; ++idx)
4703 delete_instr(dfunc->df_instr_prof + idx);
4704 VIM_CLEAR(dfunc->df_instr_prof);
Bram Moolenaarc05fe072021-01-24 21:30:48 +01004705 }
4706#endif
Bram Moolenaar20431c92020-03-20 18:39:46 +01004707
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004708 if (mark_deleted)
4709 dfunc->df_deleted = TRUE;
4710 if (dfunc->df_ufunc != NULL)
4711 dfunc->df_ufunc->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaard505d172022-12-18 21:42:55 +00004712
4713 dfunc->df_delete_busy = FALSE;
Bram Moolenaar20431c92020-03-20 18:39:46 +01004714}
4715
4716/*
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004717 * When a user function is deleted, clear the contents of any associated def
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01004718 * function, unless another user function still uses it.
4719 * The position in def_functions can be re-used.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004720 */
4721 void
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01004722unlink_def_function(ufunc_T *ufunc)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004723{
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00004724 if (ufunc->uf_dfunc_idx <= 0)
4725 return;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004726
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00004727 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
4728 + ufunc->uf_dfunc_idx;
4729
4730 if (--dfunc->df_refcount <= 0)
4731 delete_def_function_contents(dfunc, TRUE);
4732 ufunc->uf_def_status = UF_NOT_COMPILED;
4733 ufunc->uf_dfunc_idx = 0;
4734 if (dfunc->df_ufunc == ufunc)
4735 dfunc->df_ufunc = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004736}
4737
Bram Moolenaarfdeab652020-09-19 15:16:50 +02004738/*
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01004739 * Used when a user function refers to an existing dfunc.
Bram Moolenaarfdeab652020-09-19 15:16:50 +02004740 */
4741 void
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01004742link_def_function(ufunc_T *ufunc)
Bram Moolenaarfdeab652020-09-19 15:16:50 +02004743{
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00004744 if (ufunc->uf_dfunc_idx <= 0)
4745 return;
Bram Moolenaarfdeab652020-09-19 15:16:50 +02004746
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00004747 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
4748 + ufunc->uf_dfunc_idx;
4749
4750 ++dfunc->df_refcount;
Bram Moolenaarfdeab652020-09-19 15:16:50 +02004751}
4752
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004753#if defined(EXITFREE) || defined(PROTO)
Bram Moolenaar20431c92020-03-20 18:39:46 +01004754/*
4755 * Free all functions defined with ":def".
4756 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004757 void
4758free_def_functions(void)
4759{
Bram Moolenaar20431c92020-03-20 18:39:46 +01004760 int idx;
4761
4762 for (idx = 0; idx < def_functions.ga_len; ++idx)
4763 {
4764 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data) + idx;
4765
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004766 delete_def_function_contents(dfunc, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01004767 vim_free(dfunc->df_name);
Bram Moolenaar20431c92020-03-20 18:39:46 +01004768 }
4769
4770 ga_clear(&def_functions);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004771}
4772#endif
4773
4774
4775#endif // FEAT_EVAL