blob: 3666bb35ccbb46e9958f88ada9e5592360f11e6a [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/*
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001646 * Initialize "lhs" with default values
Bram Moolenaar752fc692021-01-04 21:57:11 +01001647 */
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001648 static void
1649lhs_init_defaults(lhs_T *lhs)
Bram Moolenaar752fc692021-01-04 21:57:11 +01001650{
Bram Moolenaar752fc692021-01-04 21:57:11 +01001651 CLEAR_POINTER(lhs);
1652 lhs->lhs_dest = dest_local;
1653 lhs->lhs_vimvaridx = -1;
1654 lhs->lhs_scriptvar_idx = -1;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001655 lhs->lhs_member_idx = -1;
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001656}
Bram Moolenaar752fc692021-01-04 21:57:11 +01001657
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001658/*
1659 * When compiling a LHS variable name, find the end of the destination and the
1660 * end of the variable name.
1661 */
1662 static int
1663lhs_find_var_end(
1664 lhs_T *lhs,
1665 char_u *var_start,
1666 int is_decl,
1667 char_u **var_endp)
1668{
1669 char_u *var_end = *var_endp;
1670
1671 // "lhs_dest_end" is the end of the destination, including "[expr]" or
Bram Moolenaar752fc692021-01-04 21:57:11 +01001672 // ".name".
1673 // "var_end" is the end of the variable/option/etc. name.
1674 lhs->lhs_dest_end = skip_var_one(var_start, FALSE);
1675 if (*var_start == '@')
Bram Moolenaar3558afe2022-10-13 16:12:57 +01001676 {
1677 if (!valid_dest_reg(var_start[1]))
1678 return FAIL;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001679 var_end = var_start + 2;
Bram Moolenaar3558afe2022-10-13 16:12:57 +01001680 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01001681 else
1682 {
1683 // skip over the leading "&", "&l:", "&g:" and "$"
1684 var_end = skip_option_env_lead(var_start);
1685 var_end = to_name_end(var_end, TRUE);
1686 }
1687
1688 // "a: type" is declaring variable "a" with a type, not dict "a:".
1689 if (is_decl && lhs->lhs_dest_end == var_start + 2
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001690 && lhs->lhs_dest_end[-1] == ':')
Bram Moolenaar752fc692021-01-04 21:57:11 +01001691 --lhs->lhs_dest_end;
1692 if (is_decl && var_end == var_start + 2 && var_end[-1] == ':')
1693 --var_end;
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001694
Bram Moolenaarab36e6a2021-11-30 16:14:49 +00001695 lhs->lhs_end = lhs->lhs_dest_end;
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001696 *var_endp = var_end;
1697
1698 return OK;
1699}
1700
1701/*
1702 * Set various fields in "lhs"
1703 */
1704 static int
1705lhs_init(
1706 lhs_T *lhs,
1707 char_u *var_start,
1708 int is_decl,
1709 int heredoc,
1710 char_u **var_endp)
1711{
1712 char_u *var_end = *var_endp;
1713
1714 lhs_init_defaults(lhs);
1715
1716 // Find the end of the variable and the destination
1717 if (lhs_find_var_end(lhs, var_start, is_decl, &var_end) == FAIL)
1718 return FAIL;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001719
1720 // compute the length of the destination without "[expr]" or ".name"
1721 lhs->lhs_varlen = var_end - var_start;
Bram Moolenaar753bcf82021-04-21 14:24:24 +02001722 lhs->lhs_varlen_total = lhs->lhs_varlen;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001723 lhs->lhs_name = vim_strnsave(var_start, lhs->lhs_varlen);
1724 if (lhs->lhs_name == NULL)
1725 return FAIL;
Bram Moolenaar08251752021-01-11 21:20:18 +01001726
1727 if (lhs->lhs_dest_end > var_start + lhs->lhs_varlen)
1728 // Something follows after the variable: "var[idx]" or "var.key".
1729 lhs->lhs_has_index = TRUE;
1730
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001731 lhs->lhs_type = heredoc ? &t_list_string : &t_any;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001732
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001733 *var_endp = var_end;
1734
1735 return OK;
1736}
1737
1738/*
1739 * Compile a LHS class variable name.
1740 */
1741 static int
1742compile_lhs_class_variable(
1743 cctx_T *cctx,
1744 lhs_T *lhs,
1745 class_T *defcl,
1746 int is_decl)
1747{
1748 if (cctx->ctx_ufunc->uf_defclass != defcl)
Bram Moolenaar752fc692021-01-04 21:57:11 +01001749 {
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001750 // A class variable can be accessed without the class name
1751 // only inside a class.
1752 semsg(_(e_class_variable_str_accessible_only_inside_class_str),
1753 lhs->lhs_name, defcl->class_name);
1754 return FAIL;
1755 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01001756
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001757 if (is_decl)
1758 {
1759 semsg(_(e_variable_already_declared_in_class_str), lhs->lhs_name);
1760 return FAIL;
1761 }
1762
1763 ocmember_T *m = &defcl->class_class_members[lhs->lhs_classmember_idx];
1764 if (oc_var_check_ro(defcl, m))
1765 return FAIL;
1766
1767 lhs->lhs_dest = dest_class_member;
1768 // The class variable is defined either in the current class or
1769 // in one of the parent class in the hierarchy.
1770 lhs->lhs_class = defcl;
1771 lhs->lhs_type = oc_member_type_by_idx(defcl, FALSE,
1772 lhs->lhs_classmember_idx);
1773
1774 return OK;
1775}
1776
1777/*
1778 * Compile an imported LHS variable
1779 */
1780 static int
1781compile_lhs_import_var(
1782 lhs_T *lhs,
1783 imported_T *import,
1784 char_u *var_start,
1785 char_u **var_endp,
1786 char_u **rawnamep)
1787{
1788 char_u *var_end = *var_endp;
1789 char_u *dot = vim_strchr(var_start, '.');
1790 char_u *p;
1791
1792 // for an import the name is what comes after the dot
1793 if (dot == NULL)
1794 {
1795 semsg(_(e_no_dot_after_imported_name_str), var_start);
1796 return FAIL;
1797 }
1798
1799 p = skipwhite(dot + 1);
1800 var_end = to_name_end(p, TRUE);
1801 if (var_end == p)
1802 {
1803 semsg(_(e_missing_name_after_imported_name_str), var_start);
1804 return FAIL;
1805 }
1806
1807 vim_free(lhs->lhs_name);
1808 lhs->lhs_varlen = var_end - p;
1809 lhs->lhs_name = vim_strnsave(p, lhs->lhs_varlen);
1810 if (lhs->lhs_name == NULL)
1811 return FAIL;
1812 *rawnamep = lhs->lhs_name;
1813 lhs->lhs_scriptvar_sid = import->imp_sid;
1814
1815 // TODO: where do we check this name is exported?
1816
1817 // Check if something follows: "exp.var[idx]" or
1818 // "exp.var.key".
1819 lhs->lhs_has_index = lhs->lhs_dest_end > skipwhite(var_end);
1820
1821 *var_endp = var_end;
1822
1823 return OK;
1824}
1825
1826/*
1827 * Process a script-local variable when compiling a LHS variable name.
1828 */
1829 static int
1830compile_lhs_script_var(
1831 cctx_T *cctx,
1832 lhs_T *lhs,
1833 char_u *var_start,
1834 char_u *var_end,
1835 int is_decl)
1836{
1837 int script_namespace = FALSE;
1838 int script_var = FALSE;
1839 imported_T *import;
1840 char_u *var_name;
1841 int var_name_len;
1842
1843 if (lhs->lhs_varlen > 1 && STRNCMP(var_start, "s:", 2) == 0)
1844 script_namespace = TRUE;
1845
1846 if (script_namespace)
1847 {
1848 var_name = var_start + 2;
1849 var_name_len = lhs->lhs_varlen - 2;
1850 }
1851 else
1852 {
1853 var_name = var_start;
1854 var_name_len = lhs->lhs_varlen;
1855 }
1856
1857 if (script_var_exists(var_name, var_name_len, cctx, NULL) == OK)
1858 script_var = TRUE;
1859
1860 import = find_imported(var_start, lhs->lhs_varlen, FALSE);
1861
1862 if (script_namespace || script_var || import != NULL)
1863 {
1864 char_u *rawname = lhs->lhs_name + (lhs->lhs_name[1] == ':' ? 2 : 0);
1865
1866 if (script_namespace && current_script_is_vim9())
Bram Moolenaar752fc692021-01-04 21:57:11 +01001867 {
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001868 semsg(_(e_cannot_use_s_colon_in_vim9_script_str), var_start);
1869 return FAIL;
1870 }
1871
1872 if (is_decl)
1873 {
1874 if (script_namespace)
1875 semsg(_(e_cannot_declare_script_variable_in_function_str),
1876 lhs->lhs_name);
1877 else
1878 semsg(_(e_variable_already_declared_in_script_str),
1879 lhs->lhs_name);
1880 return FAIL;
1881 }
1882 else if (cctx->ctx_ufunc->uf_script_ctx_version == SCRIPT_VERSION_VIM9
1883 && script_namespace
1884 && !script_var && import == NULL)
1885 {
1886 semsg(_(e_unknown_variable_str), lhs->lhs_name);
1887 return FAIL;
1888 }
1889
1890 lhs->lhs_dest = current_script_is_vim9() ? dest_script_v9 :
1891 dest_script;
1892
1893 // existing script-local variables should have a type
1894 lhs->lhs_scriptvar_sid = current_sctx.sc_sid;
1895 if (import != NULL)
1896 {
1897 if (compile_lhs_import_var(lhs, import, var_start, &var_end,
1898 &rawname) == FAIL)
1899 return FAIL;
1900 }
1901
1902 if (SCRIPT_ID_VALID(lhs->lhs_scriptvar_sid))
1903 {
1904 // Check writable only when no index follows.
1905 lhs->lhs_scriptvar_idx = get_script_item_idx(
1906 lhs->lhs_scriptvar_sid, rawname,
1907 lhs->lhs_has_index ? ASSIGN_FINAL :
1908 ASSIGN_CONST, cctx, NULL);
1909 if (lhs->lhs_scriptvar_idx >= 0)
1910 {
1911 scriptitem_T *si = SCRIPT_ITEM(lhs->lhs_scriptvar_sid);
1912 svar_T *sv = ((svar_T *)si->sn_var_vals.ga_data)
1913 + lhs->lhs_scriptvar_idx;
1914
1915 lhs->lhs_type = sv->sv_type;
1916 }
1917 }
1918
1919 return OK;
1920 }
1921
1922 return check_defined(var_start, lhs->lhs_varlen, cctx, NULL, FALSE);
1923}
1924
1925/*
1926 * Compile the LHS destination.
1927 */
1928 static int
1929compile_lhs_var_dest(
1930 cctx_T *cctx,
1931 lhs_T *lhs,
1932 int cmdidx,
1933 char_u *var_start,
1934 char_u *var_end,
1935 int is_decl)
1936{
1937 int declare_error = FALSE;
1938
1939 if (get_var_dest(lhs->lhs_name, &lhs->lhs_dest, cmdidx,
1940 &lhs->lhs_opt_flags, &lhs->lhs_vimvaridx,
1941 &lhs->lhs_type, cctx) == FAIL)
1942 return FAIL;
1943
1944 if (lhs->lhs_dest != dest_local && cmdidx != CMD_const
1945 && cmdidx != CMD_final)
1946 {
1947 // Specific kind of variable recognized.
1948 declare_error = is_decl;
1949 }
1950 else
1951 {
1952 class_T *defcl;
1953
1954 // No specific kind of variable recognized, just a name.
1955 if (check_reserved_name(lhs->lhs_name, lhs->lhs_has_index
1956 && *var_end == '.') == FAIL)
1957 return FAIL;
1958
1959 if (lookup_local(var_start, lhs->lhs_varlen, &lhs->lhs_local_lvar,
1960 cctx) == OK)
1961 {
1962 lhs->lhs_lvar = &lhs->lhs_local_lvar;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001963 }
1964 else
1965 {
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001966 CLEAR_FIELD(lhs->lhs_arg_lvar);
1967 if (arg_exists(var_start, lhs->lhs_varlen,
1968 &lhs->lhs_arg_lvar.lv_idx, &lhs->lhs_arg_lvar.lv_type,
1969 &lhs->lhs_arg_lvar.lv_from_outer, cctx) == OK)
Bram Moolenaar752fc692021-01-04 21:57:11 +01001970 {
1971 if (is_decl)
1972 {
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001973 semsg(_(e_str_is_used_as_argument), lhs->lhs_name);
Bram Moolenaar752fc692021-01-04 21:57:11 +01001974 return FAIL;
1975 }
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001976 lhs->lhs_lvar = &lhs->lhs_arg_lvar;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001977 }
1978 }
1979
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001980 if (lhs->lhs_lvar != NULL)
Bram Moolenaar752fc692021-01-04 21:57:11 +01001981 {
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01001982 if (is_decl)
1983 {
1984 // if we come here with what looks like an assignment like
1985 // .= but which has been rejected by assignment_len() from
1986 // may_compile_assignment give a better error message
1987 char_u *p = skipwhite(lhs->lhs_end);
1988 if (p[0] == '.' && p[1] == '=')
1989 emsg(_(e_dot_equal_not_supported_with_script_version_two));
1990 else if (p[0] == ':')
1991 // type specified in a non-var assignment
1992 semsg(_(e_trailing_characters_str), p);
1993 else
1994 semsg(_(e_variable_already_declared_str), lhs->lhs_name);
1995 return FAIL;
1996 }
1997 }
1998 else if ((lhs->lhs_classmember_idx = cctx_class_member_idx(
1999 cctx, var_start, lhs->lhs_varlen, &defcl)) >= 0)
2000 {
2001 if (compile_lhs_class_variable(cctx, lhs, defcl, is_decl)
2002 == FAIL)
2003 return FAIL;
2004 }
2005 else
2006 {
2007 if (compile_lhs_script_var(cctx, lhs, var_start, var_end,
2008 is_decl) == FAIL)
2009 return FAIL;
2010 }
2011 }
2012
2013 if (declare_error)
2014 {
2015 vim9_declare_error(lhs->lhs_name);
2016 return FAIL;
2017 }
2018
2019 return OK;
2020}
2021
2022/*
2023 * When compiling a LHS variable name, for a class or an object, set the LHS
2024 * member type.
2025 */
2026 static int
2027compile_lhs_set_oc_member_type(
2028 cctx_T *cctx,
2029 lhs_T *lhs,
2030 char_u *var_start)
2031{
2032 class_T *cl = lhs->lhs_type->tt_class;
2033 int is_object = lhs->lhs_type->tt_type == VAR_OBJECT;
2034 char_u *name = var_start + lhs->lhs_varlen + 1;
2035 size_t namelen = lhs->lhs_end - var_start - lhs->lhs_varlen - 1;
2036
2037 ocmember_T *m = member_lookup(cl, lhs->lhs_type->tt_type,
2038 name, namelen, &lhs->lhs_member_idx);
2039 if (m == NULL)
2040 {
2041 member_not_found_msg(cl, lhs->lhs_type->tt_type, name, namelen);
2042 return FAIL;
2043 }
2044
2045 if (IS_ENUM(cl))
2046 {
2047 if (!inside_class(cctx, cl))
2048 {
2049 semsg(_(e_enumvalue_str_cannot_be_modified),
2050 cl->class_name, m->ocm_name);
Bram Moolenaar752fc692021-01-04 21:57:11 +01002051 return FAIL;
2052 }
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01002053 if (lhs->lhs_type->tt_type == VAR_OBJECT &&
2054 lhs->lhs_member_idx < 2)
2055 {
2056 char *msg = lhs->lhs_member_idx == 0 ?
2057 e_enum_str_name_cannot_be_modified :
2058 e_enum_str_ordinal_cannot_be_modified;
2059 semsg(_(msg), cl->class_name);
2060 return FAIL;
2061 }
2062 }
2063
2064 // If it is private member variable, then accessing it outside the
2065 // class is not allowed.
2066 // If it is a read only class variable, then it can be modified
2067 // only inside the class where it is defined.
2068 if ((m->ocm_access != VIM_ACCESS_ALL) &&
2069 ((is_object && !inside_class(cctx, cl))
2070 || (!is_object && cctx->ctx_ufunc->uf_class != cl)))
2071 {
2072 char *msg = (m->ocm_access == VIM_ACCESS_PRIVATE)
2073 ? e_cannot_access_protected_variable_str
2074 : e_variable_is_not_writable_str;
2075 emsg_var_cl_define(msg, m->ocm_name, 0, cl);
2076 return FAIL;
2077 }
2078
2079 if (!IS_CONSTRUCTOR_METHOD(cctx->ctx_ufunc)
2080 && oc_var_check_ro(cl, m))
2081 return FAIL;
2082
2083 lhs->lhs_member_type = m->ocm_type;
2084
2085 return OK;
2086}
2087
2088/*
2089 * When compiling a LHS variable, set the LHS variable type.
2090 */
2091 static int
2092compile_lhs_set_type(cctx_T *cctx, lhs_T *lhs, char_u *var_end, int is_decl)
2093{
2094 if (is_decl && *skipwhite(var_end) == ':')
2095 {
2096 char_u *p;
2097
2098 // parse optional type: "let var: type = expr"
2099 if (VIM_ISWHITE(*var_end))
2100 {
2101 semsg(_(e_no_white_space_allowed_before_colon_str), var_end);
2102 return FAIL;
2103 }
2104
2105 if (!VIM_ISWHITE(var_end[1]))
2106 {
2107 semsg(_(e_white_space_required_after_str_str), ":", var_end);
2108 return FAIL;
2109 }
2110
2111 p = skipwhite(var_end + 1);
2112 lhs->lhs_type = parse_type(&p, cctx->ctx_type_list, TRUE);
2113 if (lhs->lhs_type == NULL)
2114 return FAIL;
2115
2116 lhs->lhs_has_type = TRUE;
2117 lhs->lhs_end = p;
2118 }
2119 else if (lhs->lhs_lvar != NULL)
2120 lhs->lhs_type = lhs->lhs_lvar->lv_type;
2121
2122 return OK;
2123}
2124
2125/*
2126 * Returns TRUE if "lhs" is a concatenable string.
2127 */
2128 static int
2129lhs_concatenable(lhs_T *lhs)
2130{
2131 return lhs->lhs_dest == dest_global
2132 || lhs->lhs_has_index
2133 || lhs->lhs_type->tt_type == VAR_STRING
2134 || lhs->lhs_type->tt_type == VAR_ANY;
2135}
2136
2137/*
2138 * Create a new local variable when compiling a LHS variable.
2139 */
2140 static int
2141compile_lhs_new_local_var(
2142 cctx_T *cctx,
2143 lhs_T *lhs,
2144 char_u *var_start,
2145 int cmdidx,
2146 int oplen,
2147 int is_decl,
2148 int has_cmd,
2149 int heredoc)
2150{
2151 if (oplen > 1 && !heredoc)
2152 {
2153 // +=, /=, etc. require an existing variable
2154 semsg(_(e_cannot_use_operator_on_new_variable_str), lhs->lhs_name);
2155 return FAIL;
2156 }
2157
2158 if (!is_decl || (lhs->lhs_has_index && !has_cmd
2159 && cctx->ctx_skip != SKIP_YES))
2160 {
2161 semsg(_(e_unknown_variable_str), lhs->lhs_name);
2162 return FAIL;
2163 }
2164
2165 // Check the name is valid for a funcref.
2166 if (lhs->lhs_type->tt_type == VAR_FUNC
2167 || lhs->lhs_type->tt_type == VAR_PARTIAL)
2168 {
2169 if (var_wrong_func_name(lhs->lhs_name, TRUE))
2170 return FAIL;
2171 }
2172
2173 // New local variable.
2174 int assign;
2175 switch (cmdidx)
2176 {
2177 case CMD_final:
2178 assign = ASSIGN_FINAL; break;
2179 case CMD_const:
2180 assign = ASSIGN_CONST; break;
2181 default:
2182 assign = ASSIGN_VAR; break;
2183 }
2184
2185 lhs->lhs_lvar = reserve_local(cctx, var_start, lhs->lhs_varlen, assign,
2186 lhs->lhs_type);
2187 if (lhs->lhs_lvar == NULL)
2188 return FAIL;
2189
2190 lhs->lhs_new_local = TRUE;
2191
2192 return OK;
2193}
2194
2195/*
2196 * When compiling a LHS variable name, set the LHS member type.
2197 */
2198 static int
2199compile_lhs_set_member_type(
2200 cctx_T *cctx,
2201 lhs_T *lhs,
2202 char_u *var_start,
2203 int is_decl,
2204 int has_cmd)
2205{
2206 lhs->lhs_member_type = lhs->lhs_type;
2207
2208 if (!lhs->lhs_has_index)
2209 return OK;
2210
2211 char_u *after = var_start + lhs->lhs_varlen;
2212 char_u *p;
2213
2214 // Something follows after the variable: "var[idx]" or "var.key".
2215 if (is_decl && cctx->ctx_skip != SKIP_YES)
2216 {
2217 if (has_cmd)
2218 emsg(_(e_cannot_use_index_when_declaring_variable));
2219 else
2220 semsg(_(e_unknown_variable_str), lhs->lhs_name);
2221 return FAIL;
2222 }
2223
2224 // Now: var_start[lhs->lhs_varlen] is '[' or '.'
2225 // Only the last index is used below, if there are others
2226 // before it generate code for the expression. Thus for
2227 // "ll[1][2]" the expression is "ll[1]" and "[2]" is the index.
2228 for (;;)
2229 {
2230 p = skip_index(after);
2231 if (*p != '[' && *p != '.')
2232 {
2233 lhs->lhs_varlen_total = p - var_start;
2234 break;
2235 }
2236 after = p;
2237 }
2238 if (after > var_start + lhs->lhs_varlen)
2239 {
2240 lhs->lhs_varlen = after - var_start;
2241 lhs->lhs_dest = dest_expr;
2242 // We don't know the type before evaluating the expression,
2243 // use "any" until then.
2244 lhs->lhs_type = &t_any;
2245 }
2246
2247 int use_class = lhs->lhs_type != NULL
2248 && (lhs->lhs_type->tt_type == VAR_CLASS
2249 || lhs->lhs_type->tt_type == VAR_OBJECT);
2250
2251 if (lhs->lhs_type == NULL
2252 || (use_class ? lhs->lhs_type->tt_class == NULL
2253 : lhs->lhs_type->tt_member == NULL))
2254 {
2255 lhs->lhs_member_type = &t_any;
2256 }
2257 else if (use_class)
2258 {
2259 // for an object or class member get the type of the member
2260 if (compile_lhs_set_oc_member_type(cctx, lhs, var_start) == FAIL)
2261 return FAIL;
2262 }
2263 else
2264 lhs->lhs_member_type = lhs->lhs_type->tt_member;
2265
2266 return OK;
2267}
2268
2269/*
2270 * Figure out the LHS type and other properties for an assignment or one item
2271 * of ":unlet" with an index.
2272 * Returns OK or FAIL.
2273 */
2274 int
2275compile_lhs(
2276 char_u *var_start,
2277 lhs_T *lhs,
2278 cmdidx_T cmdidx,
2279 int heredoc,
2280 int has_cmd, // "var" before "var_start"
2281 int oplen,
2282 cctx_T *cctx)
2283{
2284 char_u *var_end;
2285 int is_decl = is_decl_command(cmdidx);
2286
2287 if (lhs_init(lhs, var_start, is_decl, heredoc, &var_end) == FAIL)
2288 return FAIL;
2289
2290 if (cctx->ctx_skip != SKIP_YES)
2291 {
2292 // compile the LHS destination
2293 if (compile_lhs_var_dest(cctx, lhs, cmdidx, var_start, var_end,
2294 is_decl) == FAIL)
2295 return FAIL;
Bram Moolenaar752fc692021-01-04 21:57:11 +01002296 }
2297
Bram Moolenaarab36e6a2021-11-30 16:14:49 +00002298 // handle "a:name" as a name, not index "name" in "a"
Bram Moolenaar752fc692021-01-04 21:57:11 +01002299 if (lhs->lhs_varlen > 1 || var_start[lhs->lhs_varlen] != ':')
2300 var_end = lhs->lhs_dest_end;
2301
Bram Moolenaardcb53be2021-12-09 14:23:43 +00002302 if (lhs->lhs_dest != dest_option && lhs->lhs_dest != dest_func_option)
Bram Moolenaar752fc692021-01-04 21:57:11 +01002303 {
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01002304 // set the LHS variable type
2305 if (compile_lhs_set_type(cctx, lhs, var_end, is_decl) == FAIL)
2306 return FAIL;
Bram Moolenaar752fc692021-01-04 21:57:11 +01002307 }
2308
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01002309 if (oplen == 3 && !heredoc && !lhs_concatenable(lhs))
Bram Moolenaar752fc692021-01-04 21:57:11 +01002310 {
2311 emsg(_(e_can_only_concatenate_to_string));
2312 return FAIL;
2313 }
2314
2315 if (lhs->lhs_lvar == NULL && lhs->lhs_dest == dest_local
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01002316 && cctx->ctx_skip != SKIP_YES)
Bram Moolenaar752fc692021-01-04 21:57:11 +01002317 {
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01002318 if (compile_lhs_new_local_var(cctx, lhs, var_start, cmdidx, oplen,
2319 is_decl, has_cmd, heredoc) == FAIL)
Bram Moolenaar752fc692021-01-04 21:57:11 +01002320 return FAIL;
Bram Moolenaar752fc692021-01-04 21:57:11 +01002321 }
2322
Yegappan Lakshmanand0186c52024-12-18 20:16:20 +01002323 if (compile_lhs_set_member_type(cctx, lhs, var_start, is_decl, has_cmd)
2324 == FAIL)
2325 return FAIL;
Bram Moolenaarc750d912021-11-29 22:02:12 +00002326
Bram Moolenaar752fc692021-01-04 21:57:11 +01002327 return OK;
2328}
2329
2330/*
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002331 * Figure out the LHS and check a few errors.
2332 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +00002333 int
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002334compile_assign_lhs(
Bram Moolenaar97f8c102022-04-02 19:43:57 +01002335 char_u *var_start,
2336 lhs_T *lhs,
2337 cmdidx_T cmdidx,
2338 int is_decl,
2339 int heredoc,
2340 int has_cmd, // "var" before "var_start"
2341 int oplen,
2342 cctx_T *cctx)
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002343{
Bram Moolenaar97f8c102022-04-02 19:43:57 +01002344 if (compile_lhs(var_start, lhs, cmdidx, heredoc, has_cmd, oplen, cctx)
2345 == FAIL)
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002346 return FAIL;
2347
2348 if (!lhs->lhs_has_index && lhs->lhs_lvar == &lhs->lhs_arg_lvar)
2349 {
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00002350 semsg(_(e_cannot_assign_to_argument_str), lhs->lhs_name);
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002351 return FAIL;
2352 }
2353 if (!is_decl && lhs->lhs_lvar != NULL
Bram Moolenaar6586a012022-09-30 11:04:50 +01002354 && lhs->lhs_lvar->lv_const != ASSIGN_VAR
2355 && !lhs->lhs_has_index)
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002356 {
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00002357 semsg(_(e_cannot_assign_to_constant_str), lhs->lhs_name);
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002358 return FAIL;
2359 }
2360 return OK;
2361}
2362
2363/*
Bram Moolenaar4f0884d2021-08-11 21:49:23 +02002364 * Return TRUE if "lhs" has a range index: "[expr : expr]".
2365 */
2366 static int
2367has_list_index(char_u *idx_start, cctx_T *cctx)
2368{
2369 char_u *p = idx_start;
2370 int save_skip;
2371
2372 if (*p != '[')
2373 return FALSE;
2374
2375 p = skipwhite(p + 1);
2376 if (*p == ':')
2377 return TRUE;
2378
2379 save_skip = cctx->ctx_skip;
2380 cctx->ctx_skip = SKIP_YES;
2381 (void)compile_expr0(&p, cctx);
2382 cctx->ctx_skip = save_skip;
2383 return *skipwhite(p) == ':';
2384}
2385
2386/*
Bram Moolenaare42939a2021-04-05 17:11:17 +02002387 * For an assignment with an index, compile the "idx" in "var[idx]" or "key" in
2388 * "var.key".
Bram Moolenaar752fc692021-01-04 21:57:11 +01002389 */
2390 static int
Bram Moolenaare42939a2021-04-05 17:11:17 +02002391compile_assign_index(
Bram Moolenaar752fc692021-01-04 21:57:11 +01002392 char_u *var_start,
2393 lhs_T *lhs,
Bram Moolenaare42939a2021-04-05 17:11:17 +02002394 int *range,
Bram Moolenaar752fc692021-01-04 21:57:11 +01002395 cctx_T *cctx)
2396{
Bram Moolenaar752fc692021-01-04 21:57:11 +01002397 size_t varlen = lhs->lhs_varlen;
Bram Moolenaare42939a2021-04-05 17:11:17 +02002398 char_u *p;
2399 int r = OK;
Bram Moolenaar68452172021-04-12 21:21:02 +02002400 int need_white_before = TRUE;
2401 int empty_second;
Bram Moolenaar752fc692021-01-04 21:57:11 +01002402
Bram Moolenaar752fc692021-01-04 21:57:11 +01002403 p = var_start + varlen;
2404 if (*p == '[')
2405 {
2406 p = skipwhite(p + 1);
Bram Moolenaar68452172021-04-12 21:21:02 +02002407 if (*p == ':')
2408 {
2409 // empty first index, push zero
2410 r = generate_PUSHNR(cctx, 0);
2411 need_white_before = FALSE;
2412 }
2413 else
2414 r = compile_expr0(&p, cctx);
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002415
2416 if (r == OK && *skipwhite(p) == ':')
2417 {
2418 // unlet var[idx : idx]
Bram Moolenaar68452172021-04-12 21:21:02 +02002419 // blob[idx : idx] = value
Bram Moolenaare42939a2021-04-05 17:11:17 +02002420 *range = TRUE;
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002421 p = skipwhite(p);
Bram Moolenaar68452172021-04-12 21:21:02 +02002422 empty_second = *skipwhite(p + 1) == ']';
2423 if ((need_white_before && !IS_WHITE_OR_NUL(p[-1]))
2424 || (!empty_second && !IS_WHITE_OR_NUL(p[1])))
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002425 {
2426 semsg(_(e_white_space_required_before_and_after_str_at_str),
2427 ":", p);
2428 return FAIL;
2429 }
2430 p = skipwhite(p + 1);
Bram Moolenaar68452172021-04-12 21:21:02 +02002431 if (*p == ']')
2432 // empty second index, push "none"
2433 r = generate_PUSHSPEC(cctx, VVAL_NONE);
2434 else
2435 r = compile_expr0(&p, cctx);
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002436 }
2437
Bram Moolenaar752fc692021-01-04 21:57:11 +01002438 if (r == OK && *skipwhite(p) != ']')
2439 {
2440 // this should not happen
Bram Moolenaare1242042021-12-16 20:56:57 +00002441 emsg(_(e_missing_closing_square_brace));
Bram Moolenaar752fc692021-01-04 21:57:11 +01002442 r = FAIL;
2443 }
2444 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002445 else if (lhs->lhs_member_idx >= 0)
2446 {
2447 // object member index
2448 r = generate_PUSHNR(cctx, lhs->lhs_member_idx);
2449 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01002450 else // if (*p == '.')
2451 {
2452 char_u *key_end = to_name_end(p + 1, TRUE);
2453 char_u *key = vim_strnsave(p + 1, key_end - p - 1);
2454
Zdenek Dohnal9fe17d42021-08-04 22:30:52 +02002455 r = generate_PUSHS(cctx, &key);
Bram Moolenaar752fc692021-01-04 21:57:11 +01002456 }
Bram Moolenaare42939a2021-04-05 17:11:17 +02002457 return r;
2458}
2459
2460/*
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002461 * For a LHS with an index, load the variable to be indexed.
2462 */
2463 static int
2464compile_load_lhs(
2465 lhs_T *lhs,
2466 char_u *var_start,
2467 type_T *rhs_type,
2468 cctx_T *cctx)
2469{
2470 if (lhs->lhs_dest == dest_expr)
2471 {
2472 size_t varlen = lhs->lhs_varlen;
2473 int c = var_start[varlen];
Bram Moolenaare97976b2021-08-01 13:17:17 +02002474 int lines_len = cctx->ctx_ufunc->uf_lines.ga_len;
Bram Moolenaare97976b2021-08-01 13:17:17 +02002475 int res;
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002476
Bram Moolenaare97976b2021-08-01 13:17:17 +02002477 // Evaluate "ll[expr]" of "ll[expr][idx]". End the line with a NUL and
2478 // limit the lines array length to avoid skipping to a following line.
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002479 var_start[varlen] = NUL;
Bram Moolenaare97976b2021-08-01 13:17:17 +02002480 cctx->ctx_ufunc->uf_lines.ga_len = cctx->ctx_lnum + 1;
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002481 char_u *p = var_start;
Bram Moolenaare97976b2021-08-01 13:17:17 +02002482 res = compile_expr0(&p, cctx);
2483 var_start[varlen] = c;
2484 cctx->ctx_ufunc->uf_lines.ga_len = lines_len;
2485 if (res == FAIL || p != var_start + varlen)
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002486 {
2487 // this should not happen
Bram Moolenaare97976b2021-08-01 13:17:17 +02002488 if (res != FAIL)
Bram Moolenaare1242042021-12-16 20:56:57 +00002489 emsg(_(e_missing_closing_square_brace));
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002490 return FAIL;
2491 }
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002492
Bram Moolenaar078a4612022-01-04 15:17:03 +00002493 lhs->lhs_type = cctx->ctx_type_stack.ga_len == 0 ? &t_void
2494 : get_type_on_stack(cctx, 0);
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02002495
2496 if (lhs->lhs_type->tt_type == VAR_OBJECT)
2497 {
2498 // Check whether the object variable is modifiable
2499 if (!lhs_class_member_modifiable(lhs, var_start, cctx))
2500 return FAIL;
2501 }
2502
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002503 // Now we can properly check the type. The variable is indexed, thus
2504 // we need the member type. For a class or object we don't know the
2505 // type yet, it depends on what member is used.
Yegappan Lakshmananc229a6a2023-10-26 23:05:07 +02002506 // The top item in the stack is the Dict, followed by the key and then
2507 // the type of the value.
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002508 vartype_T vartype = lhs->lhs_type->tt_type;
2509 type_T *member_type = lhs->lhs_type->tt_member;
2510 if (rhs_type != NULL && member_type != NULL
2511 && vartype != VAR_OBJECT && vartype != VAR_CLASS
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002512 && rhs_type != &t_void
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002513 && need_type(rhs_type, member_type, FALSE,
Yegappan Lakshmananc229a6a2023-10-26 23:05:07 +02002514 -3, 0, cctx, FALSE, FALSE) == FAIL)
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002515 return FAIL;
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02002516
2517 return OK;
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002518 }
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02002519
2520 return generate_loadvar(cctx, lhs);
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002521}
2522
2523/*
Bram Moolenaara369c3d2021-04-21 16:00:10 +02002524 * Produce code for loading "lhs" and also take care of an index.
2525 * Return OK/FAIL.
2526 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +00002527 int
Bram Moolenaara369c3d2021-04-21 16:00:10 +02002528compile_load_lhs_with_index(lhs_T *lhs, char_u *var_start, cctx_T *cctx)
2529{
Bram Moolenaar4cae8452023-01-15 15:51:48 +00002530 if (lhs->lhs_type->tt_type == VAR_OBJECT)
2531 {
Bram Moolenaar22363c62023-04-24 17:15:25 +01002532 // "this.value": load "this" object and get the value at index for an
2533 // object or class member get the type of the member.
2534 // Also for "obj.value".
Yegappan Lakshmananff6f0d52023-12-21 16:46:18 +01002535 char_u *dot = vim_strchr(var_start, '.');
2536 if (dot == NULL)
2537 {
2538 semsg(_(e_missing_dot_after_object_str), lhs->lhs_name);
2539 return FAIL;
2540 }
Bram Moolenaar22363c62023-04-24 17:15:25 +01002541
Yegappan Lakshmananeb91e242023-08-31 18:10:46 +02002542 class_T *cl = lhs->lhs_type->tt_class;
Yegappan Lakshmanan1ea42882023-10-11 21:43:52 +02002543 type_T *type = oc_member_type(cl, TRUE, dot + 1,
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02002544 lhs->lhs_end, &lhs->lhs_member_idx);
Bram Moolenaar4cae8452023-01-15 15:51:48 +00002545 if (lhs->lhs_member_idx < 0)
2546 return FAIL;
2547
Bram Moolenaar22363c62023-04-24 17:15:25 +01002548 if (dot - var_start == 4 && STRNCMP(var_start, "this", 4) == 0)
2549 {
2550 // load "this"
Yegappan Lakshmanand990bf02024-03-22 19:56:17 +01002551 lvar_T *lvar = lhs->lhs_lvar;
2552 int rc;
2553
2554 if (lvar->lv_from_outer > 0)
2555 rc = generate_LOADOUTER(cctx, lvar->lv_idx,
2556 lvar->lv_from_outer, lvar->lv_loop_depth,
2557 lvar->lv_loop_idx, type);
2558 else
2559 rc = generate_LOAD(cctx, ISN_LOAD, lvar->lv_idx, NULL, type);
2560
2561 if (rc == FAIL)
Bram Moolenaar22363c62023-04-24 17:15:25 +01002562 return FAIL;
2563 }
2564 else
2565 {
2566 // load object variable or argument
2567 if (compile_load_lhs(lhs, var_start, lhs->lhs_type, cctx) == FAIL)
2568 return FAIL;
2569 }
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002570 if (IS_INTERFACE(cl))
Yegappan Lakshmanan5a05d372023-09-29 19:43:11 +02002571 return generate_GET_ITF_MEMBER(cctx, cl, lhs->lhs_member_idx, type);
2572 return generate_GET_OBJ_MEMBER(cctx, lhs->lhs_member_idx, type);
Bram Moolenaar4cae8452023-01-15 15:51:48 +00002573 }
Yegappan Lakshmanan1ea42882023-10-11 21:43:52 +02002574 else if (lhs->lhs_type->tt_type == VAR_CLASS)
2575 {
2576 // "<classname>.value": load class variable "classname.value"
Yegappan Lakshmananff6f0d52023-12-21 16:46:18 +01002577 char_u *dot = vim_strchr(var_start, '.');
2578 if (dot == NULL)
2579 {
2580 check_type_is_value(lhs->lhs_type);
2581 return FAIL;
2582 }
Yegappan Lakshmanan1ea42882023-10-11 21:43:52 +02002583
2584 class_T *cl = lhs->lhs_type->tt_class;
2585 ocmember_T *m = class_member_lookup(cl, dot + 1,
2586 lhs->lhs_end - dot - 1,
2587 &lhs->lhs_member_idx);
2588 if (m == NULL)
2589 return FAIL;
2590
2591 return generate_CLASSMEMBER(cctx, TRUE, cl, lhs->lhs_member_idx);
2592 }
Bram Moolenaar4cae8452023-01-15 15:51:48 +00002593
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02002594 if (compile_load_lhs(lhs, var_start, NULL, cctx) == FAIL)
2595 return FAIL;
Bram Moolenaara369c3d2021-04-21 16:00:10 +02002596
2597 if (lhs->lhs_has_index)
2598 {
2599 int range = FALSE;
2600
2601 // Get member from list or dict. First compile the
2602 // index value.
2603 if (compile_assign_index(var_start, lhs, &range, cctx) == FAIL)
2604 return FAIL;
2605 if (range)
2606 {
2607 semsg(_(e_cannot_use_range_with_assignment_operator_str),
2608 var_start);
2609 return FAIL;
2610 }
2611
2612 // Get the member.
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02002613 if (compile_member(FALSE, NULL, cctx) == FAIL)
Bram Moolenaara369c3d2021-04-21 16:00:10 +02002614 return FAIL;
2615 }
2616 return OK;
2617}
2618
2619/*
Bram Moolenaare42939a2021-04-05 17:11:17 +02002620 * Assignment to a list or dict member, or ":unlet" for the item, using the
2621 * information in "lhs".
2622 * Returns OK or FAIL.
2623 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +00002624 int
Bram Moolenaare42939a2021-04-05 17:11:17 +02002625compile_assign_unlet(
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002626 char_u *var_start,
2627 lhs_T *lhs,
2628 int is_assign,
2629 type_T *rhs_type,
2630 cctx_T *cctx)
Bram Moolenaare42939a2021-04-05 17:11:17 +02002631{
Bram Moolenaare42939a2021-04-05 17:11:17 +02002632 vartype_T dest_type;
Bram Moolenaare42939a2021-04-05 17:11:17 +02002633 int range = FALSE;
2634
Bram Moolenaar68452172021-04-12 21:21:02 +02002635 if (compile_assign_index(var_start, lhs, &range, cctx) == FAIL)
Bram Moolenaar752fc692021-01-04 21:57:11 +01002636 return FAIL;
Bram Moolenaar4f0884d2021-08-11 21:49:23 +02002637 if (is_assign && range
2638 && lhs->lhs_type->tt_type != VAR_LIST
2639 && lhs->lhs_type != &t_blob
2640 && lhs->lhs_type != &t_any)
Bram Moolenaar68452172021-04-12 21:21:02 +02002641 {
2642 semsg(_(e_cannot_use_range_with_assignment_str), var_start);
2643 return FAIL;
2644 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01002645
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002646 if (lhs->lhs_type == NULL || lhs->lhs_type == &t_any)
Bram Moolenaar752fc692021-01-04 21:57:11 +01002647 {
2648 // Index on variable of unknown type: check at runtime.
2649 dest_type = VAR_ANY;
2650 }
2651 else
2652 {
2653 dest_type = lhs->lhs_type->tt_type;
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002654 if (dest_type == VAR_DICT && range)
2655 {
zeertzjq276410e2023-05-07 21:59:33 +01002656 emsg(_(e_cannot_use_range_with_dictionary));
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002657 return FAIL;
2658 }
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02002659 if (dest_type == VAR_DICT
Yegappan Lakshmananbce51d92024-04-15 19:19:52 +02002660 && may_generate_2STRING(-1, TOSTRING_NONE, cctx) == FAIL)
Bram Moolenaar752fc692021-01-04 21:57:11 +01002661 return FAIL;
Bram Moolenaar51e93322021-04-17 20:44:56 +02002662 if (dest_type == VAR_LIST || dest_type == VAR_BLOB)
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002663 {
Bram Moolenaar51e93322021-04-17 20:44:56 +02002664 type_T *type;
2665
2666 if (range)
2667 {
Bram Moolenaar078a4612022-01-04 15:17:03 +00002668 type = get_type_on_stack(cctx, 1);
Bram Moolenaarc6951a72022-12-29 20:56:24 +00002669 if (need_type(type, &t_number, FALSE,
Bram Moolenaar2995e5c2022-03-18 21:41:47 +00002670 -2, 0, cctx, FALSE, FALSE) == FAIL)
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002671 return FAIL;
Bram Moolenaar51e93322021-04-17 20:44:56 +02002672 }
Bram Moolenaar078a4612022-01-04 15:17:03 +00002673 type = get_type_on_stack(cctx, 0);
Bram Moolenaar53ba6ca2022-03-10 19:23:28 +00002674 if ((dest_type != VAR_BLOB && type->tt_type != VAR_SPECIAL)
Bram Moolenaarc6951a72022-12-29 20:56:24 +00002675 && need_type(type, &t_number, FALSE,
Bram Moolenaar51e93322021-04-17 20:44:56 +02002676 -1, 0, cctx, FALSE, FALSE) == FAIL)
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002677 return FAIL;
2678 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01002679 }
2680
Bram Moolenaar4875d6a2022-08-17 15:55:51 +01002681 if (cctx->ctx_skip == SKIP_YES)
2682 return OK;
2683
Bram Moolenaar22363c62023-04-24 17:15:25 +01002684 // Load the dict, list or object. On the stack we then have:
Bram Moolenaar752fc692021-01-04 21:57:11 +01002685 // - value (for assignment, not for :unlet)
2686 // - index
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002687 // - for [a : b] second index
Bram Moolenaar752fc692021-01-04 21:57:11 +01002688 // - variable
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002689 if (compile_load_lhs(lhs, var_start, rhs_type, cctx) == FAIL)
2690 return FAIL;
Bram Moolenaar752fc692021-01-04 21:57:11 +01002691
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002692 if (dest_type == VAR_LIST
2693 || dest_type == VAR_DICT
2694 || dest_type == VAR_BLOB
2695 || dest_type == VAR_CLASS
2696 || dest_type == VAR_OBJECT
2697 || dest_type == VAR_ANY)
Bram Moolenaar752fc692021-01-04 21:57:11 +01002698 {
2699 if (is_assign)
2700 {
Bram Moolenaar68452172021-04-12 21:21:02 +02002701 if (range)
2702 {
2703 if (generate_instr_drop(cctx, ISN_STORERANGE, 4) == NULL)
2704 return FAIL;
2705 }
2706 else
2707 {
2708 isn_T *isn = generate_instr_drop(cctx, ISN_STOREINDEX, 3);
Bram Moolenaar752fc692021-01-04 21:57:11 +01002709
Bram Moolenaar68452172021-04-12 21:21:02 +02002710 if (isn == NULL)
2711 return FAIL;
Bram Moolenaarf7d1c6e2023-01-16 20:47:57 +00002712 isn->isn_arg.storeindex.si_vartype = dest_type;
2713 isn->isn_arg.storeindex.si_class = NULL;
2714
2715 if (dest_type == VAR_OBJECT)
2716 {
Bram Moolenaarb1e32ac2023-02-21 12:38:51 +00002717 class_T *cl = lhs->lhs_type->tt_class;
Bram Moolenaarf7d1c6e2023-01-16 20:47:57 +00002718
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002719 if (IS_INTERFACE(cl))
Bram Moolenaarf7d1c6e2023-01-16 20:47:57 +00002720 {
2721 // "this.value": load "this" object and get the value
2722 // at index for an object or class member get the type
2723 // of the member
2724 isn->isn_arg.storeindex.si_class = cl;
2725 ++cl->class_refcount;
2726 }
2727 }
Bram Moolenaar68452172021-04-12 21:21:02 +02002728 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01002729 }
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002730 else if (range)
2731 {
2732 if (generate_instr_drop(cctx, ISN_UNLETRANGE, 3) == NULL)
2733 return FAIL;
2734 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01002735 else
2736 {
2737 if (generate_instr_drop(cctx, ISN_UNLETINDEX, 2) == NULL)
2738 return FAIL;
2739 }
2740 }
2741 else
2742 {
2743 emsg(_(e_indexable_type_required));
2744 return FAIL;
2745 }
2746
2747 return OK;
2748}
2749
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01002750/*
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00002751 * Generate an instruction to push the default value for "vartype".
2752 * if "dest_local" is TRUE then for some types no instruction is generated.
2753 * "skip_store" is set to TRUE if no PUSH instruction is generated.
2754 * Returns OK or FAIL.
2755 */
2756 static int
2757push_default_value(
2758 cctx_T *cctx,
2759 vartype_T vartype,
2760 int dest_is_local,
2761 int *skip_store)
2762{
2763 int r = OK;
2764
2765 switch (vartype)
2766 {
2767 case VAR_BOOL:
2768 r = generate_PUSHBOOL(cctx, VVAL_FALSE);
2769 break;
2770 case VAR_FLOAT:
2771 r = generate_PUSHF(cctx, 0.0);
2772 break;
2773 case VAR_STRING:
2774 r = generate_PUSHS(cctx, NULL);
2775 break;
2776 case VAR_BLOB:
2777 r = generate_PUSHBLOB(cctx, blob_alloc());
2778 break;
2779 case VAR_FUNC:
2780 r = generate_PUSHFUNC(cctx, NULL, &t_func_void, TRUE);
2781 break;
2782 case VAR_LIST:
2783 r = generate_NEWLIST(cctx, 0, FALSE);
2784 break;
2785 case VAR_DICT:
2786 r = generate_NEWDICT(cctx, 0, FALSE);
2787 break;
2788 case VAR_JOB:
2789 r = generate_PUSHJOB(cctx);
2790 break;
2791 case VAR_CHANNEL:
2792 r = generate_PUSHCHANNEL(cctx);
2793 break;
Ernie Rael5c018be2023-08-27 18:40:26 +02002794 case VAR_OBJECT:
2795 r = generate_PUSHOBJ(cctx);
2796 break;
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00002797 case VAR_NUMBER:
2798 case VAR_UNKNOWN:
2799 case VAR_ANY:
2800 case VAR_PARTIAL:
2801 case VAR_VOID:
2802 case VAR_INSTR:
2803 case VAR_CLASS:
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02002804 case VAR_TYPEALIAS:
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00002805 case VAR_SPECIAL: // cannot happen
2806 // This is skipped for local variables, they are always
2807 // initialized to zero. But in a "for" or "while" loop
2808 // the value may have been changed.
2809 if (dest_is_local && !inside_loop_scope(cctx))
2810 *skip_store = TRUE;
2811 else
2812 r = generate_PUSHNR(cctx, 0);
2813 break;
2814 }
2815 return r;
2816}
2817
2818/*
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002819 * Compile assignment context. Used when compiling an assignment statement.
2820 */
2821typedef struct cac_S cac_T;
2822struct cac_S
2823{
2824 cmdidx_T cac_cmdidx; // assignment command
2825 char_u *cac_nextc; // next character to parse
2826 lhs_T cac_lhs; // lhs of the assignment
2827 type_T *cac_rhs_type; // rhs type of an assignment
2828 char_u *cac_op; // assignment operator
2829 int cac_oplen; // assignment operator length
2830 char_u *cac_var_start; // start of the variable names
2831 char_u *cac_var_end; // end of the variable names
2832 int cac_var_count; // number of variables in assignment
2833 int cac_var_idx; // variable index in a list
2834 int cac_semicolon; // semicolon in [var1, var2; var3]
2835 garray_T *cac_instr;
2836 int cac_instr_count;
2837 int cac_incdec;
2838 int cac_did_generate_slice;
2839 int cac_is_decl;
2840 int cac_is_const;
2841 int cac_start_lnum;
2842 type_T *cac_inferred_type;
2843 int cac_skip_store;
2844};
2845
2846/*
2847 * Initialize the compile assignment context.
2848 */
2849 static void
2850compile_assign_context_init(cac_T *cac, cctx_T *cctx, int cmdidx, char_u *arg)
2851{
2852 CLEAR_FIELD(*cac);
2853 cac->cac_cmdidx = cmdidx;
2854 cac->cac_instr = &cctx->ctx_instr;
2855 cac->cac_rhs_type = &t_any;
2856 cac->cac_is_decl = is_decl_command(cmdidx);
2857 cac->cac_start_lnum = SOURCING_LNUM;
2858 cac->cac_instr_count = -1;
2859 cac->cac_var_end = arg;
2860}
2861
2862/*
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01002863 * Compile an object member variable assignment in the arguments passed to a
2864 * class new() method.
2865 *
2866 * Instruction format:
2867 *
2868 * ifargisset <n> this.<varname> = <value>
2869 *
2870 * where <n> is the index of the default argument.
2871 *
2872 * Generates the ISN_JUMP_IF_ARG_NOT_SET instruction to skip the assignment if
2873 * the value is passed as an argument to the new() method call.
2874 *
2875 * Returns OK on success.
2876 */
2877 static int
2878compile_assign_obj_new_arg(char_u **argp, cctx_T *cctx)
2879{
2880 char_u *arg = *argp;
2881
2882 arg += 11; // skip "ifargisset"
2883 int def_arg_idx = getdigits(&arg);
2884 arg = skipwhite(arg);
2885
2886 // Use a JUMP_IF_ARG_NOT_SET instruction to skip if the value was not
2887 // given and the default value is "v:none".
2888 int stack_offset = STACK_FRAME_SIZE +
2889 (cctx->ctx_ufunc->uf_va_name != NULL ? 1 : 0);
2890 int def_arg_count = cctx->ctx_ufunc->uf_def_args.ga_len;
2891 int arg_offset = def_arg_idx - def_arg_count - stack_offset;
2892
2893 if (generate_JUMP_IF_ARG(cctx, ISN_JUMP_IF_ARG_NOT_SET,
2894 arg_offset) == FAIL)
2895 return FAIL;
2896
2897 *argp = arg;
2898 return OK;
2899}
2900
2901/*
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002902 * Translate the increment (++) and decrement (--) operators to the
2903 * corresponding compound operators (+= or -=).
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01002904 *
2905 * Returns OK on success and FAIL on syntax error.
2906 */
2907 static int
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002908translate_incdec_op(exarg_T *eap, cac_T *cac)
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01002909{
2910 if (VIM_ISWHITE(eap->cmd[2]))
2911 {
2912 semsg(_(e_no_white_space_allowed_after_str_str),
2913 eap->cmdidx == CMD_increment ? "++" : "--", eap->cmd);
2914 return FAIL;
2915 }
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002916 cac->cac_op = (char_u *)(eap->cmdidx == CMD_increment ? "+=" : "-=");
2917 cac->cac_oplen = 2;
2918 cac->cac_incdec = TRUE;
2919
2920 return OK;
2921}
2922
2923/*
2924 * Process the operator in an assignment statement.
2925 */
2926 static int
2927compile_assign_process_operator(
2928 exarg_T *eap,
2929 char_u *arg,
2930 cac_T *cac,
2931 int *heredoc,
2932 char_u **retstr)
2933{
2934 *retstr = NULL;
2935
2936 if (eap->cmdidx == CMD_increment || eap->cmdidx == CMD_decrement)
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002937 // Change an unary operator to a compound operator
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01002938 return translate_incdec_op(eap, cac);
2939
2940 char_u *sp = cac->cac_nextc;
2941 cac->cac_nextc = skipwhite(cac->cac_nextc);
2942 cac->cac_op = cac->cac_nextc;
2943 cac->cac_oplen = assignment_len(cac->cac_nextc, heredoc);
2944
2945 if (cac->cac_var_count > 0 && cac->cac_oplen == 0)
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002946 {
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01002947 // can be something like "[1, 2]->func()"
2948 *retstr = arg;
2949 return FAIL;
2950 }
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002951
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01002952 // need white space before and after the operator
2953 if (cac->cac_oplen > 0 && (!VIM_ISWHITE(*sp)
2954 || !IS_WHITE_OR_NUL(cac->cac_op[cac->cac_oplen])))
2955 {
2956 error_white_both(cac->cac_op, cac->cac_oplen);
2957 return FAIL;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002958 }
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01002959
2960 return OK;
2961}
2962
2963/*
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01002964 * Find the start of an assignment statement.
2965 */
2966 static char_u *
2967compile_assign_compute_start(char_u *arg, int var_count)
2968{
2969 if (var_count > 0)
2970 // [var1, var2] = [val1, val2]
2971 // skip over the "["
2972 return skipwhite(arg + 1);
2973
2974 return arg;
2975}
2976
2977/*
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01002978 * Parse a heredoc assignment starting at "p". Returns a pointer to the
2979 * beginning of the heredoc content.
2980 */
2981 static char_u *
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002982parse_heredoc_assignment(exarg_T *eap, cctx_T *cctx, cac_T *cac)
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01002983{
2984 // [let] varname =<< [trim] {end}
2985 eap->ea_getline = exarg_getline;
2986 eap->cookie = cctx;
2987
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002988 list_T *l = heredoc_get(eap, cac->cac_nextc + 3, FALSE, TRUE);
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01002989 if (l == NULL)
2990 return NULL;
2991
2992 list_free(l);
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002993 cac->cac_nextc += STRLEN(cac->cac_nextc);
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01002994
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002995 return cac->cac_nextc;
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01002996}
2997
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01002998/*
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01002999 * Check the type of a RHS expression in a list assignment statement.
3000 * The RHS expression is already compiled. So the type is on the stack.
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003001 */
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003002 static int
3003compile_assign_list_check_rhs_type(cctx_T *cctx, cac_T *cac)
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01003004{
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003005 type_T *stacktype;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003006
3007 stacktype = cctx->ctx_type_stack.ga_len == 0 ? &t_void
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01003008 : get_type_on_stack(cctx, 0);
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003009 if (stacktype->tt_type == VAR_VOID)
3010 {
3011 emsg(_(e_cannot_use_void_value));
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003012 return FAIL;
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01003013 }
3014
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003015 if (need_type(stacktype, &t_list_any, FALSE, -1, 0, cctx,
3016 FALSE, FALSE) == FAIL)
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003017 return FAIL;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003018
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003019 if (stacktype->tt_member != NULL)
3020 cac->cac_rhs_type = stacktype->tt_member;
3021
3022 return OK;
3023}
3024
3025/*
3026 * In a list assignment statement, if a constant list was used, check the
3027 * length. Returns OK if the length check succeeds. Returns FAIL otherwise.
3028 */
3029 static int
3030compile_assign_list_check_length(cctx_T *cctx, cac_T *cac)
3031{
3032 int needed_list_len;
3033 int did_check = FALSE;
3034
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003035 needed_list_len = cac->cac_semicolon
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003036 ? cac->cac_var_count - 1
3037 : cac->cac_var_count;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003038 if (cac->cac_instr->ga_len > 0)
3039 {
3040 isn_T *isn = ((isn_T *)cac->cac_instr->ga_data) +
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003041 cac->cac_instr->ga_len - 1;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003042
3043 if (isn->isn_type == ISN_NEWLIST)
3044 {
3045 did_check = TRUE;
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003046 if (cac->cac_semicolon ?
3047 isn->isn_arg.number < needed_list_len
3048 : isn->isn_arg.number != needed_list_len)
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003049 {
3050 semsg(_(e_expected_nr_items_but_got_nr),
3051 needed_list_len, (int)isn->isn_arg.number);
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003052 return FAIL;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003053 }
3054 }
3055 }
3056
3057 if (!did_check)
3058 generate_CHECKLEN(cctx, needed_list_len, cac->cac_semicolon);
3059
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003060 return OK;
3061}
3062
3063/*
3064 * Evaluate the expression for "[var, var] = expr" assignment.
3065 * A line break may follow the assignment operator "=".
3066 */
3067 static char_u *
3068compile_assign_list_expr(cctx_T *cctx, cac_T *cac)
3069{
3070 char_u *whitep;
3071
3072 whitep = cac->cac_op + cac->cac_oplen;
3073
3074 if (may_get_next_line_error(whitep, &cac->cac_nextc, cctx) == FAIL)
3075 return NULL;
3076
3077 // compile RHS expression
3078 if (compile_expr0(&cac->cac_nextc, cctx) == FAIL)
3079 return NULL;
3080
3081 if (cctx->ctx_skip == SKIP_YES)
3082 // no need to parse more when skipping
3083 return cac->cac_nextc;
3084
3085 if (compile_assign_list_check_rhs_type(cctx, cac) == FAIL)
3086 return NULL;
3087
3088 // If a constant list was used we can check the length right here.
3089 if (compile_assign_list_check_length(cctx, cac) == FAIL)
3090 return FAIL;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003091
3092 return cac->cac_nextc;
3093}
3094
3095/*
3096 * Find and return the end of a heredoc or a list of variables assignment
3097 * statement. For a single variable assignment statement, returns the current
3098 * end.
3099 * Returns NULL on failure.
3100 */
3101 static char_u *
3102compile_assign_compute_end(
3103 exarg_T *eap,
3104 cctx_T *cctx,
3105 cac_T *cac,
3106 int heredoc)
3107{
3108 if (heredoc)
3109 {
3110 cac->cac_nextc = parse_heredoc_assignment(eap, cctx, cac);
3111 return cac->cac_nextc;
3112 }
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003113
3114 if (cac->cac_var_count > 0)
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003115 {
3116 // for "[var, var] = expr" evaluate the expression. The list of
3117 // variables are processed later.
3118 // A line break may follow the "=".
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003119 cac->cac_nextc = compile_assign_list_expr(cctx, cac);
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003120 return cac->cac_nextc;
3121 }
3122
3123 return cac->cac_var_end;
3124}
3125
3126/*
3127 * For "var = expr" evaluate the expression.
3128 */
3129 static int
3130compile_assign_single_eval_expr(cctx_T *cctx, cac_T *cac)
3131{
3132 int ret = OK;
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003133 char_u *whitep;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003134 lhs_T *lhs = &cac->cac_lhs;
3135
3136 // Compile the expression.
3137 if (cac->cac_incdec)
3138 return generate_PUSHNR(cctx, 1);
3139
3140 // Temporarily hide the new local variable here, it is
3141 // not available to this expression.
3142 if (lhs->lhs_new_local)
3143 --cctx->ctx_locals.ga_len;
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003144 whitep = cac->cac_op + cac->cac_oplen;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003145
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003146 if (may_get_next_line_error(whitep, &cac->cac_nextc, cctx) == FAIL)
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003147 {
3148 if (lhs->lhs_new_local)
3149 ++cctx->ctx_locals.ga_len;
3150 return FAIL;
3151 }
3152
3153 ret = compile_expr0_ext(&cac->cac_nextc, cctx, &cac->cac_is_const);
3154 if (lhs->lhs_new_local)
3155 ++cctx->ctx_locals.ga_len;
3156
3157 return ret;
3158}
3159
3160/*
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003161 * When compiling an assignment, set the LHS type to the RHS type.
3162 */
3163 static int
3164compile_assign_set_lhs_type_from_rhs(
3165 cctx_T *cctx,
3166 cac_T *cac,
3167 lhs_T *lhs,
3168 type_T *rhs_type)
3169{
3170 if (rhs_type->tt_type == VAR_VOID)
3171 {
3172 emsg(_(e_cannot_use_void_value));
3173 return FAIL;
3174 }
3175
3176 type_T *type;
3177
3178 // An empty list or dict has a &t_unknown member, for a variable that
3179 // implies &t_any.
3180 if (rhs_type == &t_list_empty)
3181 type = &t_list_any;
3182 else if (rhs_type == &t_dict_empty)
3183 type = &t_dict_any;
3184 else if (rhs_type == &t_unknown)
3185 type = &t_any;
3186 else
3187 {
3188 type = rhs_type;
3189 cac->cac_inferred_type = rhs_type;
3190 }
3191
3192 set_var_type(lhs->lhs_lvar, type, cctx);
3193
3194 return OK;
3195}
3196
3197/*
3198 * Returns TRUE if the "rhs_type" can be assigned to the "lhs" variable.
3199 * Used when compiling an assignment statement.
3200 */
3201 static int
3202compile_assign_valid_rhs_type(
3203 cctx_T *cctx,
3204 cac_T *cac,
3205 lhs_T *lhs,
3206 type_T *rhs_type)
3207{
3208 type_T *use_type = lhs->lhs_lvar->lv_type;
3209 where_T where = WHERE_INIT;
3210
3211 // Without operator check type here, otherwise below.
3212 // Use the line number of the assignment.
3213 SOURCING_LNUM = cac->cac_start_lnum;
3214 if (cac->cac_var_count > 0)
3215 {
3216 where.wt_index = cac->cac_var_idx + 1;
3217 where.wt_kind = WT_VARIABLE;
3218 }
3219
3220 // If assigning to a list or dict member, use the member type.
3221 // Not for "list[:] =".
3222 if (lhs->lhs_has_index &&
3223 !has_list_index(cac->cac_var_start + lhs->lhs_varlen, cctx))
3224 use_type = lhs->lhs_member_type;
3225
3226 if (need_type_where(rhs_type, use_type, FALSE, -1, where, cctx, FALSE,
3227 cac->cac_is_const) == FAIL)
3228 return FALSE;
3229
3230 return TRUE;
3231}
3232
3233/*
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003234 * Compare the LHS type with the RHS type in an assignment.
3235 */
3236 static int
3237compile_assign_check_type(cctx_T *cctx, cac_T *cac)
3238{
3239 lhs_T *lhs = &cac->cac_lhs;
3240 type_T *rhs_type;
3241
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003242 rhs_type = cctx->ctx_type_stack.ga_len == 0
3243 ? &t_void
3244 : get_type_on_stack(cctx, 0);
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003245 cac->cac_rhs_type = rhs_type;
3246
3247 if (check_type_is_value(rhs_type) == FAIL)
3248 return FAIL;
3249
3250 if (lhs->lhs_lvar != NULL && (cac->cac_is_decl || !lhs->lhs_has_type))
3251 {
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003252 if (rhs_type->tt_type == VAR_FUNC
3253 || rhs_type->tt_type == VAR_PARTIAL)
3254 {
3255 // Make sure the variable name can be used as a funcref
3256 if (!lhs->lhs_has_index
3257 && var_wrong_func_name(lhs->lhs_name, TRUE))
3258 return FAIL;
3259 }
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003260
3261 if (lhs->lhs_new_local && !lhs->lhs_has_type)
3262 {
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003263 // The LHS variable doesn't have a type. Set it to the RHS type.
3264 if (compile_assign_set_lhs_type_from_rhs(cctx, cac, lhs, rhs_type)
3265 == FAIL)
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003266 return FAIL;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003267 }
3268 else if (*cac->cac_op == '=')
3269 {
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003270 if (!compile_assign_valid_rhs_type(cctx, cac, lhs, rhs_type))
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003271 return FAIL;
3272 }
3273 }
3274 else
3275 {
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003276 // Assigning to a register using @r = "abc"
3277
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003278 type_T *lhs_type = lhs->lhs_member_type;
3279
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003280 // Special case: assigning to @# can use a number or a string.
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003281 // Also: can assign a number to a float.
3282 if ((lhs_type == &t_number_or_string || lhs_type == &t_float)
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003283 && rhs_type->tt_type == VAR_NUMBER)
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003284 lhs_type = &t_number;
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003285
3286 if (*cac->cac_nextc != '=')
3287 {
3288 if (need_type(rhs_type, lhs_type, FALSE, -1, 0, cctx, FALSE,
3289 FALSE) == FAIL)
3290 return FAIL;
3291 }
3292 }
3293
3294 return OK;
3295}
3296
3297/*
3298 * Compile the RHS expression in an assignment statement and generate the
3299 * instructions.
3300 */
3301 static int
3302compile_assign_rhs_expr(cctx_T *cctx, cac_T *cac)
3303{
3304 cac->cac_is_const = FALSE;
3305
3306 // for "+=", "*=", "..=" etc. first load the current value
3307 if (*cac->cac_op != '='
3308 && compile_load_lhs_with_index(&cac->cac_lhs, cac->cac_var_start,
3309 cctx) == FAIL)
3310 return FAIL;
3311
3312 // For "var = expr" evaluate the expression.
3313 if (cac->cac_var_count == 0)
3314 {
3315 int ret;
3316
3317 // Compile the expression.
3318 cac->cac_instr_count = cac->cac_instr->ga_len;
3319 ret = compile_assign_single_eval_expr(cctx, cac);
3320 if (ret == FAIL)
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003321 return FAIL;
3322 }
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003323 else if (cac->cac_semicolon && cac->cac_var_idx == cac->cac_var_count - 1)
3324 {
3325 // For "[var; var] = expr" get the rest of the list
3326 cac->cac_did_generate_slice = TRUE;
3327 if (generate_SLICE(cctx, cac->cac_var_count - 1) == FAIL)
3328 return FAIL;
3329 }
3330 else
3331 {
3332 // For "[var, var] = expr" get the "var_idx" item from the
3333 // list.
3334 int with_op = *cac->cac_op != '=';
3335 if (generate_GETITEM(cctx, cac->cac_var_idx, with_op) == FAIL)
3336 return FAIL;
3337 }
3338
3339 if (compile_assign_check_type(cctx, cac) == FAIL)
3340 return FAIL;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003341
3342 return OK;
3343}
3344
3345/*
3346 * Compile the RHS expression in an assignment
3347 */
3348 static int
3349compile_assign_rhs(cctx_T *cctx, cac_T *cac)
3350{
3351 lhs_T *lhs = &cac->cac_lhs;
3352
3353 if (cctx->ctx_skip == SKIP_YES)
3354 {
3355 if (cac->cac_oplen > 0 && cac->cac_var_count == 0)
3356 {
3357 // skip over the "=" and the expression
3358 cac->cac_nextc = skipwhite(cac->cac_op + cac->cac_oplen);
3359 (void)compile_expr0(&cac->cac_nextc, cctx);
3360 }
3361 return OK;
3362 }
3363
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003364 // If RHS is specified, then generate instructions for RHS expression
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003365 if (cac->cac_oplen > 0)
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003366 return compile_assign_rhs_expr(cctx, cac);
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003367
3368 if (cac->cac_cmdidx == CMD_final)
3369 {
3370 emsg(_(e_final_requires_a_value));
3371 return FAIL;
3372 }
3373
3374 if (cac->cac_cmdidx == CMD_const)
3375 {
3376 emsg(_(e_const_requires_a_value));
3377 return FAIL;
3378 }
3379
3380 if (!lhs->lhs_has_type || lhs->lhs_dest == dest_option
3381 || lhs->lhs_dest == dest_func_option)
3382 {
3383 emsg(_(e_type_or_initialization_required));
3384 return FAIL;
3385 }
3386
3387 // variables are always initialized
3388 if (GA_GROW_FAILS(cac->cac_instr, 1))
3389 return FAIL;
3390
3391 cac->cac_instr_count = cac->cac_instr->ga_len;
3392
3393 return push_default_value(cctx, lhs->lhs_member_type->tt_type,
3394 lhs->lhs_dest == dest_local,
3395 &cac->cac_skip_store);
3396}
3397
3398/*
3399 * Compile a compound op assignment statement (+=, -=, *=, %=, etc.)
3400 */
3401 static int
3402compile_assign_compound_op(cctx_T *cctx, cac_T *cac)
3403{
3404 lhs_T *lhs = &cac->cac_lhs;
3405 type_T *expected;
3406 type_T *stacktype = NULL;
3407
3408 if (*cac->cac_op == '.')
3409 {
3410 if (may_generate_2STRING(-1, TOSTRING_NONE, cctx) == FAIL)
3411 return FAIL;
3412 }
3413 else
3414 {
3415 expected = lhs->lhs_member_type;
3416 stacktype = get_type_on_stack(cctx, 0);
3417 if (
3418 // If variable is float operation with number is OK.
3419 !(expected == &t_float && (stacktype == &t_number
3420 || stacktype == &t_number_bool))
3421 && need_type(stacktype, expected, TRUE, -1, 0, cctx,
3422 FALSE, FALSE) == FAIL)
3423 return FAIL;
3424 }
3425
3426 if (*cac->cac_op == '.')
3427 {
3428 if (generate_CONCAT(cctx, 2) == FAIL)
3429 return FAIL;
3430 }
3431 else if (*cac->cac_op == '+')
3432 {
3433 if (generate_add_instr(cctx,
3434 operator_type(lhs->lhs_member_type, stacktype),
3435 lhs->lhs_member_type, stacktype,
3436 EXPR_APPEND) == FAIL)
3437 return FAIL;
3438 }
3439 else if (generate_two_op(cctx, cac->cac_op) == FAIL)
3440 return FAIL;
3441
3442 return OK;
3443}
3444
3445/*
3446 * Generate the STORE and SETTYPE instructions for an assignment statement.
3447 */
3448 static int
3449compile_assign_generate_store(cctx_T *cctx, cac_T *cac)
3450{
3451 lhs_T *lhs = &cac->cac_lhs;
3452 int save_lnum;
3453
3454 // Use the line number of the assignment for store instruction.
3455 save_lnum = cctx->ctx_lnum;
3456 cctx->ctx_lnum = cac->cac_start_lnum - 1;
3457
3458 if (lhs->lhs_has_index)
3459 {
3460 // Use the info in "lhs" to store the value at the index in the
3461 // list, dict or object.
3462 if (compile_assign_unlet(cac->cac_var_start, &cac->cac_lhs,
3463 TRUE, cac->cac_rhs_type, cctx) == FAIL)
3464 {
3465 cctx->ctx_lnum = save_lnum;
3466 return FAIL;
3467 }
3468 }
3469 else
3470 {
3471 if (cac->cac_is_decl && cac->cac_cmdidx == CMD_const &&
3472 (lhs->lhs_dest == dest_script
3473 || lhs->lhs_dest == dest_script_v9
3474 || lhs->lhs_dest == dest_global
3475 || lhs->lhs_dest == dest_local))
3476 // ":const var": lock the value, but not referenced variables
3477 generate_LOCKCONST(cctx);
3478
3479 type_T *inferred_type = cac->cac_inferred_type;
3480
3481 if ((lhs->lhs_type->tt_type == VAR_DICT
3482 || lhs->lhs_type->tt_type == VAR_LIST)
3483 && lhs->lhs_type->tt_member != NULL
3484 && lhs->lhs_type->tt_member != &t_any
3485 && lhs->lhs_type->tt_member != &t_unknown)
3486 // Set the type in the list or dict, so that it can be checked,
3487 // also in legacy script.
3488 generate_SETTYPE(cctx, lhs->lhs_type);
3489 else if (inferred_type != NULL
3490 && (inferred_type->tt_type == VAR_DICT
3491 || inferred_type->tt_type == VAR_LIST)
3492 && inferred_type->tt_member != NULL
3493 && inferred_type->tt_member != &t_unknown
3494 && inferred_type->tt_member != &t_any)
3495 // Set the type in the list or dict, so that it can be checked,
3496 // also in legacy script.
3497 generate_SETTYPE(cctx, inferred_type);
3498
3499 if (!cac->cac_skip_store &&
3500 generate_store_lhs(cctx, &cac->cac_lhs,
3501 cac->cac_instr_count,
3502 cac->cac_is_decl) == FAIL)
3503 {
3504 cctx->ctx_lnum = save_lnum;
3505 return FAIL;
3506 }
3507 }
3508
3509 cctx->ctx_lnum = save_lnum;
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003510
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003511 return OK;
3512}
3513
3514/*
3515 * Process the variable(s) in an assignment statement
3516 */
3517 static int
3518compile_assign_process_variables(
3519 cctx_T *cctx,
3520 cac_T *cac,
3521 int cmdidx,
3522 int heredoc,
3523 int has_cmd,
3524 int has_argisset_prefix,
3525 int jump_instr_idx)
3526{
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003527 /*
3528 * Loop over variables in "[var, var] = expr".
3529 * For "name = expr" and "var name: type" this is done only once.
3530 */
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003531 for (cac->cac_var_idx = 0; cac->cac_var_idx == 0 ||
3532 cac->cac_var_idx < cac->cac_var_count; cac->cac_var_idx++)
3533 {
3534 if (cac->cac_var_start[0] == '_'
3535 && !eval_isnamec(cac->cac_var_start[1]))
3536 {
3537 // Ignore underscore in "[a, _, b] = list".
3538 if (cac->cac_var_count > 0)
3539 {
3540 cac->cac_var_start = skipwhite(cac->cac_var_start + 2);
3541 continue;
3542 }
3543 emsg(_(e_cannot_use_underscore_here));
3544 return FAIL;
3545 }
3546 vim_free(cac->cac_lhs.lhs_name);
3547
3548 /*
3549 * Figure out the LHS type and other properties.
3550 */
3551 if (compile_assign_lhs(cac->cac_var_start, &cac->cac_lhs, cmdidx,
3552 cac->cac_is_decl, heredoc, has_cmd,
3553 cac->cac_oplen, cctx) == FAIL)
3554 return FAIL;
3555
3556 // Compile the RHS expression
3557 if (heredoc)
3558 {
3559 SOURCING_LNUM = cac->cac_start_lnum;
3560 if (cac->cac_lhs.lhs_has_type
3561 && need_type(&t_list_string, cac->cac_lhs.lhs_type,
3562 FALSE, -1, 0, cctx, FALSE, FALSE) == FAIL)
3563 return FAIL;
3564 }
3565 else
3566 {
3567 if (compile_assign_rhs(cctx, cac) == FAIL)
3568 return FAIL;
3569 if (cac->cac_var_count == 0)
3570 cac->cac_var_end = cac->cac_nextc;
3571 }
3572
3573 // no need to parse more when skipping
3574 if (cctx->ctx_skip == SKIP_YES)
3575 break;
3576
3577 if (cac->cac_oplen > 0 && *cac->cac_op != '=')
3578 {
3579 if (compile_assign_compound_op(cctx, cac) == FAIL)
3580 return FAIL;
3581 }
3582
3583 // generate the store instructions
3584 if (compile_assign_generate_store(cctx, cac) == FAIL)
3585 return FAIL;
3586
3587 if (cac->cac_var_idx + 1 < cac->cac_var_count)
3588 cac->cac_var_start = skipwhite(cac->cac_lhs.lhs_end + 1);
3589
3590 if (has_argisset_prefix)
3591 {
3592 // set instruction index in JUMP_IF_ARG_SET to here
3593 isn_T *isn = ((isn_T *)cac->cac_instr->ga_data) + jump_instr_idx;
3594 isn->isn_arg.jumparg.jump_where = cac->cac_instr->ga_len;
3595 }
3596 }
3597
3598 return OK;
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01003599}
3600
3601/*
Bram Moolenaar47a519a2020-06-14 23:05:10 +02003602 * Compile declaration and assignment:
Bram Moolenaar30fd8202020-09-26 15:09:30 +02003603 * "let name"
3604 * "var name = expr"
3605 * "final name = expr"
3606 * "const name = expr"
3607 * "name = expr"
3608 * "arg" points to "name".
Bram Moolenaarbdc0f1c2021-04-24 19:08:24 +02003609 * "++arg" and "--arg"
Bram Moolenaar47a519a2020-06-14 23:05:10 +02003610 * Return NULL for an error.
3611 * Return "arg" if it does not look like a variable list.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003612 */
3613 static char_u *
Bram Moolenaar65b0d162022-12-13 18:43:22 +00003614compile_assignment(
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003615 char_u *arg_start,
3616 exarg_T *eap,
3617 cmdidx_T cmdidx,
3618 cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003619{
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003620 cac_T cac;
Bram Moolenaar65b0d162022-12-13 18:43:22 +00003621 char_u *arg = arg_start;
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003622 char_u *retstr = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003623 int heredoc = FALSE;
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003624 int jump_instr_idx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003625
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003626 compile_assign_context_init(&cac, cctx, cmdidx, arg);
3627
3628 jump_instr_idx = cac.cac_instr->ga_len;
3629
3630 // process object variable initialization in a new() constructor method
3631 int has_argisset_prefix = STRNCMP(arg, "ifargisset ", 11) == 0;
3632 if (has_argisset_prefix &&
3633 compile_assign_obj_new_arg(&arg, cctx) == FAIL)
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01003634 goto theend;
Bram Moolenaar65b0d162022-12-13 18:43:22 +00003635
Bram Moolenaare1d12112022-03-05 11:37:48 +00003636 // Skip over the "varname" or "[varname, varname]" to get to any "=".
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003637 cac.cac_nextc = skip_var_list(arg, TRUE, &cac.cac_var_count,
3638 &cac.cac_semicolon, TRUE);
3639 if (cac.cac_nextc == NULL)
Bram Moolenaar47a519a2020-06-14 23:05:10 +02003640 return *arg == '[' ? arg : NULL;
3641
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003642 if (compile_assign_process_operator(eap, arg, &cac, &heredoc,
3643 &retstr) == FAIL)
3644 return retstr;
Yegappan Lakshmanan85ee7422024-12-08 10:15:35 +01003645
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003646 // Compute the start of the assignment
3647 cac.cac_var_start = compile_assign_compute_start(arg, cac.cac_var_count);
3648
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003649 // Compute the end of the assignment
3650 cac.cac_var_end = compile_assign_compute_end(eap, cctx, &cac, heredoc);
3651 if (cac.cac_var_end == NULL)
3652 return NULL;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02003653
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003654 int has_cmd = cac.cac_var_start > eap->cmd;
Bram Moolenaar752fc692021-01-04 21:57:11 +01003655
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003656 /* process the variable(s) */
3657 if (compile_assign_process_variables(cctx, &cac, cmdidx, heredoc,
3658 has_cmd, has_argisset_prefix,
3659 jump_instr_idx) == FAIL)
3660 goto theend;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02003661
Bram Moolenaar4d5dfe22021-06-26 13:59:29 +02003662 // For "[var, var] = expr" drop the "expr" value.
3663 // Also for "[var, var; _] = expr".
Yegappan Lakshmanane2038412024-12-14 19:59:24 +01003664 if (cctx->ctx_skip != SKIP_YES && cac.cac_var_count > 0 &&
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003665 (!cac.cac_semicolon || !cac.cac_did_generate_slice))
Bram Moolenaar9af78762020-06-16 11:34:42 +02003666 {
Bram Moolenaarec792292020-12-13 21:26:56 +01003667 if (generate_instr_drop(cctx, ISN_DROP, 1) == NULL)
Bram Moolenaar9af78762020-06-16 11:34:42 +02003668 goto theend;
3669 }
Bram Moolenaar47a519a2020-06-14 23:05:10 +02003670
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003671 retstr = skipwhite(cac.cac_var_end);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003672
3673theend:
Yegappan Lakshmanan95a03fc2024-12-13 11:54:54 +01003674 vim_free(cac.cac_lhs.lhs_name);
Yegappan Lakshmanan468db1f2024-12-16 20:56:56 +01003675 return retstr;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003676}
3677
3678/*
Bram Moolenaar17126b12021-01-07 22:03:02 +01003679 * Check for an assignment at "eap->cmd", compile it if found.
3680 * Return NOTDONE if there is none, FAIL for failure, OK if done.
3681 */
3682 static int
3683may_compile_assignment(exarg_T *eap, char_u **line, cctx_T *cctx)
3684{
3685 char_u *pskip;
3686 char_u *p;
3687
3688 // Assuming the command starts with a variable or function name,
3689 // find what follows.
3690 // Skip over "var.member", "var[idx]" and the like.
3691 // Also "&opt = val", "$ENV = val" and "@r = val".
3692 pskip = (*eap->cmd == '&' || *eap->cmd == '$' || *eap->cmd == '@')
3693 ? eap->cmd + 1 : eap->cmd;
3694 p = to_name_end(pskip, TRUE);
3695 if (p > eap->cmd && *p != NUL)
3696 {
3697 char_u *var_end;
3698 int oplen;
3699 int heredoc;
3700
3701 if (eap->cmd[0] == '@')
3702 var_end = eap->cmd + 2;
3703 else
3704 var_end = find_name_end(pskip, NULL, NULL,
3705 FNE_CHECK_START | FNE_INCL_BR);
3706 oplen = assignment_len(skipwhite(var_end), &heredoc);
3707 if (oplen > 0)
3708 {
3709 size_t len = p - eap->cmd;
3710
3711 // Recognize an assignment if we recognize the variable
3712 // name:
Bram Moolenaar17126b12021-01-07 22:03:02 +01003713 // "&opt = expr"
3714 // "$ENV = expr"
3715 // "@r = expr"
Bram Moolenaar2e17fef2022-03-18 19:44:48 +00003716 // "g:var = expr"
3717 // "g:[key] = expr"
3718 // "local = expr" where "local" is a local var.
3719 // "script = expr" where "script" is a script-local var.
3720 // "import = expr" where "import" is an imported var
Bram Moolenaar17126b12021-01-07 22:03:02 +01003721 if (*eap->cmd == '&'
3722 || *eap->cmd == '$'
3723 || *eap->cmd == '@'
3724 || ((len) > 2 && eap->cmd[1] == ':')
Bram Moolenaar2e17fef2022-03-18 19:44:48 +00003725 || STRNCMP(eap->cmd, "g:[", 3) == 0
Bram Moolenaare0890d62021-02-17 14:52:14 +01003726 || variable_exists(eap->cmd, len, cctx))
Bram Moolenaar17126b12021-01-07 22:03:02 +01003727 {
3728 *line = compile_assignment(eap->cmd, eap, CMD_SIZE, cctx);
3729 if (*line == NULL || *line == eap->cmd)
3730 return FAIL;
3731 return OK;
3732 }
3733 }
3734 }
3735
Bram Moolenaar65b0d162022-12-13 18:43:22 +00003736 // might be "[var, var] = expr" or "ifargisset this.member = expr"
3737 if (*eap->cmd == '[' || STRNCMP(eap->cmd, "ifargisset ", 11) == 0)
Bram Moolenaar17126b12021-01-07 22:03:02 +01003738 {
Bram Moolenaar17126b12021-01-07 22:03:02 +01003739 *line = compile_assignment(eap->cmd, eap, CMD_SIZE, cctx);
3740 if (*line == NULL)
3741 return FAIL;
3742 if (*line != eap->cmd)
3743 return OK;
3744 }
3745 return NOTDONE;
3746}
3747
Bram Moolenaar9a015112021-12-31 14:06:45 +00003748/*
3749 * Check if arguments of "ufunc" shadow variables in "cctx".
3750 * Return OK or FAIL.
3751 */
3752 static int
3753check_args_shadowing(ufunc_T *ufunc, cctx_T *cctx)
3754{
3755 int i;
3756 char_u *arg;
3757 int r = OK;
3758
3759 // Make sure arguments are not found when compiling a second time.
3760 ufunc->uf_args_visible = 0;
3761
3762 // Check for arguments shadowing variables from the context.
3763 for (i = 0; i < ufunc->uf_args.ga_len; ++i)
3764 {
3765 arg = ((char_u **)(ufunc->uf_args.ga_data))[i];
Bram Moolenaardce24412022-02-08 20:35:30 +00003766 if (check_defined(arg, STRLEN(arg), cctx, NULL, TRUE) == FAIL)
Bram Moolenaar9a015112021-12-31 14:06:45 +00003767 {
3768 r = FAIL;
3769 break;
3770 }
3771 }
3772 ufunc->uf_args_visible = ufunc->uf_args.ga_len;
3773 return r;
3774}
3775
Bram Moolenaarfcb86b02022-10-07 22:46:24 +01003776#ifdef HAS_MESSAGE_WINDOW
Bram Moolenaar139575d2022-03-15 19:29:30 +00003777/*
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003778 * Get a count before a command. Can only be a number.
3779 * Returns zero if there is no count.
3780 * Returns -1 if there is something wrong.
3781 */
3782 static long
3783get_cmd_count(char_u *line, exarg_T *eap)
3784{
3785 char_u *p;
3786
3787 // skip over colons and white space
3788 for (p = line; *p == ':' || VIM_ISWHITE(*p); ++p)
3789 ;
Keith Thompson184f71c2024-01-04 21:19:04 +01003790 if (!SAFE_isdigit(*p))
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003791 {
Bram Moolenaar2435adf2022-10-21 12:05:46 +01003792 // The command or modifiers must be following. Assume a lower case
3793 // character means there is a modifier.
3794 if (p < eap->cmd && !vim_islower(*p))
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003795 {
3796 emsg(_(e_invalid_range));
3797 return -1;
3798 }
3799 return 0;
3800 }
3801 return atol((char *)p);
3802}
Bram Moolenaarfcb86b02022-10-07 22:46:24 +01003803#endif
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003804
3805/*
Bram Moolenaar139575d2022-03-15 19:29:30 +00003806 * Get the compilation type that should be used for "ufunc".
3807 * Keep in sync with INSTRUCTIONS().
3808 */
3809 compiletype_T
3810get_compile_type(ufunc_T *ufunc)
3811{
3812 // Update uf_has_breakpoint if needed.
3813 update_has_breakpoint(ufunc);
3814
3815 if (debug_break_level > 0 || may_break_in_function(ufunc))
3816 return CT_DEBUG;
3817#ifdef FEAT_PROFILE
3818 if (do_profiling == PROF_YES)
3819 {
Ernie Rael21d32122023-09-02 15:09:18 +02003820 if (!ufunc->uf_profiling && has_profiling(FALSE, ufunc->uf_name, NULL,
3821 &ufunc->uf_hash))
Bram Moolenaar139575d2022-03-15 19:29:30 +00003822 func_do_profile(ufunc);
3823 if (ufunc->uf_profiling)
3824 return CT_PROFILE;
3825 }
3826#endif
3827 return CT_NONE;
3828}
3829
Bram Moolenaar7b829262021-10-13 15:04:34 +01003830
3831/*
Bram Moolenaar09689a02020-05-09 22:50:08 +02003832 * Add a function to the list of :def functions.
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003833 * This sets "ufunc->uf_dfunc_idx" but the function isn't compiled yet.
Bram Moolenaar09689a02020-05-09 22:50:08 +02003834 */
Bram Moolenaar822ba242020-05-24 23:00:18 +02003835 static int
Bram Moolenaar09689a02020-05-09 22:50:08 +02003836add_def_function(ufunc_T *ufunc)
3837{
3838 dfunc_T *dfunc;
3839
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003840 if (def_functions.ga_len == 0)
3841 {
3842 // The first position is not used, so that a zero uf_dfunc_idx means it
3843 // wasn't set.
Bram Moolenaar35578162021-08-02 19:10:38 +02003844 if (GA_GROW_FAILS(&def_functions, 1))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003845 return FAIL;
3846 ++def_functions.ga_len;
3847 }
3848
Bram Moolenaar09689a02020-05-09 22:50:08 +02003849 // Add the function to "def_functions".
Bram Moolenaar35578162021-08-02 19:10:38 +02003850 if (GA_GROW_FAILS(&def_functions, 1))
Bram Moolenaar09689a02020-05-09 22:50:08 +02003851 return FAIL;
3852 dfunc = ((dfunc_T *)def_functions.ga_data) + def_functions.ga_len;
3853 CLEAR_POINTER(dfunc);
3854 dfunc->df_idx = def_functions.ga_len;
3855 ufunc->uf_dfunc_idx = dfunc->df_idx;
3856 dfunc->df_ufunc = ufunc;
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01003857 dfunc->df_name = vim_strsave(ufunc->uf_name);
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02003858 ga_init2(&dfunc->df_var_names, sizeof(char_u *), 10);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01003859 ++dfunc->df_refcount;
Bram Moolenaar09689a02020-05-09 22:50:08 +02003860 ++def_functions.ga_len;
3861 return OK;
3862}
3863
3864/*
Yegappan Lakshmananf6c1fb22024-04-25 21:30:56 +02003865 * For an object constructor, generate instruction to setup "this" (the first
3866 * local variable) and to initialize the object variables.
3867 */
3868 static int
3869obj_constructor_prologue(ufunc_T *ufunc, cctx_T *cctx)
3870{
3871 generate_CONSTRUCT(cctx, ufunc->uf_class);
3872
3873 for (int i = 0; i < ufunc->uf_class->class_obj_member_count; ++i)
3874 {
3875 ocmember_T *m = &ufunc->uf_class->class_obj_members[i];
3876
3877 if (i < 2 && IS_ENUM(ufunc->uf_class))
3878 // The first two object variables in an enum are the name
3879 // and the ordinal. These are set by the ISN_CONSTRUCT
3880 // instruction. So don't generate instructions to set
3881 // these variables.
3882 continue;
3883
3884 if (m->ocm_init != NULL)
3885 {
3886 char_u *expr = m->ocm_init;
3887
3888 if (compile_expr0(&expr, cctx) == FAIL)
3889 return FAIL;
3890
3891 if (!ends_excmd2(m->ocm_init, expr))
3892 {
3893 semsg(_(e_trailing_characters_str), expr);
3894 return FAIL;
3895 }
3896
3897 type_T *type = get_type_on_stack(cctx, 0);
3898 if (m->ocm_type->tt_type == VAR_ANY
3899 && !(m->ocm_flags & OCMFLAG_HAS_TYPE)
3900 && type->tt_type != VAR_SPECIAL)
3901 {
3902 // If the member variable type is not yet set, then use
3903 // the initialization expression type.
3904 m->ocm_type = type;
3905 }
LemonBoyf4af3312024-07-04 13:43:12 +02003906 else
Yegappan Lakshmananf6c1fb22024-04-25 21:30:56 +02003907 {
3908 // The type of the member initialization expression is
3909 // determined at run time. Add a runtime type check.
3910 where_T where = WHERE_INIT;
3911 where.wt_kind = WT_MEMBER;
3912 where.wt_func_name = (char *)m->ocm_name;
3913 if (need_type_where(type, m->ocm_type, FALSE, -1,
3914 where, cctx, FALSE, FALSE) == FAIL)
3915 return FAIL;
3916 }
3917 }
3918 else
3919 push_default_value(cctx, m->ocm_type->tt_type, FALSE, NULL);
3920
LemonBoyf4af3312024-07-04 13:43:12 +02003921 if ((m->ocm_type->tt_type == VAR_DICT
3922 || m->ocm_type->tt_type == VAR_LIST)
3923 && m->ocm_type->tt_member != NULL
3924 && m->ocm_type->tt_member != &t_any
3925 && m->ocm_type->tt_member != &t_unknown)
3926 // Set the type in the list or dict, so that it can be checked,
3927 // also in legacy script.
3928 generate_SETTYPE(cctx, m->ocm_type);
3929
Yegappan Lakshmananf6c1fb22024-04-25 21:30:56 +02003930 generate_STORE_THIS(cctx, i);
3931 }
3932
3933 return OK;
3934}
3935
3936/*
3937 * For an object method and an constructor, generate instruction to setup
3938 * "this" (the first local variable). For a constructor, generate instructions
3939 * to initialize the object variables.
3940 */
3941 static int
3942obj_method_prologue(ufunc_T *ufunc, cctx_T *cctx)
3943{
3944 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data) + ufunc->uf_dfunc_idx;
3945
3946 if (GA_GROW_FAILS(&dfunc->df_var_names, 1))
3947 return FAIL;
3948
3949 ((char_u **)dfunc->df_var_names.ga_data)[0] =
3950 vim_strsave((char_u *)"this");
3951 ++dfunc->df_var_names.ga_len;
3952
3953 // In the constructor allocate memory for the object and initialize the
3954 // object members.
3955 if (IS_CONSTRUCTOR_METHOD(ufunc))
3956 return obj_constructor_prologue(ufunc, cctx);
3957
3958 return OK;
3959}
3960
3961/*
3962 * Produce instructions for the default values of optional arguments.
3963 */
3964 static int
3965compile_def_function_default_args(
3966 ufunc_T *ufunc,
3967 cctx_T *cctx,
3968 garray_T *instr)
3969{
3970 int count = ufunc->uf_def_args.ga_len;
3971 int first_def_arg = ufunc->uf_args.ga_len - count;
3972 int i;
3973 int off = STACK_FRAME_SIZE + (ufunc->uf_va_name != NULL ? 1 : 0);
3974 int did_set_arg_type = FALSE;
3975
3976 // Produce instructions for the default values of optional arguments.
3977 SOURCING_LNUM = 0; // line number unknown
3978 for (i = 0; i < count; ++i)
3979 {
3980 char_u *arg = ((char_u **)(ufunc->uf_def_args.ga_data))[i];
3981 if (STRCMP(arg, "v:none") == 0)
3982 // "arg = v:none" means the argument is optional without
3983 // setting a value when the argument is missing.
3984 continue;
3985
3986 type_T *val_type;
3987 int arg_idx = first_def_arg + i;
3988 where_T where = WHERE_INIT;
3989 int jump_instr_idx = instr->ga_len;
3990 isn_T *isn;
3991
3992 // Use a JUMP_IF_ARG_SET instruction to skip if the value was given.
3993 if (generate_JUMP_IF_ARG(cctx, ISN_JUMP_IF_ARG_SET,
3994 i - count - off) == FAIL)
3995 return FAIL;
3996
3997 // Make sure later arguments are not found.
3998 ufunc->uf_args_visible = arg_idx;
3999
4000 int r = compile_expr0(&arg, cctx);
4001 if (r == FAIL)
4002 return FAIL;
4003
4004 // If no type specified use the type of the default value.
4005 // Otherwise check that the default value type matches the
4006 // specified type.
4007 val_type = get_type_on_stack(cctx, 0);
4008 where.wt_index = arg_idx + 1;
4009 where.wt_kind = WT_ARGUMENT;
4010 if (ufunc->uf_arg_types[arg_idx] == &t_unknown)
4011 {
4012 did_set_arg_type = TRUE;
4013 ufunc->uf_arg_types[arg_idx] = val_type;
4014 }
4015 else if (need_type_where(val_type, ufunc->uf_arg_types[arg_idx],
4016 FALSE, -1, where, cctx, FALSE, FALSE) == FAIL)
4017 return FAIL;
4018
4019 if (generate_STORE(cctx, ISN_STORE, i - count - off, NULL) == FAIL)
4020 return FAIL;
4021
4022 // set instruction index in JUMP_IF_ARG_SET to here
4023 isn = ((isn_T *)instr->ga_data) + jump_instr_idx;
4024 isn->isn_arg.jumparg.jump_where = instr->ga_len;
4025 }
4026
4027 if (did_set_arg_type)
4028 set_function_type(ufunc);
4029
4030 return OK;
4031}
4032
4033/*
Yegappan Lakshmanana16f2512024-04-23 20:14:46 +02004034 * Compile def function body. Loop over all the lines in the function and
4035 * generate instructions.
4036 */
4037 static int
4038compile_def_function_body(
4039 cctx_T *cctx,
4040 int last_func_lnum,
4041 int check_return_type,
4042 garray_T *lines_to_free,
4043 char **errormsg)
4044{
4045 char_u *line = NULL;
4046 char_u *p;
4047 int did_emsg_before = did_emsg;
4048#ifdef FEAT_PROFILE
4049 int prof_lnum = -1;
4050#endif
4051 int debug_lnum = -1;
4052
4053 for (;;)
4054 {
4055 exarg_T ea;
4056 int starts_with_colon = FALSE;
4057 char_u *cmd;
4058 cmdmod_T local_cmdmod;
4059
4060 // Bail out on the first error to avoid a flood of errors and report
4061 // the right line number when inside try/catch.
4062 if (did_emsg_before != did_emsg)
4063 return FAIL;
4064
4065 if (line != NULL && *line == '|')
4066 // the line continues after a '|'
4067 ++line;
4068 else if (line != NULL && *skipwhite(line) != NUL
4069 && !(*line == '#' && (line == cctx->ctx_line_start
4070 || VIM_ISWHITE(line[-1]))))
4071 {
4072 semsg(_(e_trailing_characters_str), line);
4073 return FAIL;
4074 }
4075 else if (line != NULL && vim9_bad_comment(skipwhite(line)))
4076 return FAIL;
4077 else
4078 {
4079 line = next_line_from_context(cctx, FALSE);
4080 if (cctx->ctx_lnum >= last_func_lnum)
4081 {
4082 // beyond the last line
4083#ifdef FEAT_PROFILE
4084 if (cctx->ctx_skip != SKIP_YES)
4085 may_generate_prof_end(cctx, prof_lnum);
4086#endif
4087 break;
4088 }
4089 // Make a copy, splitting off nextcmd and removing trailing spaces
4090 // may change it.
4091 if (line != NULL)
4092 {
4093 line = vim_strsave(line);
4094 if (ga_add_string(lines_to_free, line) == FAIL)
4095 return FAIL;
4096 }
4097 }
4098
4099 CLEAR_FIELD(ea);
4100 ea.cmdlinep = &line;
4101 ea.cmd = skipwhite(line);
4102 ea.skip = cctx->ctx_skip == SKIP_YES;
4103
4104 if (*ea.cmd == '#')
4105 {
4106 // "#" starts a comment, but "#{" is an error
4107 if (vim9_bad_comment(ea.cmd))
4108 return FAIL;
4109 line = (char_u *)"";
4110 continue;
4111 }
4112
4113#ifdef FEAT_PROFILE
4114 if (cctx->ctx_compile_type == CT_PROFILE && cctx->ctx_lnum != prof_lnum
4115 && cctx->ctx_skip != SKIP_YES)
4116 {
4117 may_generate_prof_end(cctx, prof_lnum);
4118
4119 prof_lnum = cctx->ctx_lnum;
4120 generate_instr(cctx, ISN_PROF_START);
4121 }
4122#endif
4123 if (cctx->ctx_compile_type == CT_DEBUG && cctx->ctx_lnum != debug_lnum
4124 && cctx->ctx_skip != SKIP_YES)
4125 {
4126 debug_lnum = cctx->ctx_lnum;
4127 generate_instr_debug(cctx);
4128 }
4129 cctx->ctx_prev_lnum = cctx->ctx_lnum + 1;
4130
4131 // Some things can be recognized by the first character.
4132 switch (*ea.cmd)
4133 {
4134 case '}':
4135 {
4136 // "}" ends a block scope
4137 scopetype_T stype = cctx->ctx_scope == NULL
4138 ? NO_SCOPE : cctx->ctx_scope->se_type;
4139
4140 if (stype == BLOCK_SCOPE)
4141 {
4142 compile_endblock(cctx);
4143 line = ea.cmd;
4144 }
4145 else
4146 {
4147 emsg(_(e_using_rcurly_outside_if_block_scope));
4148 return FAIL;
4149 }
4150 if (line != NULL)
4151 line = skipwhite(ea.cmd + 1);
4152 continue;
4153 }
4154
4155 case '{':
4156 // "{" starts a block scope
4157 // "{'a': 1}->func() is something else
4158 if (ends_excmd(*skipwhite(ea.cmd + 1)))
4159 {
4160 line = compile_block(ea.cmd, cctx);
4161 continue;
4162 }
4163 break;
4164 }
4165
4166 /*
4167 * COMMAND MODIFIERS
4168 */
4169 cctx->ctx_has_cmdmod = FALSE;
4170 if (parse_command_modifiers(&ea, errormsg, &local_cmdmod, FALSE)
4171 == FAIL)
4172 return FAIL;
4173 generate_cmdmods(cctx, &local_cmdmod);
4174 undo_cmdmod(&local_cmdmod);
4175
4176 // Check if there was a colon after the last command modifier or before
4177 // the current position.
4178 for (p = ea.cmd; p >= line; --p)
4179 {
4180 if (*p == ':')
4181 starts_with_colon = TRUE;
4182 if (p < ea.cmd && !VIM_ISWHITE(*p))
4183 break;
4184 }
4185
4186 // Skip ":call" to get to the function name, unless using :legacy
4187 p = ea.cmd;
4188 if (!(local_cmdmod.cmod_flags & CMOD_LEGACY))
4189 {
4190 if (checkforcmd(&ea.cmd, "call", 3))
4191 {
4192 if (*ea.cmd == '(')
4193 // not for "call()"
4194 ea.cmd = p;
4195 else
4196 ea.cmd = skipwhite(ea.cmd);
4197 }
4198
4199 if (!starts_with_colon)
4200 {
4201 int assign;
4202
4203 // Check for assignment after command modifiers.
4204 assign = may_compile_assignment(&ea, &line, cctx);
4205 if (assign == OK)
4206 goto nextline;
4207 if (assign == FAIL)
4208 return FAIL;
4209 }
4210 }
4211
4212 /*
4213 * COMMAND after range
4214 * 'text'->func() should not be confused with 'a mark
4215 * 0z1234->func() should not be confused with a zero line number
4216 * "++nr" and "--nr" are eval commands
4217 * in "$ENV->func()" the "$" is not a range
4218 * "123->func()" is a method call
4219 */
4220 cmd = ea.cmd;
4221 if ((*cmd != '$' || starts_with_colon)
4222 && (starts_with_colon
4223 || !(*cmd == '\''
4224 || (cmd[0] == '0' && cmd[1] == 'z')
4225 || (cmd[0] != NUL && cmd[0] == cmd[1]
4226 && (*cmd == '+' || *cmd == '-'))
4227 || number_method(cmd))))
4228 {
4229 ea.cmd = skip_range(ea.cmd, TRUE, NULL);
4230 if (ea.cmd > cmd)
4231 {
4232 if (!starts_with_colon
4233 && !(local_cmdmod.cmod_flags & CMOD_LEGACY))
4234 {
4235 semsg(_(e_colon_required_before_range_str), cmd);
4236 return FAIL;
4237 }
4238 ea.addr_count = 1;
4239 if (ends_excmd2(line, ea.cmd))
4240 {
4241 // A range without a command: jump to the line.
4242 generate_EXEC(cctx, ISN_EXECRANGE,
4243 vim_strnsave(cmd, ea.cmd - cmd));
4244 line = ea.cmd;
4245 goto nextline;
4246 }
4247 }
4248 }
4249 p = find_ex_command(&ea, NULL,
4250 starts_with_colon || (local_cmdmod.cmod_flags & CMOD_LEGACY)
4251 ? NULL : item_exists, cctx);
4252
4253 if (p == NULL)
4254 {
4255 if (cctx->ctx_skip != SKIP_YES)
4256 semsg(_(e_ambiguous_use_of_user_defined_command_str), ea.cmd);
4257 return FAIL;
4258 }
4259
4260 // When using ":legacy cmd" always use compile_exec().
4261 if (local_cmdmod.cmod_flags & CMOD_LEGACY)
4262 {
4263 char_u *start = ea.cmd;
4264
4265 switch (ea.cmdidx)
4266 {
4267 case CMD_if:
4268 case CMD_elseif:
4269 case CMD_else:
4270 case CMD_endif:
4271 case CMD_for:
4272 case CMD_endfor:
4273 case CMD_continue:
4274 case CMD_break:
4275 case CMD_while:
4276 case CMD_endwhile:
4277 case CMD_try:
4278 case CMD_catch:
4279 case CMD_finally:
4280 case CMD_endtry:
4281 semsg(_(e_cannot_use_legacy_with_command_str), ea.cmd);
4282 return FAIL;
4283 default: break;
4284 }
4285
4286 // ":legacy return expr" needs to be handled differently.
4287 if (checkforcmd(&start, "return", 4))
4288 ea.cmdidx = CMD_return;
4289 else
4290 ea.cmdidx = CMD_legacy;
4291 }
4292
4293 if (p == ea.cmd && ea.cmdidx != CMD_SIZE)
4294 {
4295 // "eval" is used for "val->func()" and "var" for "var = val", then
4296 // "p" is equal to "ea.cmd" for a valid command.
4297 if (ea.cmdidx == CMD_eval || ea.cmdidx == CMD_var)
4298 ;
4299 else if (cctx->ctx_skip == SKIP_YES)
4300 {
4301 line += STRLEN(line);
4302 goto nextline;
4303 }
4304 else
4305 {
4306 semsg(_(e_command_not_recognized_str), ea.cmd);
4307 return FAIL;
4308 }
4309 }
4310
4311 if ((cctx->ctx_had_return || cctx->ctx_had_throw)
4312 && ea.cmdidx != CMD_elseif
4313 && ea.cmdidx != CMD_else
4314 && ea.cmdidx != CMD_endif
4315 && ea.cmdidx != CMD_endfor
4316 && ea.cmdidx != CMD_endwhile
4317 && ea.cmdidx != CMD_catch
4318 && ea.cmdidx != CMD_finally
4319 && ea.cmdidx != CMD_endtry
4320 && !ignore_unreachable_code_for_testing)
4321 {
4322 semsg(_(e_unreachable_code_after_str),
4323 cctx->ctx_had_return ? "return" : "throw");
4324 return FAIL;
4325 }
4326 cctx->ctx_had_throw = FALSE;
4327
4328 p = skipwhite(p);
4329 if (ea.cmdidx != CMD_SIZE
4330 && ea.cmdidx != CMD_write && ea.cmdidx != CMD_read)
4331 {
4332 if (ea.cmdidx >= 0)
4333 ea.argt = excmd_get_argt(ea.cmdidx);
4334 if ((ea.argt & EX_BANG) && *p == '!')
4335 {
4336 ea.forceit = TRUE;
4337 p = skipwhite(p + 1);
4338 }
4339 if ((ea.argt & EX_RANGE) == 0 && ea.addr_count > 0)
4340 {
4341 emsg(_(e_no_range_allowed));
4342 return FAIL;
4343 }
4344 }
4345
4346 switch (ea.cmdidx)
4347 {
4348 case CMD_def:
4349 case CMD_function:
4350 ea.arg = p;
4351 line = compile_nested_function(&ea, cctx, lines_to_free);
4352 break;
4353
4354 case CMD_return:
4355 line = compile_return(p, check_return_type,
4356 local_cmdmod.cmod_flags & CMOD_LEGACY, cctx);
4357 cctx->ctx_had_return = TRUE;
4358 break;
4359
4360 case CMD_let:
4361 emsg(_(e_cannot_use_let_in_vim9_script));
4362 break;
4363 case CMD_var:
4364 case CMD_final:
4365 case CMD_const:
4366 case CMD_increment:
4367 case CMD_decrement:
4368 line = compile_assignment(p, &ea, ea.cmdidx, cctx);
4369 if (line == p)
4370 {
4371 emsg(_(e_invalid_assignment));
4372 line = NULL;
4373 }
4374 break;
4375
4376 case CMD_unlet:
4377 case CMD_unlockvar:
4378 case CMD_lockvar:
4379 line = compile_unletlock(p, &ea, cctx);
4380 break;
4381
4382 case CMD_import:
4383 emsg(_(e_import_can_only_be_used_in_script));
4384 line = NULL;
4385 break;
4386
4387 case CMD_if:
4388 line = compile_if(p, cctx);
4389 break;
4390 case CMD_elseif:
4391 line = compile_elseif(p, cctx);
4392 cctx->ctx_had_return = FALSE;
4393 break;
4394 case CMD_else:
4395 line = compile_else(p, cctx);
4396 cctx->ctx_had_return = FALSE;
4397 break;
4398 case CMD_endif:
4399 line = compile_endif(p, cctx);
4400 break;
4401
4402 case CMD_while:
4403 line = compile_while(p, cctx);
4404 break;
4405 case CMD_endwhile:
4406 line = compile_endwhile(p, cctx);
4407 cctx->ctx_had_return = FALSE;
4408 break;
4409
4410 case CMD_for:
4411 line = compile_for(p, cctx);
4412 break;
4413 case CMD_endfor:
4414 line = compile_endfor(p, cctx);
4415 cctx->ctx_had_return = FALSE;
4416 break;
4417 case CMD_continue:
4418 line = compile_continue(p, cctx);
4419 break;
4420 case CMD_break:
4421 line = compile_break(p, cctx);
4422 break;
4423
4424 case CMD_try:
4425 line = compile_try(p, cctx);
4426 break;
4427 case CMD_catch:
4428 line = compile_catch(p, cctx);
4429 cctx->ctx_had_return = FALSE;
4430 break;
4431 case CMD_finally:
4432 line = compile_finally(p, cctx);
4433 cctx->ctx_had_return = FALSE;
4434 break;
4435 case CMD_endtry:
4436 line = compile_endtry(p, cctx);
4437 break;
4438 case CMD_throw:
4439 line = compile_throw(p, cctx);
4440 cctx->ctx_had_throw = TRUE;
4441 break;
4442
4443 case CMD_eval:
4444 line = compile_eval(p, cctx);
4445 break;
4446
4447 case CMD_defer:
4448 line = compile_defer(p, cctx);
4449 break;
4450
4451#ifdef HAS_MESSAGE_WINDOW
4452 case CMD_echowindow:
4453 {
4454 long cmd_count = get_cmd_count(line, &ea);
4455 if (cmd_count < 0)
4456 line = NULL;
4457 else
4458 line = compile_mult_expr(p, ea.cmdidx,
4459 cmd_count, cctx);
4460 }
4461 break;
4462#endif
4463 case CMD_echo:
4464 case CMD_echon:
4465 case CMD_echoconsole:
4466 case CMD_echoerr:
4467 case CMD_echomsg:
4468 case CMD_execute:
4469 line = compile_mult_expr(p, ea.cmdidx, 0, cctx);
4470 break;
4471
4472 case CMD_put:
4473 ea.cmd = cmd;
4474 line = compile_put(p, &ea, cctx);
4475 break;
4476
4477 case CMD_substitute:
4478 if (check_global_and_subst(ea.cmd, p) == FAIL)
4479 return FAIL;
4480 if (cctx->ctx_skip == SKIP_YES)
4481 line = (char_u *)"";
4482 else
4483 {
4484 ea.arg = p;
4485 line = compile_substitute(line, &ea, cctx);
4486 }
4487 break;
4488
4489 case CMD_redir:
4490 ea.arg = p;
4491 line = compile_redir(line, &ea, cctx);
4492 break;
4493
4494 case CMD_cexpr:
4495 case CMD_lexpr:
4496 case CMD_caddexpr:
4497 case CMD_laddexpr:
4498 case CMD_cgetexpr:
4499 case CMD_lgetexpr:
4500#ifdef FEAT_QUICKFIX
4501 ea.arg = p;
4502 line = compile_cexpr(line, &ea, cctx);
4503#else
4504 ex_ni(&ea);
4505 line = NULL;
4506#endif
4507 break;
4508
4509 case CMD_append:
4510 case CMD_change:
4511 case CMD_insert:
4512 case CMD_k:
4513 case CMD_t:
4514 case CMD_xit:
4515 not_in_vim9(&ea);
4516 return FAIL;
4517
4518 case CMD_SIZE:
4519 if (cctx->ctx_skip != SKIP_YES)
4520 {
4521 semsg(_(e_invalid_command_str), ea.cmd);
4522 return FAIL;
4523 }
4524 // We don't check for a next command here.
4525 line = (char_u *)"";
4526 break;
4527
4528 case CMD_lua:
4529 case CMD_mzscheme:
4530 case CMD_perl:
4531 case CMD_py3:
4532 case CMD_python3:
4533 case CMD_python:
4534 case CMD_pythonx:
4535 case CMD_ruby:
4536 case CMD_tcl:
4537 ea.arg = p;
4538 if (vim_strchr(line, '\n') == NULL)
4539 line = compile_exec(line, &ea, cctx);
4540 else
4541 // heredoc lines have been concatenated with NL
4542 // characters in get_function_body()
4543 line = compile_script(line, cctx);
4544 break;
4545
4546 case CMD_vim9script:
4547 if (cctx->ctx_skip != SKIP_YES)
4548 {
4549 emsg(_(e_vim9script_can_only_be_used_in_script));
4550 return FAIL;
4551 }
4552 line = (char_u *)"";
4553 break;
4554
4555 case CMD_class:
4556 emsg(_(e_class_can_only_be_used_in_script));
4557 return FAIL;
4558
4559 case CMD_type:
4560 emsg(_(e_type_can_only_be_used_in_script));
4561 return FAIL;
4562
4563 case CMD_global:
4564 if (check_global_and_subst(ea.cmd, p) == FAIL)
4565 return FAIL;
4566 // FALLTHROUGH
4567 default:
4568 // Not recognized, execute with do_cmdline_cmd().
4569 ea.arg = p;
4570 line = compile_exec(line, &ea, cctx);
4571 break;
4572 }
4573nextline:
4574 if (line == NULL)
4575 return FAIL;
4576 line = skipwhite(line);
4577
4578 // Undo any command modifiers.
4579 generate_undo_cmdmods(cctx);
4580
4581 if (cctx->ctx_type_stack.ga_len < 0)
4582 {
4583 iemsg("Type stack underflow");
4584 return FAIL;
4585 }
4586 } // END of the loop over all the function body lines.
4587
4588 return OK;
4589}
4590
4591/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004592 * After ex_function() has collected all the function lines: parse and compile
4593 * the lines into instructions.
4594 * Adds the function to "def_functions".
Bram Moolenaar9e68c322020-12-25 12:38:04 +01004595 * When "check_return_type" is set then set ufunc->uf_ret_type to the type of
4596 * the return statement (used for lambda). When uf_ret_type is already set
4597 * then check that it matches.
Bram Moolenaarb2049902021-01-24 12:53:53 +01004598 * When "profiling" is true add ISN_PROF_START instructions.
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +02004599 * "outer_cctx" is set for a nested function.
Bram Moolenaar05afcee2020-03-31 23:32:31 +02004600 * This can be used recursively through compile_lambda(), which may reallocate
4601 * "def_functions".
Bram Moolenaar822ba242020-05-24 23:00:18 +02004602 * Returns OK or FAIL.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004603 */
Bram Moolenaar822ba242020-05-24 23:00:18 +02004604 int
Bram Moolenaarb2049902021-01-24 12:53:53 +01004605compile_def_function(
Bram Moolenaare99d4222021-06-13 14:01:26 +02004606 ufunc_T *ufunc,
4607 int check_return_type,
4608 compiletype_T compile_type,
4609 cctx_T *outer_cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004610{
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004611 garray_T lines_to_free;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004612 char *errormsg = NULL; // error message
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004613 cctx_T cctx;
4614 garray_T *instr;
Bram Moolenaard66960b2020-10-30 20:46:26 +01004615 int did_emsg_before = did_emsg;
Bram Moolenaar599410c2021-04-10 14:03:43 +02004616 int did_emsg_silent_before = did_emsg_silent;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004617 int ret = FAIL;
4618 sctx_T save_current_sctx = current_sctx;
Bram Moolenaarf4e8cdd2020-10-12 22:07:13 +02004619 int save_estack_compiling = estack_compiling;
Bram Moolenaardc4c2302021-04-25 13:54:42 +02004620 int save_cmod_flags = cmdmod.cmod_flags;
Bram Moolenaar25e0f582020-05-25 22:36:50 +02004621 int do_estack_push;
Bram Moolenaar6c4bfe42020-07-23 18:26:30 +02004622 int new_def_function = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004623
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004624 // allocated lines are freed at the end
4625 ga_init2(&lines_to_free, sizeof(char_u *), 50);
4626
Bram Moolenaar25e0f582020-05-25 22:36:50 +02004627 // When using a function that was compiled before: Free old instructions.
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004628 // The index is reused. Otherwise add a new entry in "def_functions".
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004629 if (ufunc->uf_dfunc_idx > 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004630 {
Bram Moolenaar09689a02020-05-09 22:50:08 +02004631 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
4632 + ufunc->uf_dfunc_idx;
Bram Moolenaar3b814af2021-06-15 10:22:17 +02004633 isn_T *instr_dest = NULL;
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02004634
4635 switch (compile_type)
4636 {
4637 case CT_PROFILE:
4638#ifdef FEAT_PROFILE
4639 instr_dest = dfunc->df_instr_prof; break;
4640#endif
4641 case CT_NONE: instr_dest = dfunc->df_instr; break;
4642 case CT_DEBUG: instr_dest = dfunc->df_instr_debug; break;
4643 }
4644 if (instr_dest != NULL)
4645 // Was compiled in this mode before: Free old instructions.
4646 delete_def_function_contents(dfunc, FALSE);
4647 ga_clear_strings(&dfunc->df_var_names);
Bram Moolenaar1d84f762022-09-03 21:35:53 +01004648 dfunc->df_defer_var_idx = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004649 }
Bram Moolenaar6c4bfe42020-07-23 18:26:30 +02004650 else
4651 {
4652 if (add_def_function(ufunc) == FAIL)
4653 return FAIL;
4654 new_def_function = TRUE;
4655 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004656
Bram Moolenaar96923b72022-03-15 15:57:04 +00004657 if ((ufunc->uf_flags & FC_CLOSURE) && outer_cctx == NULL)
4658 {
4659 semsg(_(e_compiling_closure_without_context_str),
4660 printable_func_name(ufunc));
4661 return FAIL;
4662 }
4663
Bram Moolenaar985116a2020-07-12 17:31:09 +02004664 ufunc->uf_def_status = UF_COMPILING;
4665
Bram Moolenaara80faa82020-04-12 19:37:17 +02004666 CLEAR_FIELD(cctx);
Bram Moolenaarb2049902021-01-24 12:53:53 +01004667
Bram Moolenaare99d4222021-06-13 14:01:26 +02004668 cctx.ctx_compile_type = compile_type;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004669 cctx.ctx_ufunc = ufunc;
4670 cctx.ctx_lnum = -1;
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +02004671 cctx.ctx_outer = outer_cctx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004672 ga_init2(&cctx.ctx_locals, sizeof(lvar_T), 10);
Bram Moolenaar078a4612022-01-04 15:17:03 +00004673 // Each entry on the type stack consists of two type pointers.
4674 ga_init2(&cctx.ctx_type_stack, sizeof(type2_T), 50);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004675 cctx.ctx_type_list = &ufunc->uf_type_list;
4676 ga_init2(&cctx.ctx_instr, sizeof(isn_T), 50);
4677 instr = &cctx.ctx_instr;
4678
Bram Moolenaar25e0f582020-05-25 22:36:50 +02004679 // Set the context to the function, it may be compiled when called from
4680 // another script. Set the script version to the most modern one.
4681 // The line number will be set in next_line_from_context().
4682 current_sctx = ufunc->uf_script_ctx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004683 current_sctx.sc_version = SCRIPT_VERSION_VIM9;
4684
Bram Moolenaardc4c2302021-04-25 13:54:42 +02004685 // Don't use the flag from ":legacy" here.
4686 cmdmod.cmod_flags &= ~CMOD_LEGACY;
4687
Bram Moolenaar25e0f582020-05-25 22:36:50 +02004688 // Make sure error messages are OK.
4689 do_estack_push = !estack_top_is_ufunc(ufunc, 1);
4690 if (do_estack_push)
4691 estack_push_ufunc(ufunc, 1);
Bram Moolenaarf4e8cdd2020-10-12 22:07:13 +02004692 estack_compiling = TRUE;
Bram Moolenaar25e0f582020-05-25 22:36:50 +02004693
Bram Moolenaar9a015112021-12-31 14:06:45 +00004694 if (check_args_shadowing(ufunc, &cctx) == FAIL)
4695 goto erret;
4696
Yegappan Lakshmananf6c1fb22024-04-25 21:30:56 +02004697 // For an object method and a constructor generate instructions to
4698 // initialize "this" and the object variables.
Bram Moolenaar574950d2023-01-03 19:08:50 +00004699 if (ufunc->uf_flags & (FC_OBJECT|FC_NEW))
Yegappan Lakshmananf6c1fb22024-04-25 21:30:56 +02004700 if (obj_method_prologue(ufunc, &cctx) == FAIL)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004701 goto erret;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004702
Bram Moolenaar170fcfc2020-02-06 17:51:35 +01004703 if (ufunc->uf_def_args.ga_len > 0)
Yegappan Lakshmananf6c1fb22024-04-25 21:30:56 +02004704 if (compile_def_function_default_args(ufunc, &cctx, instr) == FAIL)
4705 goto erret;
Bram Moolenaare28d9b32021-07-03 18:56:53 +02004706 ufunc->uf_args_visible = ufunc->uf_args.ga_len;
Bram Moolenaar170fcfc2020-02-06 17:51:35 +01004707
Bram Moolenaarb8bebd02023-01-30 20:24:23 +00004708 // Compiling a function in an interface is done to get the function type.
Christian Brabandtded16772024-08-14 22:52:03 +02004709 // No code is actually compiled.
4710 if (ufunc->uf_class != NULL && IS_INTERFACE(ufunc->uf_class))
Bram Moolenaarb8bebd02023-01-30 20:24:23 +00004711 {
4712 ufunc->uf_def_status = UF_NOT_COMPILED;
4713 ret = OK;
4714 goto erret;
4715 }
4716
Yegappan Lakshmananf6c1fb22024-04-25 21:30:56 +02004717 // compile the function body
Yegappan Lakshmanana16f2512024-04-23 20:14:46 +02004718 if (compile_def_function_body(&cctx, ufunc->uf_lines.ga_len,
4719 check_return_type, &lines_to_free, &errormsg) == FAIL)
4720 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004721
4722 if (cctx.ctx_scope != NULL)
4723 {
4724 if (cctx.ctx_scope->se_type == IF_SCOPE)
Bram Moolenaar1a992222021-12-31 17:25:48 +00004725 emsg(_(e_missing_endif));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004726 else if (cctx.ctx_scope->se_type == WHILE_SCOPE)
Bram Moolenaar1a992222021-12-31 17:25:48 +00004727 emsg(_(e_missing_endwhile));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004728 else if (cctx.ctx_scope->se_type == FOR_SCOPE)
Bram Moolenaar1a992222021-12-31 17:25:48 +00004729 emsg(_(e_missing_endfor));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004730 else
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004731 emsg(_(e_missing_rcurly));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004732 goto erret;
4733 }
4734
Bram Moolenaara2c00282023-05-14 22:05:15 +01004735 // TODO: if a function ends in "throw" but there was a return elsewhere we
4736 // should not assume the return type is "void".
4737 if (!cctx.ctx_had_return && !cctx.ctx_had_throw)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004738 {
Bram Moolenaare6174fd2021-06-12 18:30:56 +02004739 if (ufunc->uf_ret_type->tt_type == VAR_UNKNOWN)
4740 ufunc->uf_ret_type = &t_void;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004741 else if (ufunc->uf_ret_type->tt_type != VAR_VOID
Yegappan Lakshmanan1db15142023-09-19 20:34:05 +02004742 && !IS_CONSTRUCTOR_METHOD(ufunc))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004743 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004744 emsg(_(e_missing_return_statement));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004745 goto erret;
4746 }
4747
Bram Moolenaarf57b43c2021-06-15 22:13:27 +02004748 // Return void if there is no return at the end.
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004749 // For a constructor return the object.
Yegappan Lakshmanan1db15142023-09-19 20:34:05 +02004750 if (IS_CONSTRUCTOR_METHOD(ufunc))
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00004751 {
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004752 generate_instr(&cctx, ISN_RETURN_OBJECT);
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00004753 ufunc->uf_ret_type = &ufunc->uf_class->class_object_type;
4754 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004755 else
4756 generate_instr(&cctx, ISN_RETURN_VOID);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004757 }
4758
Bram Moolenaar599410c2021-04-10 14:03:43 +02004759 // When compiled with ":silent!" and there was an error don't consider the
4760 // function compiled.
4761 if (emsg_silent == 0 || did_emsg_silent == did_emsg_silent_before)
Bram Moolenaar05afcee2020-03-31 23:32:31 +02004762 {
4763 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
4764 + ufunc->uf_dfunc_idx;
4765 dfunc->df_deleted = FALSE;
Bram Moolenaar4aab88d2020-12-24 21:56:41 +01004766 dfunc->df_script_seq = current_sctx.sc_seq;
Bram Moolenaarf002a412021-01-24 13:34:18 +01004767#ifdef FEAT_PROFILE
Bram Moolenaare99d4222021-06-13 14:01:26 +02004768 if (cctx.ctx_compile_type == CT_PROFILE)
Bram Moolenaarb2049902021-01-24 12:53:53 +01004769 {
4770 dfunc->df_instr_prof = instr->ga_data;
4771 dfunc->df_instr_prof_count = instr->ga_len;
4772 }
4773 else
Bram Moolenaarf002a412021-01-24 13:34:18 +01004774#endif
Bram Moolenaare99d4222021-06-13 14:01:26 +02004775 if (cctx.ctx_compile_type == CT_DEBUG)
4776 {
4777 dfunc->df_instr_debug = instr->ga_data;
4778 dfunc->df_instr_debug_count = instr->ga_len;
4779 }
4780 else
Bram Moolenaarb2049902021-01-24 12:53:53 +01004781 {
4782 dfunc->df_instr = instr->ga_data;
4783 dfunc->df_instr_count = instr->ga_len;
4784 }
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02004785 dfunc->df_varcount = dfunc->df_var_names.ga_len;
Bram Moolenaar148ce7a2020-09-23 21:57:23 +02004786 dfunc->df_has_closure = cctx.ctx_has_closure;
Bram Moolenaarb46c0832022-09-15 17:19:37 +01004787
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +02004788 if (cctx.ctx_outer_used)
Bram Moolenaarb46c0832022-09-15 17:19:37 +01004789 {
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +02004790 ufunc->uf_flags |= FC_CLOSURE;
Bram Moolenaarb46c0832022-09-15 17:19:37 +01004791 if (outer_cctx != NULL)
4792 ++outer_cctx->ctx_closure_count;
4793 }
4794
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004795 ufunc->uf_def_status = UF_COMPILED;
Bram Moolenaar05afcee2020-03-31 23:32:31 +02004796 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004797
4798 ret = OK;
4799
4800erret:
Bram Moolenaar599410c2021-04-10 14:03:43 +02004801 if (ufunc->uf_def_status == UF_COMPILING)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004802 {
Bram Moolenaar05afcee2020-03-31 23:32:31 +02004803 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
4804 + ufunc->uf_dfunc_idx;
Bram Moolenaar20431c92020-03-20 18:39:46 +01004805
Bram Moolenaarcaf1a2f2021-06-15 11:27:21 +02004806 // Compiling aborted, free the generated instructions.
Bram Moolenaar8238f082021-04-20 21:10:48 +02004807 clear_instr_ga(instr);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01004808 VIM_CLEAR(dfunc->df_name);
Bram Moolenaarcaf1a2f2021-06-15 11:27:21 +02004809 ga_clear_strings(&dfunc->df_var_names);
Bram Moolenaar20431c92020-03-20 18:39:46 +01004810
Bram Moolenaar6c4bfe42020-07-23 18:26:30 +02004811 // If using the last entry in the table and it was added above, we
4812 // might as well remove it.
4813 if (!dfunc->df_deleted && new_def_function
Bram Moolenaar45a15082020-05-25 00:28:33 +02004814 && ufunc->uf_dfunc_idx == def_functions.ga_len - 1)
Bram Moolenaar6c4bfe42020-07-23 18:26:30 +02004815 {
Bram Moolenaar20431c92020-03-20 18:39:46 +01004816 --def_functions.ga_len;
Bram Moolenaar6c4bfe42020-07-23 18:26:30 +02004817 ufunc->uf_dfunc_idx = 0;
4818 }
Bram Moolenaar701cc6c2021-04-10 13:33:48 +02004819 ufunc->uf_def_status = UF_COMPILE_ERROR;
Bram Moolenaar20431c92020-03-20 18:39:46 +01004820
Bram Moolenaar3cca2992020-04-02 22:57:36 +02004821 while (cctx.ctx_scope != NULL)
4822 drop_scope(&cctx);
4823
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004824 if (errormsg != NULL)
4825 emsg(errormsg);
Bram Moolenaard66960b2020-10-30 20:46:26 +01004826 else if (did_emsg == did_emsg_before)
Bram Moolenaare13bdec2020-10-16 23:16:47 +02004827 emsg(_(e_compiling_def_function_failed));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004828 }
4829
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004830 if (cctx.ctx_redir_lhs.lhs_name != NULL)
4831 {
4832 if (ret == OK)
4833 {
4834 emsg(_(e_missing_redir_end));
4835 ret = FAIL;
4836 }
4837 vim_free(cctx.ctx_redir_lhs.lhs_name);
Bram Moolenaar753bcf82021-04-21 14:24:24 +02004838 vim_free(cctx.ctx_redir_lhs.lhs_whole);
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004839 }
4840
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004841 current_sctx = save_current_sctx;
Bram Moolenaarf4e8cdd2020-10-12 22:07:13 +02004842 estack_compiling = save_estack_compiling;
Bram Moolenaardc4c2302021-04-25 13:54:42 +02004843 cmdmod.cmod_flags = save_cmod_flags;
Bram Moolenaar25e0f582020-05-25 22:36:50 +02004844 if (do_estack_push)
4845 estack_pop();
4846
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004847 ga_clear_strings(&lines_to_free);
Bram Moolenaarb84a3812020-05-01 15:44:29 +02004848 free_locals(&cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004849 ga_clear(&cctx.ctx_type_stack);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004850 return ret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004851}
4852
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004853 void
4854set_function_type(ufunc_T *ufunc)
4855{
4856 int varargs = ufunc->uf_va_name != NULL;
4857 int argcount = ufunc->uf_args.ga_len;
4858
4859 // Create a type for the function, with the return type and any
4860 // argument types.
4861 // A vararg is included in uf_args.ga_len but not in uf_arg_types.
4862 // The type is included in "tt_args".
4863 if (argcount > 0 || varargs)
4864 {
Bram Moolenaar18062fc2021-03-05 21:35:47 +01004865 if (ufunc->uf_type_list.ga_itemsize == 0)
4866 ga_init2(&ufunc->uf_type_list, sizeof(type_T *), 10);
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004867 ufunc->uf_func_type = alloc_func_type(ufunc->uf_ret_type,
4868 argcount, &ufunc->uf_type_list);
4869 // Add argument types to the function type.
4870 if (func_type_add_arg_types(ufunc->uf_func_type,
4871 argcount + varargs,
4872 &ufunc->uf_type_list) == FAIL)
4873 return;
4874 ufunc->uf_func_type->tt_argcount = argcount + varargs;
4875 ufunc->uf_func_type->tt_min_argcount =
4876 argcount - ufunc->uf_def_args.ga_len;
4877 if (ufunc->uf_arg_types == NULL)
4878 {
4879 int i;
4880
4881 // lambda does not have argument types.
4882 for (i = 0; i < argcount; ++i)
4883 ufunc->uf_func_type->tt_args[i] = &t_any;
4884 }
4885 else
4886 mch_memmove(ufunc->uf_func_type->tt_args,
4887 ufunc->uf_arg_types, sizeof(type_T *) * argcount);
4888 if (varargs)
4889 {
4890 ufunc->uf_func_type->tt_args[argcount] =
Bram Moolenaar2a389082021-04-09 20:24:31 +02004891 ufunc->uf_va_type == NULL ? &t_list_any : ufunc->uf_va_type;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004892 ufunc->uf_func_type->tt_flags = TTFLAG_VARARGS;
4893 }
4894 }
4895 else
4896 // No arguments, can use a predefined type.
4897 ufunc->uf_func_type = get_func_type(ufunc->uf_ret_type,
4898 argcount, &ufunc->uf_type_list);
4899}
4900
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004901/*
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01004902 * Free all instructions for "dfunc" except df_name.
Bram Moolenaar20431c92020-03-20 18:39:46 +01004903 */
4904 static void
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004905delete_def_function_contents(dfunc_T *dfunc, int mark_deleted)
Bram Moolenaar20431c92020-03-20 18:39:46 +01004906{
4907 int idx;
4908
Bram Moolenaard505d172022-12-18 21:42:55 +00004909 // In same cases the instructions may refer to a class in which the
4910 // function is defined and unreferencing the class may call back here
4911 // recursively. Set the df_delete_busy to avoid problems.
4912 if (dfunc->df_delete_busy)
4913 return;
4914 dfunc->df_delete_busy = TRUE;
4915
Bram Moolenaar20431c92020-03-20 18:39:46 +01004916 ga_clear(&dfunc->df_def_args_isn);
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02004917 ga_clear_strings(&dfunc->df_var_names);
Bram Moolenaar20431c92020-03-20 18:39:46 +01004918
4919 if (dfunc->df_instr != NULL)
4920 {
4921 for (idx = 0; idx < dfunc->df_instr_count; ++idx)
4922 delete_instr(dfunc->df_instr + idx);
4923 VIM_CLEAR(dfunc->df_instr);
4924 }
Bram Moolenaarc2dec4c2021-06-13 15:39:00 +02004925 if (dfunc->df_instr_debug != NULL)
4926 {
4927 for (idx = 0; idx < dfunc->df_instr_debug_count; ++idx)
4928 delete_instr(dfunc->df_instr_debug + idx);
4929 VIM_CLEAR(dfunc->df_instr_debug);
Bram Moolenaarc2dec4c2021-06-13 15:39:00 +02004930 }
Bram Moolenaarc05fe072021-01-24 21:30:48 +01004931#ifdef FEAT_PROFILE
4932 if (dfunc->df_instr_prof != NULL)
4933 {
4934 for (idx = 0; idx < dfunc->df_instr_prof_count; ++idx)
4935 delete_instr(dfunc->df_instr_prof + idx);
4936 VIM_CLEAR(dfunc->df_instr_prof);
Bram Moolenaarc05fe072021-01-24 21:30:48 +01004937 }
4938#endif
Bram Moolenaar20431c92020-03-20 18:39:46 +01004939
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004940 if (mark_deleted)
4941 dfunc->df_deleted = TRUE;
4942 if (dfunc->df_ufunc != NULL)
4943 dfunc->df_ufunc->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaard505d172022-12-18 21:42:55 +00004944
4945 dfunc->df_delete_busy = FALSE;
Bram Moolenaar20431c92020-03-20 18:39:46 +01004946}
4947
4948/*
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004949 * When a user function is deleted, clear the contents of any associated def
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01004950 * function, unless another user function still uses it.
4951 * The position in def_functions can be re-used.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004952 */
4953 void
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01004954unlink_def_function(ufunc_T *ufunc)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004955{
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00004956 if (ufunc->uf_dfunc_idx <= 0)
4957 return;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004958
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00004959 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
4960 + ufunc->uf_dfunc_idx;
4961
4962 if (--dfunc->df_refcount <= 0)
4963 delete_def_function_contents(dfunc, TRUE);
4964 ufunc->uf_def_status = UF_NOT_COMPILED;
4965 ufunc->uf_dfunc_idx = 0;
4966 if (dfunc->df_ufunc == ufunc)
4967 dfunc->df_ufunc = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004968}
4969
Bram Moolenaarfdeab652020-09-19 15:16:50 +02004970/*
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01004971 * Used when a user function refers to an existing dfunc.
Bram Moolenaarfdeab652020-09-19 15:16:50 +02004972 */
4973 void
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01004974link_def_function(ufunc_T *ufunc)
Bram Moolenaarfdeab652020-09-19 15:16:50 +02004975{
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00004976 if (ufunc->uf_dfunc_idx <= 0)
4977 return;
Bram Moolenaarfdeab652020-09-19 15:16:50 +02004978
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00004979 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
4980 + ufunc->uf_dfunc_idx;
4981
4982 ++dfunc->df_refcount;
Bram Moolenaarfdeab652020-09-19 15:16:50 +02004983}
4984
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004985#if defined(EXITFREE) || defined(PROTO)
Bram Moolenaar20431c92020-03-20 18:39:46 +01004986/*
4987 * Free all functions defined with ":def".
4988 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004989 void
4990free_def_functions(void)
4991{
Bram Moolenaar20431c92020-03-20 18:39:46 +01004992 int idx;
4993
4994 for (idx = 0; idx < def_functions.ga_len; ++idx)
4995 {
4996 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data) + idx;
4997
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004998 delete_def_function_contents(dfunc, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01004999 vim_free(dfunc->df_name);
Bram Moolenaar20431c92020-03-20 18:39:46 +01005000 }
5001
5002 ga_clear(&def_functions);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005003}
5004#endif
5005
5006
5007#endif // FEAT_EVAL