blob: 61fefa767ed33d94f58b38324448cc4096e9bad2 [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;
525 if ((actual->tt_type == VAR_LIST || actual->tt_type == VAR_DICT)
526 && actual->tt_type == expected->tt_type)
527 // This takes care of a nested list or dict.
528 return use_typecheck(actual->tt_member, expected->tt_member);
529 return FALSE;
530}
531
532/*
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +0200533 * Check that
Bram Moolenaar5e654232020-09-16 15:22:00 +0200534 * - "actual" matches "expected" type or
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +0200535 * - "actual" is a type that can be "expected" type: add a runtime check; or
536 * - return FAIL.
Bram Moolenaar334a8b42020-10-19 16:07:42 +0200537 * If "actual_is_const" is TRUE then the type won't change at runtime, do not
538 * generate a TYPECHECK.
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +0200539 */
Bram Moolenaara1c51952022-02-02 16:20:26 +0000540 int
Bram Moolenaar4270d8b2021-08-07 16:30:42 +0200541need_type_where(
542 type_T *actual,
543 type_T *expected,
Bram Moolenaarc6951a72022-12-29 20:56:24 +0000544 int number_ok, // expect VAR_FLOAT but VAR_NUMBER is OK
Bram Moolenaar4270d8b2021-08-07 16:30:42 +0200545 int offset,
546 where_T where,
547 cctx_T *cctx,
548 int silent,
549 int actual_is_const)
550{
Bram Moolenaar44a89772021-12-18 12:31:33 +0000551 int ret;
552
Ernie Raele75fde62023-12-21 17:18:54 +0100553 if (expected->tt_type != VAR_CLASS && expected->tt_type != VAR_TYPEALIAS)
554 {
555 if (check_type_is_value(actual) == FAIL)
556 return FAIL;
557 }
558
Bram Moolenaar4270d8b2021-08-07 16:30:42 +0200559 if (expected == &t_bool && actual != &t_bool
560 && (actual->tt_flags & TTFLAG_BOOL_OK))
561 {
562 // Using "0", "1" or the result of an expression with "&&" or "||" as a
563 // boolean is OK but requires a conversion.
564 generate_2BOOL(cctx, FALSE, offset);
565 return OK;
566 }
567
Bram Moolenaar44a89772021-12-18 12:31:33 +0000568 ret = check_type_maybe(expected, actual, FALSE, where);
569 if (ret == OK)
Bram Moolenaar4270d8b2021-08-07 16:30:42 +0200570 return OK;
571
Bram Moolenaar8acb9cc2022-03-08 13:18:55 +0000572 // If actual a constant a runtime check makes no sense. If it's
573 // null_function it is OK.
574 if (actual_is_const && ret == MAYBE && actual == &t_func_unknown)
575 return OK;
576
Bram Moolenaar4270d8b2021-08-07 16:30:42 +0200577 // If the actual type can be the expected type add a runtime check.
Bram Moolenaarfa46ead2021-12-22 13:18:39 +0000578 if (!actual_is_const && ret == MAYBE && use_typecheck(actual, expected))
Bram Moolenaar4270d8b2021-08-07 16:30:42 +0200579 {
Bram Moolenaarc6951a72022-12-29 20:56:24 +0000580 generate_TYPECHECK(cctx, expected, number_ok, offset,
LemonBoyc5d27442023-08-19 13:02:35 +0200581 where.wt_kind == WT_VARIABLE, where.wt_index);
Bram Moolenaar4270d8b2021-08-07 16:30:42 +0200582 return OK;
583 }
584
585 if (!silent)
586 type_mismatch_where(expected, actual, where);
587 return FAIL;
588}
589
Bram Moolenaar351ead02021-01-16 16:07:01 +0100590 int
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +0200591need_type(
592 type_T *actual,
593 type_T *expected,
Bram Moolenaarc6951a72022-12-29 20:56:24 +0000594 int number_ok, // when expected is float number is also OK
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +0200595 int offset,
Bram Moolenaar351ead02021-01-16 16:07:01 +0100596 int arg_idx,
Bram Moolenaar9b7bf9e2020-07-11 22:14:59 +0200597 cctx_T *cctx,
Bram Moolenaar334a8b42020-10-19 16:07:42 +0200598 int silent,
599 int actual_is_const)
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +0200600{
Bram Moolenaar7a3fe3e2021-07-22 14:58:47 +0200601 where_T where = WHERE_INIT;
Bram Moolenaarf785aa12021-02-11 21:19:34 +0100602
LemonBoyc5d27442023-08-19 13:02:35 +0200603 if (arg_idx > 0)
604 {
605 where.wt_index = arg_idx;
606 where.wt_kind = WT_ARGUMENT;
607 }
Bram Moolenaarc6951a72022-12-29 20:56:24 +0000608 return need_type_where(actual, expected, number_ok, offset, where,
Bram Moolenaar4270d8b2021-08-07 16:30:42 +0200609 cctx, silent, actual_is_const);
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +0200610}
611
612/*
Bram Moolenaarfa103972022-09-29 19:14:42 +0100613 * Set type of variable "lvar" to "type". If the variable is a constant then
614 * the type gets TTFLAG_CONST.
615 */
616 static void
617set_var_type(lvar_T *lvar, type_T *type_arg, cctx_T *cctx)
618{
619 type_T *type = type_arg;
620
Bram Moolenaar6586a012022-09-30 11:04:50 +0100621 if (lvar->lv_const == ASSIGN_CONST && (type->tt_flags & TTFLAG_CONST) == 0)
Bram Moolenaarfa103972022-09-29 19:14:42 +0100622 {
623 if (type->tt_flags & TTFLAG_STATIC)
624 // entry in static_types[] is followed by const type
625 type = type + 1;
626 else
627 {
628 type = copy_type(type, cctx->ctx_type_list);
629 type->tt_flags |= TTFLAG_CONST;
630 }
631 }
632 lvar->lv_type = type;
633}
634
635/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100636 * Reserve space for a local variable.
Bram Moolenaar6586a012022-09-30 11:04:50 +0100637 * "assign" can be ASSIGN_VAR for :var, ASSIGN_CONST for :const and
638 * ASSIGN_FINAL for :final.
Bram Moolenaarb84a3812020-05-01 15:44:29 +0200639 * Return the variable or NULL if it failed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100640 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +0000641 lvar_T *
Bram Moolenaare8211a32020-10-09 22:04:29 +0200642reserve_local(
643 cctx_T *cctx,
644 char_u *name,
645 size_t len,
Bram Moolenaar6586a012022-09-30 11:04:50 +0100646 int assign,
Bram Moolenaare8211a32020-10-09 22:04:29 +0200647 type_T *type)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100648{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100649 lvar_T *lvar;
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +0200650 dfunc_T *dfunc;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100651
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200652 if (arg_exists(name, len, NULL, NULL, NULL, cctx) == OK)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100653 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200654 emsg_namelen(_(e_str_is_used_as_argument), name, (int)len);
Bram Moolenaarb84a3812020-05-01 15:44:29 +0200655 return NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100656 }
657
Bram Moolenaar35578162021-08-02 19:10:38 +0200658 if (GA_GROW_FAILS(&cctx->ctx_locals, 1))
Bram Moolenaarb84a3812020-05-01 15:44:29 +0200659 return NULL;
660 lvar = ((lvar_T *)cctx->ctx_locals.ga_data) + cctx->ctx_locals.ga_len++;
Bram Moolenaare8211a32020-10-09 22:04:29 +0200661 CLEAR_POINTER(lvar);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100662
Bram Moolenaarb84a3812020-05-01 15:44:29 +0200663 // Every local variable uses the next entry on the stack. We could re-use
664 // the last ones when leaving a scope, but then variables used in a closure
665 // might get overwritten. To keep things simple do not re-use stack
666 // entries. This is less efficient, but memory is cheap these days.
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +0200667 dfunc = ((dfunc_T *)def_functions.ga_data) + cctx->ctx_ufunc->uf_dfunc_idx;
668 lvar->lv_idx = dfunc->df_var_names.ga_len;
Bram Moolenaarb84a3812020-05-01 15:44:29 +0200669
Bram Moolenaar71ccd032020-06-12 22:59:11 +0200670 lvar->lv_name = vim_strnsave(name, len == 0 ? STRLEN(name) : len);
Bram Moolenaar6586a012022-09-30 11:04:50 +0100671 lvar->lv_const = assign;
Bram Moolenaarfa103972022-09-29 19:14:42 +0100672 if (type == &t_unknown || type == &t_any)
673 // type not known yet, may be inferred from RHS
674 lvar->lv_type = type;
675 else
676 // may use TTFLAG_CONST
677 set_var_type(lvar, type, cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100678
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +0200679 // Remember the name for debugging.
Bram Moolenaar35578162021-08-02 19:10:38 +0200680 if (GA_GROW_FAILS(&dfunc->df_var_names, 1))
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +0200681 return NULL;
682 ((char_u **)dfunc->df_var_names.ga_data)[lvar->lv_idx] =
683 vim_strsave(lvar->lv_name);
684 ++dfunc->df_var_names.ga_len;
685
Bram Moolenaarb84a3812020-05-01 15:44:29 +0200686 return lvar;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100687}
688
689/*
Bram Moolenaar08251752021-01-11 21:20:18 +0100690 * If "check_writable" is ASSIGN_CONST give an error if the variable was
691 * defined with :final or :const, if "check_writable" is ASSIGN_FINAL give an
692 * error if the variable was defined with :const.
693 */
694 static int
695check_item_writable(svar_T *sv, int check_writable, char_u *name)
696{
697 if ((check_writable == ASSIGN_CONST && sv->sv_const != 0)
698 || (check_writable == ASSIGN_FINAL
699 && sv->sv_const == ASSIGN_CONST))
700 {
Bram Moolenaard8e44472021-07-21 22:20:33 +0200701 semsg(_(e_cannot_change_readonly_variable_str), name);
Bram Moolenaar08251752021-01-11 21:20:18 +0100702 return FAIL;
703 }
704 return OK;
705}
706
707/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100708 * Find "name" in script-local items of script "sid".
Bram Moolenaar08251752021-01-11 21:20:18 +0100709 * Pass "check_writable" to check_item_writable().
Bram Moolenaar7a3b8022022-02-14 19:53:03 +0000710 * "cctx" is NULL at the script level, "cstack" is NULL in a function.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100711 * Returns the index in "sn_var_vals" if found.
712 * If found but not in "sn_var_vals" returns -1.
Bram Moolenaar08251752021-01-11 21:20:18 +0100713 * If not found or the variable is not writable returns -2.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100714 */
715 int
Bram Moolenaarb6a138e2022-02-08 21:17:22 +0000716get_script_item_idx(
717 int sid,
718 char_u *name,
719 int check_writable,
720 cctx_T *cctx,
721 cstack_T *cstack)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100722{
723 hashtab_T *ht;
724 dictitem_T *di;
Bram Moolenaar21b9e972020-01-26 19:26:46 +0100725 scriptitem_T *si = SCRIPT_ITEM(sid);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200726 svar_T *sv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100727 int idx;
728
Bram Moolenaare3d46852020-08-29 13:39:17 +0200729 if (!SCRIPT_ID_VALID(sid))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100730 return -1;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200731 if (sid == current_sctx.sc_sid)
732 {
Bram Moolenaarb6a138e2022-02-08 21:17:22 +0000733 sallvar_T *sav = find_script_var(name, 0, cctx, cstack);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200734
735 if (sav == NULL)
736 return -2;
737 idx = sav->sav_var_vals_idx;
738 sv = ((svar_T *)si->sn_var_vals.ga_data) + idx;
Bram Moolenaar08251752021-01-11 21:20:18 +0100739 if (check_item_writable(sv, check_writable, name) == FAIL)
740 return -2;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200741 return idx;
742 }
743
744 // First look the name up in the hashtable.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100745 ht = &SCRIPT_VARS(sid);
746 di = find_var_in_ht(ht, 0, name, TRUE);
747 if (di == NULL)
Bram Moolenaar577bd852022-01-10 18:42:52 +0000748 {
749 if (si->sn_autoload_prefix != NULL)
750 {
751 hashitem_T *hi;
752
753 // A variable exported from an autoload script is in the global
754 // variables, we can find it in the all_vars table.
755 hi = hash_find(&si->sn_all_vars.dv_hashtab, name);
756 if (!HASHITEM_EMPTY(hi))
757 return HI2SAV(hi)->sav_var_vals_idx;
758 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100759 return -2;
Bram Moolenaar577bd852022-01-10 18:42:52 +0000760 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100761
762 // Now find the svar_T index in sn_var_vals.
763 for (idx = 0; idx < si->sn_var_vals.ga_len; ++idx)
764 {
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200765 sv = ((svar_T *)si->sn_var_vals.ga_data) + idx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100766 if (sv->sv_tv == &di->di_tv)
767 {
Bram Moolenaar08251752021-01-11 21:20:18 +0100768 if (check_item_writable(sv, check_writable, name) == FAIL)
769 return -2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100770 return idx;
771 }
772 }
773 return -1;
774}
775
Yegappan Lakshmanan782b43d2022-01-08 18:43:40 +0000776 static imported_T *
777find_imported_in_script(char_u *name, size_t len, int sid)
778{
779 scriptitem_T *si;
780 int idx;
781
782 if (!SCRIPT_ID_VALID(sid))
783 return NULL;
784 si = SCRIPT_ITEM(sid);
785 for (idx = 0; idx < si->sn_imports.ga_len; ++idx)
786 {
787 imported_T *import = ((imported_T *)si->sn_imports.ga_data) + idx;
788
789 if (len == 0 ? STRCMP(name, import->imp_name) == 0
790 : STRLEN(import->imp_name) == len
791 && STRNCMP(name, import->imp_name, len) == 0)
792 return import;
793 }
794 return NULL;
795}
796
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100797/*
Bram Moolenaar4b1d9632022-02-13 21:51:08 +0000798 * Find "name" in imported items of the current script.
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +0100799 * If "len" is 0 use any length that works.
Bram Moolenaardc4451d2022-01-09 21:36:37 +0000800 * If "load" is TRUE and the script was not loaded yet, load it now.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100801 */
802 imported_T *
Bram Moolenaar4b1d9632022-02-13 21:51:08 +0000803find_imported(char_u *name, size_t len, int load)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100804{
Bram Moolenaare3d46852020-08-29 13:39:17 +0200805 if (!SCRIPT_ID_VALID(current_sctx.sc_sid))
Bram Moolenaar8e6cbb72020-07-01 14:38:12 +0200806 return NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100807
Bram Moolenaarb775e722022-11-22 18:12:44 +0000808 // Skip over "s:" before "s:something" to find the import name.
809 int off = name[0] == 's' && name[1] == ':' ? 2 : 0;
810
811 imported_T *ret = find_imported_in_script(name + off, len - off,
812 current_sctx.sc_sid);
Bram Moolenaarb697dc22022-01-22 11:27:29 +0000813 if (ret != NULL && load && (ret->imp_flags & IMP_FLAGS_AUTOLOAD))
Bram Moolenaardc4451d2022-01-09 21:36:37 +0000814 {
Bram Moolenaar753885b2022-08-24 16:30:36 +0100815 scid_T actual_sid = 0;
Bram Moolenaar6809ff92022-07-26 15:10:56 +0100816 int save_emsg_off = emsg_off;
817
818 // "emsg_off" will be set when evaluating an expression silently, but
819 // we do want to know about errors in a script. Also because it then
820 // aborts when an error is encountered.
821 emsg_off = FALSE;
Bram Moolenaar17d36cb2022-01-12 11:46:40 +0000822
Bram Moolenaardc4451d2022-01-09 21:36:37 +0000823 // script found before but not loaded yet
Bram Moolenaarb697dc22022-01-22 11:27:29 +0000824 ret->imp_flags &= ~IMP_FLAGS_AUTOLOAD;
Bram Moolenaardc4451d2022-01-09 21:36:37 +0000825 (void)do_source(SCRIPT_ITEM(ret->imp_sid)->sn_name, FALSE,
Bram Moolenaar753885b2022-08-24 16:30:36 +0100826 DOSO_NONE, &actual_sid);
827 // If the script is a symlink it may be sourced with another name, may
828 // need to adjust the script ID for that.
829 if (actual_sid != 0)
830 ret->imp_sid = actual_sid;
Bram Moolenaar6809ff92022-07-26 15:10:56 +0100831
832 emsg_off = save_emsg_off;
Bram Moolenaardc4451d2022-01-09 21:36:37 +0000833 }
834 return ret;
Bram Moolenaarefa94442020-08-08 22:16:00 +0200835}
836
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100837/*
Bram Moolenaardc7c3662021-12-20 15:04:29 +0000838 * Called when checking for a following operator at "arg". When the rest of
839 * the line is empty or only a comment, peek the next line. If there is a next
840 * line return a pointer to it and set "nextp".
841 * Otherwise skip over white space.
842 */
843 char_u *
844may_peek_next_line(cctx_T *cctx, char_u *arg, char_u **nextp)
845{
846 char_u *p = skipwhite(arg);
847
848 *nextp = NULL;
849 if (*p == NUL || (VIM_ISWHITE(*arg) && vim9_comment_start(p)))
850 {
851 *nextp = peek_next_line_from_context(cctx);
852 if (*nextp != NULL)
853 return *nextp;
854 }
855 return p;
856}
857
858/*
Bram Moolenaar23c55272020-06-21 16:58:13 +0200859 * Return a pointer to the next line that isn't empty or only contains a
860 * comment. Skips over white space.
861 * Returns NULL if there is none.
862 */
Bram Moolenaar7a4b8982020-07-08 17:36:21 +0200863 char_u *
864peek_next_line_from_context(cctx_T *cctx)
Bram Moolenaar23c55272020-06-21 16:58:13 +0200865{
866 int lnum = cctx->ctx_lnum;
867
868 while (++lnum < cctx->ctx_ufunc->uf_lines.ga_len)
869 {
870 char_u *line = ((char_u **)cctx->ctx_ufunc->uf_lines.ga_data)[lnum];
Bram Moolenaaracd4c5e2020-06-22 19:39:03 +0200871 char_u *p;
Bram Moolenaar23c55272020-06-21 16:58:13 +0200872
Bram Moolenaarba60cc42020-08-12 19:15:33 +0200873 // ignore NULLs inserted for continuation lines
874 if (line != NULL)
875 {
876 p = skipwhite(line);
Bram Moolenaar4b3e1962021-03-18 21:37:55 +0100877 if (vim9_bad_comment(p))
878 return NULL;
Bram Moolenaarba60cc42020-08-12 19:15:33 +0200879 if (*p != NUL && !vim9_comment_start(p))
880 return p;
881 }
Bram Moolenaar23c55272020-06-21 16:58:13 +0200882 }
883 return NULL;
884}
885
886/*
Bram Moolenaare6085c52020-04-12 20:19:16 +0200887 * Get the next line of the function from "cctx".
Bram Moolenaar23c55272020-06-21 16:58:13 +0200888 * Skips over empty lines. Skips over comment lines if "skip_comment" is TRUE.
Bram Moolenaare6085c52020-04-12 20:19:16 +0200889 * Returns NULL when at the end.
890 */
Bram Moolenaar7a4b8982020-07-08 17:36:21 +0200891 char_u *
Bram Moolenaar23c55272020-06-21 16:58:13 +0200892next_line_from_context(cctx_T *cctx, int skip_comment)
Bram Moolenaare6085c52020-04-12 20:19:16 +0200893{
Bram Moolenaar7a092242020-04-16 22:10:49 +0200894 char_u *line;
Bram Moolenaare6085c52020-04-12 20:19:16 +0200895
896 do
897 {
898 ++cctx->ctx_lnum;
899 if (cctx->ctx_lnum >= cctx->ctx_ufunc->uf_lines.ga_len)
Bram Moolenaar7a092242020-04-16 22:10:49 +0200900 {
901 line = NULL;
Bram Moolenaare6085c52020-04-12 20:19:16 +0200902 break;
Bram Moolenaar7a092242020-04-16 22:10:49 +0200903 }
Bram Moolenaare6085c52020-04-12 20:19:16 +0200904 line = ((char_u **)cctx->ctx_ufunc->uf_lines.ga_data)[cctx->ctx_lnum];
Bram Moolenaar7a092242020-04-16 22:10:49 +0200905 cctx->ctx_line_start = line;
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200906 SOURCING_LNUM = cctx->ctx_lnum + 1;
Bram Moolenaar23c55272020-06-21 16:58:13 +0200907 } while (line == NULL || *skipwhite(line) == NUL
Bram Moolenaar2dd0a2c2020-08-08 15:10:27 +0200908 || (skip_comment && vim9_comment_start(skipwhite(line))));
Bram Moolenaare6085c52020-04-12 20:19:16 +0200909 return line;
910}
911
912/*
Bram Moolenaar5afd0812021-01-03 18:33:13 +0100913 * Skip over white space at "whitep" and assign to "*arg".
Bram Moolenaar9c7e6dd2020-04-12 20:55:20 +0200914 * If "*arg" is at the end of the line, advance to the next line.
Bram Moolenaar2c330432020-04-13 14:41:35 +0200915 * Also when "whitep" points to white space and "*arg" is on a "#".
Bram Moolenaar9c7e6dd2020-04-12 20:55:20 +0200916 * Return FAIL if beyond the last line, "*arg" is unmodified then.
917 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +0000918 int
Bram Moolenaar2c330432020-04-13 14:41:35 +0200919may_get_next_line(char_u *whitep, char_u **arg, cctx_T *cctx)
Bram Moolenaar9c7e6dd2020-04-12 20:55:20 +0200920{
Bram Moolenaar5afd0812021-01-03 18:33:13 +0100921 *arg = skipwhite(whitep);
Bram Moolenaar4b3e1962021-03-18 21:37:55 +0100922 if (vim9_bad_comment(*arg))
923 return FAIL;
Bram Moolenaarf5be8cd2020-07-17 20:36:00 +0200924 if (**arg == NUL || (VIM_ISWHITE(*whitep) && vim9_comment_start(*arg)))
Bram Moolenaar9c7e6dd2020-04-12 20:55:20 +0200925 {
Bram Moolenaar23c55272020-06-21 16:58:13 +0200926 char_u *next = next_line_from_context(cctx, TRUE);
Bram Moolenaar9c7e6dd2020-04-12 20:55:20 +0200927
928 if (next == NULL)
929 return FAIL;
930 *arg = skipwhite(next);
931 }
932 return OK;
933}
934
Bram Moolenaara7eedf32020-07-10 21:50:41 +0200935/*
936 * Idem, and give an error when failed.
937 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +0000938 int
Bram Moolenaara7eedf32020-07-10 21:50:41 +0200939may_get_next_line_error(char_u *whitep, char_u **arg, cctx_T *cctx)
940{
941 if (may_get_next_line(whitep, arg, cctx) == FAIL)
942 {
Bram Moolenaar8ff16e02020-12-07 21:49:52 +0100943 SOURCING_LNUM = cctx->ctx_lnum + 1;
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200944 emsg(_(e_line_incomplete));
Bram Moolenaara7eedf32020-07-10 21:50:41 +0200945 return FAIL;
946 }
947 return OK;
948}
949
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100950/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200951 * Get a line from the compilation context, compatible with exarg_T getline().
952 * Return a pointer to the line in allocated memory.
953 * Return NULL for end-of-file or some error.
954 */
955 static char_u *
956exarg_getline(
957 int c UNUSED,
958 void *cookie,
959 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +0200960 getline_opt_T options UNUSED)
Bram Moolenaar04b12692020-05-04 23:24:44 +0200961{
962 cctx_T *cctx = (cctx_T *)cookie;
Bram Moolenaar66250c92020-08-20 15:02:42 +0200963 char_u *p;
Bram Moolenaar04b12692020-05-04 23:24:44 +0200964
Bram Moolenaar66250c92020-08-20 15:02:42 +0200965 for (;;)
Bram Moolenaar04b12692020-05-04 23:24:44 +0200966 {
Bram Moolenaar2914a202020-09-27 18:24:03 +0200967 if (cctx->ctx_lnum >= cctx->ctx_ufunc->uf_lines.ga_len - 1)
Bram Moolenaar66250c92020-08-20 15:02:42 +0200968 return NULL;
969 ++cctx->ctx_lnum;
970 p = ((char_u **)cctx->ctx_ufunc->uf_lines.ga_data)[cctx->ctx_lnum];
971 // Comment lines result in NULL pointers, skip them.
972 if (p != NULL)
973 return vim_strsave(p);
Bram Moolenaar04b12692020-05-04 23:24:44 +0200974 }
Bram Moolenaar04b12692020-05-04 23:24:44 +0200975}
976
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100977 void
978fill_exarg_from_cctx(exarg_T *eap, cctx_T *cctx)
979{
Zoltan Arpadffy6fdb6282023-12-19 20:53:07 +0100980 eap->ea_getline = exarg_getline;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100981 eap->cookie = cctx;
Bram Moolenaar4f3321f2022-03-13 13:12:27 +0000982 eap->skip = cctx->ctx_skip == SKIP_YES;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100983}
984
Bram Moolenaar04b12692020-05-04 23:24:44 +0200985/*
Bram Moolenaardc7c3662021-12-20 15:04:29 +0000986 * Return TRUE if "ufunc" should be compiled, taking into account whether
987 * "profile" indicates profiling is to be done.
988 */
989 int
990func_needs_compiling(ufunc_T *ufunc, compiletype_T compile_type)
991{
992 switch (ufunc->uf_def_status)
993 {
994 case UF_TO_BE_COMPILED:
995 return TRUE;
996
997 case UF_COMPILED:
998 {
999 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
1000 + ufunc->uf_dfunc_idx;
1001
1002 switch (compile_type)
1003 {
1004 case CT_PROFILE:
1005#ifdef FEAT_PROFILE
1006 return dfunc->df_instr_prof == NULL;
1007#endif
1008 case CT_NONE:
1009 return dfunc->df_instr == NULL;
1010 case CT_DEBUG:
1011 return dfunc->df_instr_debug == NULL;
1012 }
1013 }
1014
1015 case UF_NOT_COMPILED:
1016 case UF_COMPILE_ERROR:
1017 case UF_COMPILING:
1018 break;
1019 }
1020 return FALSE;
1021}
1022
1023/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02001024 * Compile a nested :def command.
1025 */
1026 static char_u *
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00001027compile_nested_function(exarg_T *eap, cctx_T *cctx, garray_T *lines_to_free)
Bram Moolenaar04b12692020-05-04 23:24:44 +02001028{
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001029 int is_global = *eap->arg == 'g' && eap->arg[1] == ':';
Bram Moolenaar04b12692020-05-04 23:24:44 +02001030 char_u *name_start = eap->arg;
Bram Moolenaarbcbf4132020-08-01 22:35:13 +02001031 char_u *name_end = to_name_end(eap->arg, TRUE);
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001032 int off;
1033 char_u *func_name;
Bram Moolenaareef21022020-08-01 22:16:43 +02001034 char_u *lambda_name;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001035 ufunc_T *ufunc;
Bram Moolenaar58a52f22020-12-22 18:56:55 +01001036 int r = FAIL;
Bram Moolenaarffcfddc2021-07-11 20:22:30 +02001037 compiletype_T compile_type;
Yegappan Lakshmanana76fbe62023-09-27 18:51:43 +02001038 int funcref_isn_idx = -1;
Bram Moolenaar1889f492022-08-16 19:34:44 +01001039 lvar_T *lvar = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001040
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +02001041 if (eap->forceit)
Bram Moolenaar8b848ca2020-09-10 22:28:01 +02001042 {
1043 emsg(_(e_cannot_use_bang_with_nested_def));
1044 return NULL;
1045 }
1046
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01001047 if (*name_start == '/')
1048 {
1049 name_end = skip_regexp(name_start + 1, '/', TRUE);
1050 if (*name_end == '/')
1051 ++name_end;
Bram Moolenaar63b91732021-08-05 20:40:03 +02001052 set_nextcmd(eap, name_end);
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01001053 }
1054 if (name_end == name_start || *skipwhite(name_end) != '(')
1055 {
1056 if (!ends_excmd2(name_start, name_end))
1057 {
Bram Moolenaardea5ab02022-02-23 22:12:02 +00001058 if (*skipwhite(name_end) == '.')
1059 semsg(_(e_cannot_define_dict_func_in_vim9_script_str),
1060 eap->cmd);
1061 else
1062 semsg(_(e_invalid_command_str), eap->cmd);
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01001063 return NULL;
1064 }
1065
1066 // "def" or "def Name": list functions
1067 if (generate_DEF(cctx, name_start, name_end - name_start) == FAIL)
1068 return NULL;
1069 return eap->nextcmd == NULL ? (char_u *)"" : eap->nextcmd;
1070 }
1071
Bram Moolenaarbcbf4132020-08-01 22:35:13 +02001072 // Only g:Func() can use a namespace.
1073 if (name_start[1] == ':' && !is_global)
1074 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02001075 semsg(_(e_namespace_not_supported_str), name_start);
Bram Moolenaarbcbf4132020-08-01 22:35:13 +02001076 return NULL;
1077 }
Bram Moolenaar4f3321f2022-03-13 13:12:27 +00001078 if (cctx->ctx_skip != SKIP_YES
1079 && check_defined(name_start, name_end - name_start, cctx,
Bram Moolenaardce24412022-02-08 20:35:30 +00001080 NULL, FALSE) == FAIL)
Bram Moolenaareef21022020-08-01 22:16:43 +02001081 return NULL;
Bram Moolenaarf681cfb2022-02-07 20:30:57 +00001082 if (!ASCII_ISUPPER(is_global ? name_start[2] : name_start[0]))
1083 {
Bram Moolenaar3787f262022-02-07 21:54:01 +00001084 semsg(_(e_function_name_must_start_with_capital_str), name_start);
Bram Moolenaarf681cfb2022-02-07 20:30:57 +00001085 return NULL;
1086 }
Bram Moolenaareef21022020-08-01 22:16:43 +02001087
Bram Moolenaar04b12692020-05-04 23:24:44 +02001088 eap->arg = name_end;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001089 fill_exarg_from_cctx(eap, cctx);
1090
Bram Moolenaar04b12692020-05-04 23:24:44 +02001091 eap->forceit = FALSE;
Bram Moolenaar38453522021-11-28 22:00:12 +00001092 // We use the special <Lamba>99 name, but it's not really a lambda.
Bram Moolenaar58a52f22020-12-22 18:56:55 +01001093 lambda_name = vim_strsave(get_lambda_name());
1094 if (lambda_name == NULL)
1095 return NULL;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001096
1097 // This may free the current line, make a copy of the name.
1098 off = is_global ? 2 : 0;
1099 func_name = vim_strnsave(name_start + off, name_end - name_start - off);
1100 if (func_name == NULL)
1101 {
1102 r = FAIL;
1103 goto theend;
1104 }
1105
Bram Moolenaar39c82ea2023-01-02 13:08:01 +00001106 // Make sure "KeyTyped" is not set, it may cause indent to be written.
1107 int save_KeyTyped = KeyTyped;
1108 KeyTyped = FALSE;
1109
h-eastb895b0f2023-09-24 15:46:31 +02001110 ufunc = define_function(eap, lambda_name, lines_to_free, 0, NULL, 0);
Bram Moolenaar39c82ea2023-01-02 13:08:01 +00001111
1112 KeyTyped = save_KeyTyped;
1113
Bram Moolenaar822ba242020-05-24 23:00:18 +02001114 if (ufunc == NULL)
Bram Moolenaar58a52f22020-12-22 18:56:55 +01001115 {
1116 r = eap->skip ? OK : FAIL;
1117 goto theend;
1118 }
Bram Moolenaar7473a842021-12-28 17:55:26 +00001119 if (eap->nextcmd != NULL)
1120 {
1121 semsg(_(e_text_found_after_str_str),
1122 eap->cmdidx == CMD_def ? "enddef" : "endfunction", eap->nextcmd);
1123 r = FAIL;
Bram Moolenaard2939812021-12-30 17:09:05 +00001124 func_ptr_unref(ufunc);
Bram Moolenaar7473a842021-12-28 17:55:26 +00001125 goto theend;
1126 }
Bram Moolenaar8863bda2021-03-17 18:42:08 +01001127
1128 // copy over the block scope IDs before compiling
1129 if (!is_global && cctx->ctx_ufunc->uf_block_depth > 0)
1130 {
1131 int block_depth = cctx->ctx_ufunc->uf_block_depth;
1132
1133 ufunc->uf_block_ids = ALLOC_MULT(int, block_depth);
1134 if (ufunc->uf_block_ids != NULL)
1135 {
1136 mch_memmove(ufunc->uf_block_ids, cctx->ctx_ufunc->uf_block_ids,
1137 sizeof(int) * block_depth);
1138 ufunc->uf_block_depth = block_depth;
1139 }
1140 }
1141
Bram Moolenaara915fa02022-03-23 11:29:15 +00001142 // Define the funcref before compiling, so that it is found by any
1143 // recursive call.
1144 if (is_global)
1145 {
Bram Moolenaar65449bd2022-09-19 16:02:43 +01001146 r = generate_NEWFUNC(cctx, lambda_name, func_name);
Bram Moolenaara915fa02022-03-23 11:29:15 +00001147 func_name = NULL;
1148 lambda_name = NULL;
1149 }
1150 else
1151 {
1152 // Define a local variable for the function reference.
Bram Moolenaar1889f492022-08-16 19:34:44 +01001153 lvar = reserve_local(cctx, func_name, name_end - name_start,
Bram Moolenaar6586a012022-09-30 11:04:50 +01001154 ASSIGN_CONST, ufunc->uf_func_type);
Bram Moolenaara915fa02022-03-23 11:29:15 +00001155 if (lvar == NULL)
1156 goto theend;
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02001157 if (generate_FUNCREF(cctx, ufunc, NULL, FALSE, 0, &funcref_isn_idx) == FAIL)
Bram Moolenaara915fa02022-03-23 11:29:15 +00001158 goto theend;
1159 r = generate_STORE(cctx, ISN_STORE, lvar->lv_idx, NULL);
1160 }
1161
Bram Moolenaar139575d2022-03-15 19:29:30 +00001162 compile_type = get_compile_type(ufunc);
Bram Moolenaarffcfddc2021-07-11 20:22:30 +02001163#ifdef FEAT_PROFILE
1164 // If the outer function is profiled, also compile the nested function for
1165 // profiling.
1166 if (cctx->ctx_compile_type == CT_PROFILE)
1167 compile_type = CT_PROFILE;
1168#endif
1169 if (func_needs_compiling(ufunc, compile_type)
1170 && compile_def_function(ufunc, TRUE, compile_type, cctx) == FAIL)
Bram Moolenaar4ee711f2020-09-23 18:51:11 +02001171 {
1172 func_ptr_unref(ufunc);
Bram Moolenaar1889f492022-08-16 19:34:44 +01001173 if (lvar != NULL)
1174 // Now the local variable can't be used.
1175 *lvar->lv_name = '/'; // impossible value
Bram Moolenaar58a52f22020-12-22 18:56:55 +01001176 goto theend;
Bram Moolenaar4ee711f2020-09-23 18:51:11 +02001177 }
Bram Moolenaar04b12692020-05-04 23:24:44 +02001178
Bram Moolenaar648594e2021-07-11 17:55:01 +02001179#ifdef FEAT_PROFILE
1180 // When the outer function is compiled for profiling, the nested function
1181 // may be called without profiling. Compile it here in the right context.
Bram Moolenaarffcfddc2021-07-11 20:22:30 +02001182 if (compile_type == CT_PROFILE && func_needs_compiling(ufunc, CT_NONE))
Bram Moolenaar648594e2021-07-11 17:55:01 +02001183 compile_def_function(ufunc, FALSE, CT_NONE, cctx);
1184#endif
1185
Bram Moolenaara915fa02022-03-23 11:29:15 +00001186 // If a FUNCREF instruction was generated, set the index after compiling.
Yegappan Lakshmanana76fbe62023-09-27 18:51:43 +02001187 if (funcref_isn_idx != -1 && ufunc->uf_def_status == UF_COMPILED)
1188 {
1189 isn_T *funcref_isn = ((isn_T *)cctx->ctx_instr.ga_data) +
1190 funcref_isn_idx;
Bram Moolenaara915fa02022-03-23 11:29:15 +00001191 funcref_isn->isn_arg.funcref.fr_dfunc_idx = ufunc->uf_dfunc_idx;
Yegappan Lakshmanana76fbe62023-09-27 18:51:43 +02001192 }
Bram Moolenaar58a52f22020-12-22 18:56:55 +01001193
1194theend:
1195 vim_free(lambda_name);
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001196 vim_free(func_name);
Bram Moolenaar38ddf332020-07-31 22:05:04 +02001197 return r == FAIL ? NULL : (char_u *)"";
Bram Moolenaar04b12692020-05-04 23:24:44 +02001198}
1199
1200/*
Bram Moolenaar0abc2872022-05-10 13:24:30 +01001201 * Compile one Vim expression {expr} in string "p".
1202 * "p" points to the opening "{".
1203 * Return a pointer to the character after "}", NULL for an error.
1204 */
1205 char_u *
1206compile_one_expr_in_str(char_u *p, cctx_T *cctx)
1207{
1208 char_u *block_start;
1209 char_u *block_end;
1210
1211 // Skip the opening {.
1212 block_start = skipwhite(p + 1);
1213 block_end = block_start;
1214 if (*block_start != NUL && skip_expr(&block_end, NULL) == FAIL)
1215 return NULL;
1216 block_end = skipwhite(block_end);
1217 // The block must be closed by a }.
1218 if (*block_end != '}')
1219 {
1220 semsg(_(e_missing_close_curly_str), p);
1221 return NULL;
1222 }
1223 if (compile_expr0(&block_start, cctx) == FAIL)
1224 return NULL;
Yegappan Lakshmananbce51d92024-04-15 19:19:52 +02001225 may_generate_2STRING(-1, TOSTRING_INTERPOLATE, cctx);
Bram Moolenaar0abc2872022-05-10 13:24:30 +01001226
1227 return block_end + 1;
1228}
1229
1230/*
LemonBoy2eaef102022-05-06 13:14:50 +01001231 * Compile a string "str" (either containing a literal string or a mix of
1232 * literal strings and Vim expressions of the form `{expr}`). This is used
1233 * when compiling a heredoc assignment to a variable or an interpolated string
1234 * in a Vim9 def function. Vim9 instructions are generated to push strings,
1235 * evaluate expressions, concatenate them and create a list of lines. When
1236 * "evalstr" is TRUE, Vim expressions in "str" are evaluated.
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01001237 */
1238 int
LemonBoy2eaef102022-05-06 13:14:50 +01001239compile_all_expr_in_str(char_u *str, int evalstr, cctx_T *cctx)
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01001240{
LemonBoy2eaef102022-05-06 13:14:50 +01001241 char_u *p = str;
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01001242 char_u *val;
LemonBoy2eaef102022-05-06 13:14:50 +01001243 int count = 0;
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01001244
1245 if (cctx->ctx_skip == SKIP_YES)
1246 return OK;
1247
LemonBoy2eaef102022-05-06 13:14:50 +01001248 if (!evalstr || *str == NUL)
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01001249 {
LemonBoy2eaef102022-05-06 13:14:50 +01001250 // Literal string, possibly empty.
1251 val = *str != NUL ? vim_strsave(str) : NULL;
1252 return generate_PUSHS(cctx, &val);
1253 }
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01001254
LemonBoy2eaef102022-05-06 13:14:50 +01001255 // Push all the string pieces to the stack, followed by a ISN_CONCAT.
1256 while (*p != NUL)
1257 {
1258 char_u *lit_start;
LemonBoy2eaef102022-05-06 13:14:50 +01001259 int escaped_brace = FALSE;
1260
1261 // Look for a block start.
1262 lit_start = p;
1263 while (*p != '{' && *p != '}' && *p != NUL)
1264 ++p;
1265
1266 if (*p != NUL && *p == p[1])
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01001267 {
LemonBoy2eaef102022-05-06 13:14:50 +01001268 // Escaped brace, unescape and continue.
1269 // Include the brace in the literal string.
1270 ++p;
1271 escaped_brace = TRUE;
1272 }
1273 else if (*p == '}')
1274 {
1275 semsg(_(e_stray_closing_curly_str), str);
1276 return FAIL;
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01001277 }
LemonBoy372bcce2022-04-25 12:43:20 +01001278
LemonBoy2eaef102022-05-06 13:14:50 +01001279 // Append the literal part.
1280 if (p != lit_start)
1281 {
1282 val = vim_strnsave(lit_start, (size_t)(p - lit_start));
1283 if (generate_PUSHS(cctx, &val) == FAIL)
1284 return FAIL;
1285 ++count;
1286 }
1287
1288 if (*p == NUL)
1289 break;
1290
1291 if (escaped_brace)
1292 {
1293 // Skip the second brace.
1294 ++p;
1295 continue;
1296 }
1297
Bram Moolenaar0abc2872022-05-10 13:24:30 +01001298 p = compile_one_expr_in_str(p, cctx);
1299 if (p == NULL)
LemonBoy2eaef102022-05-06 13:14:50 +01001300 return FAIL;
LemonBoy2eaef102022-05-06 13:14:50 +01001301 ++count;
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01001302 }
LemonBoy2eaef102022-05-06 13:14:50 +01001303
1304 // Small optimization, if there's only a single piece skip the ISN_CONCAT.
Bram Moolenaar0abc2872022-05-10 13:24:30 +01001305 if (count > 1)
LemonBoy2eaef102022-05-06 13:14:50 +01001306 return generate_CONCAT(cctx, count);
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01001307
1308 return OK;
1309}
1310
1311/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001312 * Return the length of an assignment operator, or zero if there isn't one.
1313 */
1314 int
1315assignment_len(char_u *p, int *heredoc)
1316{
1317 if (*p == '=')
1318 {
1319 if (p[1] == '<' && p[2] == '<')
1320 {
1321 *heredoc = TRUE;
1322 return 3;
1323 }
1324 return 1;
1325 }
1326 if (vim_strchr((char_u *)"+-*/%", *p) != NULL && p[1] == '=')
1327 return 2;
1328 if (STRNCMP(p, "..=", 3) == 0)
1329 return 3;
1330 return 0;
1331}
1332
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001333/*
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001334 * Generate the load instruction for "name".
1335 */
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02001336 static int
Bram Moolenaard505d172022-12-18 21:42:55 +00001337generate_loadvar(cctx_T *cctx, lhs_T *lhs)
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001338{
Bram Moolenaard505d172022-12-18 21:42:55 +00001339 char_u *name = lhs->lhs_name;
1340 type_T *type = lhs->lhs_type;
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02001341 int res = OK;
Bram Moolenaard505d172022-12-18 21:42:55 +00001342
1343 switch (lhs->lhs_dest)
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001344 {
1345 case dest_option:
Bram Moolenaardcb53be2021-12-09 14:23:43 +00001346 case dest_func_option:
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001347 generate_LOAD(cctx, ISN_LOADOPT, 0, name, type);
1348 break;
1349 case dest_global:
Bram Moolenaar03290b82020-12-19 16:30:44 +01001350 if (vim_strchr(name, AUTOLOAD_CHAR) == NULL)
Bram Moolenaar2e17fef2022-03-18 19:44:48 +00001351 {
1352 if (name[2] == NUL)
1353 generate_instr_type(cctx, ISN_LOADGDICT, &t_dict_any);
1354 else
1355 generate_LOAD(cctx, ISN_LOADG, 0, name + 2, type);
1356 }
Bram Moolenaar03290b82020-12-19 16:30:44 +01001357 else
1358 generate_LOAD(cctx, ISN_LOADAUTO, 0, name, type);
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001359 break;
1360 case dest_buffer:
1361 generate_LOAD(cctx, ISN_LOADB, 0, name + 2, type);
1362 break;
1363 case dest_window:
1364 generate_LOAD(cctx, ISN_LOADW, 0, name + 2, type);
1365 break;
1366 case dest_tab:
1367 generate_LOAD(cctx, ISN_LOADT, 0, name + 2, type);
1368 break;
1369 case dest_script:
Ernie Rael3f821d62024-04-24 20:07:50 +02001370 case dest_script_v9:
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02001371 res = compile_load_scriptvar(cctx,
Bram Moolenaard0132f42022-05-12 11:05:40 +01001372 name + (name[1] == ':' ? 2 : 0), NULL, NULL);
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001373 break;
1374 case dest_env:
1375 // Include $ in the name here
1376 generate_LOAD(cctx, ISN_LOADENV, 0, name, type);
1377 break;
1378 case dest_reg:
1379 generate_LOAD(cctx, ISN_LOADREG, name[1], NULL, &t_string);
1380 break;
1381 case dest_vimvar:
Bram Moolenaarc3caa7f2022-05-25 19:15:10 +01001382 generate_LOADV(cctx, name + 2);
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001383 break;
1384 case dest_local:
Bram Moolenaar4875d6a2022-08-17 15:55:51 +01001385 if (cctx->ctx_skip != SKIP_YES)
1386 {
Bram Moolenaard505d172022-12-18 21:42:55 +00001387 lvar_T *lvar = lhs->lhs_lvar;
Bram Moolenaar4875d6a2022-08-17 15:55:51 +01001388 if (lvar->lv_from_outer > 0)
1389 generate_LOADOUTER(cctx, lvar->lv_idx, lvar->lv_from_outer,
Bram Moolenaar65449bd2022-09-19 16:02:43 +01001390 lvar->lv_loop_depth, lvar->lv_loop_idx, type);
Bram Moolenaar4875d6a2022-08-17 15:55:51 +01001391 else
1392 generate_LOAD(cctx, ISN_LOAD, lvar->lv_idx, NULL, type);
1393 }
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001394 break;
Bram Moolenaard505d172022-12-18 21:42:55 +00001395 case dest_class_member:
1396 generate_CLASSMEMBER(cctx, TRUE, lhs->lhs_class,
1397 lhs->lhs_classmember_idx);
1398 break;
Bram Moolenaardc234ca2020-11-28 18:52:33 +01001399 case dest_expr:
1400 // list or dict value should already be on the stack.
1401 break;
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001402 }
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02001403
1404 return res;
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001405}
1406
Bram Moolenaardc234ca2020-11-28 18:52:33 +01001407/*
1408 * Skip over "[expr]" or ".member".
1409 * Does not check for any errors.
1410 */
1411 static char_u *
1412skip_index(char_u *start)
1413{
1414 char_u *p = start;
1415
1416 if (*p == '[')
1417 {
1418 p = skipwhite(p + 1);
1419 (void)skip_expr(&p, NULL);
1420 p = skipwhite(p);
1421 if (*p == ']')
1422 return p + 1;
1423 return p;
1424 }
1425 // if (*p == '.')
1426 return to_name_end(p + 1, TRUE);
1427}
1428
Bram Moolenaare55b1c02020-06-21 15:52:59 +02001429 void
1430vim9_declare_error(char_u *name)
1431{
1432 char *scope = "";
1433
1434 switch (*name)
1435 {
Bram Moolenaar7fe87552020-06-21 20:38:28 +02001436 case 'g': scope = _("global"); break;
1437 case 'b': scope = _("buffer"); break;
1438 case 'w': scope = _("window"); break;
1439 case 't': scope = _("tab"); break;
1440 case 'v': scope = "v:"; break;
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00001441 case '$': semsg(_(e_cannot_declare_an_environment_variable_str), name);
Bram Moolenaarc2ee44c2020-08-02 16:59:00 +02001442 return;
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00001443 case '&': semsg(_(e_cannot_declare_an_option_str), name);
Bram Moolenaarc2ee44c2020-08-02 16:59:00 +02001444 return;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001445 case '@': semsg(_(e_cannot_declare_a_register_str), name);
Bram Moolenaarc2ee44c2020-08-02 16:59:00 +02001446 return;
Bram Moolenaar7fe87552020-06-21 20:38:28 +02001447 default: return;
Bram Moolenaare55b1c02020-06-21 15:52:59 +02001448 }
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00001449 semsg(_(e_cannot_declare_a_scope_variable_str), scope, name);
Bram Moolenaare55b1c02020-06-21 15:52:59 +02001450}
1451
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001452/*
Bram Moolenaar3558afe2022-10-13 16:12:57 +01001453 * Return TRUE if "name" is a valid register to use.
1454 * Return FALSE and give an error message if not.
1455 */
1456 static int
1457valid_dest_reg(int name)
1458{
1459 if ((name == '@' || valid_yank_reg(name, FALSE)) && name != '.')
1460 return TRUE;
1461 emsg_invreg(name);
1462 return FAIL;
1463}
1464
1465/*
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001466 * For one assignment figure out the type of destination. Return it in "dest".
1467 * When not recognized "dest" is not set.
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001468 * For an option "option_scope" is set.
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001469 * For a v:var "vimvaridx" is set.
1470 * "type" is set to the destination type if known, unchanted otherwise.
1471 * Return FAIL if an error message was given.
1472 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +00001473 int
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001474get_var_dest(
1475 char_u *name,
1476 assign_dest_T *dest,
Bram Moolenaar97f8c102022-04-02 19:43:57 +01001477 cmdidx_T cmdidx,
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001478 int *option_scope,
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001479 int *vimvaridx,
1480 type_T **type,
1481 cctx_T *cctx)
1482{
1483 char_u *p;
1484
1485 if (*name == '&')
1486 {
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001487 int cc;
1488 long numval;
1489 getoption_T opt_type;
Bram Moolenaardcb53be2021-12-09 14:23:43 +00001490 int opt_p_flags;
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001491
1492 *dest = dest_option;
1493 if (cmdidx == CMD_final || cmdidx == CMD_const)
1494 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00001495 emsg(_(e_cannot_lock_option));
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001496 return FAIL;
1497 }
1498 p = name;
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001499 p = find_option_end(&p, option_scope);
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001500 if (p == NULL)
1501 {
1502 // cannot happen?
Bram Moolenaar108010a2021-06-27 22:03:33 +02001503 emsg(_(e_unexpected_characters_in_assignment));
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001504 return FAIL;
1505 }
1506 cc = *p;
1507 *p = NUL;
1508 opt_type = get_option_value(skip_option_env_lead(name),
Bram Moolenaardcb53be2021-12-09 14:23:43 +00001509 &numval, NULL, &opt_p_flags, *option_scope);
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001510 *p = cc;
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001511 switch (opt_type)
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001512 {
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001513 case gov_unknown:
Bram Moolenaare1242042021-12-16 20:56:57 +00001514 semsg(_(e_unknown_option_str), name);
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001515 return FAIL;
1516 case gov_string:
1517 case gov_hidden_string:
Bram Moolenaardcb53be2021-12-09 14:23:43 +00001518 if (opt_p_flags & P_FUNC)
1519 {
1520 // might be a Funcref, check the type later
1521 *type = &t_any;
1522 *dest = dest_func_option;
1523 }
1524 else
1525 {
1526 *type = &t_string;
1527 }
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001528 break;
1529 case gov_bool:
1530 case gov_hidden_bool:
1531 *type = &t_bool;
1532 break;
1533 case gov_number:
1534 case gov_hidden_number:
1535 *type = &t_number;
1536 break;
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001537 }
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001538 }
1539 else if (*name == '$')
1540 {
1541 *dest = dest_env;
1542 *type = &t_string;
1543 }
1544 else if (*name == '@')
1545 {
Bram Moolenaar3558afe2022-10-13 16:12:57 +01001546 if (!valid_dest_reg(name[1]))
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001547 return FAIL;
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001548 *dest = dest_reg;
Bram Moolenaar74f4a962021-06-17 21:03:07 +02001549 *type = name[1] == '#' ? &t_number_or_string : &t_string;
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001550 }
1551 else if (STRNCMP(name, "g:", 2) == 0)
1552 {
1553 *dest = dest_global;
1554 }
1555 else if (STRNCMP(name, "b:", 2) == 0)
1556 {
1557 *dest = dest_buffer;
1558 }
1559 else if (STRNCMP(name, "w:", 2) == 0)
1560 {
1561 *dest = dest_window;
1562 }
1563 else if (STRNCMP(name, "t:", 2) == 0)
1564 {
1565 *dest = dest_tab;
1566 }
1567 else if (STRNCMP(name, "v:", 2) == 0)
1568 {
1569 typval_T *vtv;
1570 int di_flags;
1571
1572 *vimvaridx = find_vim_var(name + 2, &di_flags);
1573 if (*vimvaridx < 0)
1574 {
1575 semsg(_(e_variable_not_found_str), name);
1576 return FAIL;
1577 }
1578 // We use the current value of "sandbox" here, is that OK?
1579 if (var_check_ro(di_flags, name, FALSE))
1580 return FAIL;
1581 *dest = dest_vimvar;
1582 vtv = get_vim_var_tv(*vimvaridx);
1583 *type = typval2type_vimvar(vtv, cctx->ctx_type_list);
1584 }
1585 return OK;
1586}
1587
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02001588 static int
Bram Moolenaar97f8c102022-04-02 19:43:57 +01001589is_decl_command(cmdidx_T cmdidx)
Bram Moolenaar752fc692021-01-04 21:57:11 +01001590{
1591 return cmdidx == CMD_let || cmdidx == CMD_var
1592 || cmdidx == CMD_final || cmdidx == CMD_const;
1593}
1594
1595/*
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02001596 * Returns TRUE if the class or object variable in "lhs" is modifiable.
1597 * "var_start" points to the start of the variable name and "lhs->lhs_varlen"
1598 * has the total length. Note that the "lhs" can be nested an object reference
1599 * (e.g. a.b.c.d.var).
1600 */
1601 static int
1602lhs_class_member_modifiable(lhs_T *lhs, char_u *var_start, cctx_T *cctx)
1603{
1604 size_t varlen = lhs->lhs_varlen;
1605 class_T *cl = lhs->lhs_type->tt_class;
1606 int is_object = lhs->lhs_type->tt_type == VAR_OBJECT;
1607 char_u *name = var_start + varlen + 1;
1608 size_t namelen = lhs->lhs_end - var_start - varlen - 1;
1609 ocmember_T *m;
1610
1611 m = member_lookup(cl, lhs->lhs_type->tt_type, name, namelen, NULL);
1612 if (m == NULL)
1613 {
1614 member_not_found_msg(cl, lhs->lhs_type->tt_type, name, namelen);
1615 return FALSE;
1616 }
1617
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01001618 if (IS_ENUM(cl))
1619 {
1620 semsg(_(e_enumvalue_str_cannot_be_modified), cl->class_name,
1621 m->ocm_name);
1622 return FALSE;
1623 }
1624
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02001625 // If it is private member variable, then accessing it outside the
1626 // class is not allowed.
1627 // If it is a read only class variable, then it can be modified
1628 // only inside the class where it is defined.
1629 if ((m->ocm_access != VIM_ACCESS_ALL) &&
1630 ((is_object && !inside_class(cctx, cl))
1631 || (!is_object && cctx->ctx_ufunc->uf_class != cl)))
1632 {
1633 char *msg = (m->ocm_access == VIM_ACCESS_PRIVATE)
Ernie Rael03042a22023-11-11 08:53:32 +01001634 ? e_cannot_access_protected_variable_str
RestorerZ7fe8f432023-09-24 23:21:24 +02001635 : e_variable_is_not_writable_str;
Ernie Raele6c9aa52023-10-06 19:55:52 +02001636 emsg_var_cl_define(msg, m->ocm_name, 0, cl);
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02001637 return FALSE;
1638 }
1639
1640 return TRUE;
1641}
1642
1643/*
Bram Moolenaar752fc692021-01-04 21:57:11 +01001644 * Figure out the LHS type and other properties for an assignment or one item
1645 * of ":unlet" with an index.
1646 * Returns OK or FAIL.
1647 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +00001648 int
Bram Moolenaar752fc692021-01-04 21:57:11 +01001649compile_lhs(
Bram Moolenaar97f8c102022-04-02 19:43:57 +01001650 char_u *var_start,
1651 lhs_T *lhs,
1652 cmdidx_T cmdidx,
1653 int heredoc,
1654 int has_cmd, // "var" before "var_start"
1655 int oplen,
1656 cctx_T *cctx)
Bram Moolenaar752fc692021-01-04 21:57:11 +01001657{
1658 char_u *var_end;
1659 int is_decl = is_decl_command(cmdidx);
1660
1661 CLEAR_POINTER(lhs);
1662 lhs->lhs_dest = dest_local;
1663 lhs->lhs_vimvaridx = -1;
1664 lhs->lhs_scriptvar_idx = -1;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001665 lhs->lhs_member_idx = -1;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001666
1667 // "dest_end" is the end of the destination, including "[expr]" or
1668 // ".name".
1669 // "var_end" is the end of the variable/option/etc. name.
1670 lhs->lhs_dest_end = skip_var_one(var_start, FALSE);
1671 if (*var_start == '@')
Bram Moolenaar3558afe2022-10-13 16:12:57 +01001672 {
1673 if (!valid_dest_reg(var_start[1]))
1674 return FAIL;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001675 var_end = var_start + 2;
Bram Moolenaar3558afe2022-10-13 16:12:57 +01001676 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01001677 else
1678 {
1679 // skip over the leading "&", "&l:", "&g:" and "$"
1680 var_end = skip_option_env_lead(var_start);
1681 var_end = to_name_end(var_end, TRUE);
1682 }
1683
1684 // "a: type" is declaring variable "a" with a type, not dict "a:".
1685 if (is_decl && lhs->lhs_dest_end == var_start + 2
1686 && lhs->lhs_dest_end[-1] == ':')
1687 --lhs->lhs_dest_end;
1688 if (is_decl && var_end == var_start + 2 && var_end[-1] == ':')
1689 --var_end;
Bram Moolenaarab36e6a2021-11-30 16:14:49 +00001690 lhs->lhs_end = lhs->lhs_dest_end;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001691
1692 // compute the length of the destination without "[expr]" or ".name"
1693 lhs->lhs_varlen = var_end - var_start;
Bram Moolenaar753bcf82021-04-21 14:24:24 +02001694 lhs->lhs_varlen_total = lhs->lhs_varlen;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001695 lhs->lhs_name = vim_strnsave(var_start, lhs->lhs_varlen);
1696 if (lhs->lhs_name == NULL)
1697 return FAIL;
Bram Moolenaar08251752021-01-11 21:20:18 +01001698
1699 if (lhs->lhs_dest_end > var_start + lhs->lhs_varlen)
1700 // Something follows after the variable: "var[idx]" or "var.key".
1701 lhs->lhs_has_index = TRUE;
1702
Bram Moolenaar752fc692021-01-04 21:57:11 +01001703 if (heredoc)
1704 lhs->lhs_type = &t_list_string;
1705 else
1706 lhs->lhs_type = &t_any;
1707
1708 if (cctx->ctx_skip != SKIP_YES)
1709 {
1710 int declare_error = FALSE;
1711
1712 if (get_var_dest(lhs->lhs_name, &lhs->lhs_dest, cmdidx,
1713 &lhs->lhs_opt_flags, &lhs->lhs_vimvaridx,
1714 &lhs->lhs_type, cctx) == FAIL)
1715 return FAIL;
Bram Moolenaard877a572021-04-01 19:42:48 +02001716 if (lhs->lhs_dest != dest_local
1717 && cmdidx != CMD_const && cmdidx != CMD_final)
Bram Moolenaar752fc692021-01-04 21:57:11 +01001718 {
1719 // Specific kind of variable recognized.
1720 declare_error = is_decl;
1721 }
1722 else
1723 {
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02001724 class_T *defcl;
1725
Bram Moolenaar752fc692021-01-04 21:57:11 +01001726 // No specific kind of variable recognized, just a name.
h-east2bd6a092023-05-19 19:01:17 +01001727 if (check_reserved_name(lhs->lhs_name, lhs->lhs_has_index
1728 && *var_end == '.') == FAIL)
Bram Moolenaard0edaf92021-05-28 21:06:08 +02001729 return FAIL;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001730
1731 if (lookup_local(var_start, lhs->lhs_varlen,
1732 &lhs->lhs_local_lvar, cctx) == OK)
Bram Moolenaard505d172022-12-18 21:42:55 +00001733 {
Bram Moolenaar752fc692021-01-04 21:57:11 +01001734 lhs->lhs_lvar = &lhs->lhs_local_lvar;
Bram Moolenaard505d172022-12-18 21:42:55 +00001735 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01001736 else
1737 {
1738 CLEAR_FIELD(lhs->lhs_arg_lvar);
1739 if (arg_exists(var_start, lhs->lhs_varlen,
1740 &lhs->lhs_arg_lvar.lv_idx, &lhs->lhs_arg_lvar.lv_type,
1741 &lhs->lhs_arg_lvar.lv_from_outer, cctx) == OK)
1742 {
1743 if (is_decl)
1744 {
1745 semsg(_(e_str_is_used_as_argument), lhs->lhs_name);
1746 return FAIL;
1747 }
1748 lhs->lhs_lvar = &lhs->lhs_arg_lvar;
1749 }
1750 }
Bram Moolenaard505d172022-12-18 21:42:55 +00001751
Bram Moolenaar752fc692021-01-04 21:57:11 +01001752 if (lhs->lhs_lvar != NULL)
1753 {
1754 if (is_decl)
1755 {
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02001756 // if we come here with what looks like an assignment like
Yegappan Lakshmananb5a07192023-10-05 20:14:43 +02001757 // .= but which has been rejected by assignment_len() from
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02001758 // may_compile_assignment give a better error message
Christian Brabandt504543f2023-09-11 20:08:50 +02001759 char_u *p = skipwhite(lhs->lhs_end);
1760 if (p[0] == '.' && p[1] == '=')
1761 emsg(_(e_dot_equal_not_supported_with_script_version_two));
Yegappan Lakshmananb5a07192023-10-05 20:14:43 +02001762 else if (p[0] == ':')
1763 // type specified in a non-var assignment
1764 semsg(_(e_trailing_characters_str), p);
Christian Brabandt504543f2023-09-11 20:08:50 +02001765 else
1766 semsg(_(e_variable_already_declared_str), lhs->lhs_name);
Bram Moolenaar752fc692021-01-04 21:57:11 +01001767 return FAIL;
1768 }
1769 }
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02001770 else if ((lhs->lhs_classmember_idx = cctx_class_member_idx(
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02001771 cctx, var_start, lhs->lhs_varlen, &defcl)) >= 0)
Bram Moolenaard505d172022-12-18 21:42:55 +00001772 {
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02001773 if (cctx->ctx_ufunc->uf_defclass != defcl)
1774 {
1775 // A class variable can be accessed without the class name
1776 // only inside a class.
RestorerZ7fe8f432023-09-24 23:21:24 +02001777 semsg(_(e_class_variable_str_accessible_only_inside_class_str),
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02001778 lhs->lhs_name, defcl->class_name);
1779 return FAIL;
1780 }
Bram Moolenaar6acf7572023-01-01 19:53:30 +00001781 if (is_decl)
1782 {
1783 semsg(_(e_variable_already_declared_in_class_str),
1784 lhs->lhs_name);
1785 return FAIL;
1786 }
Yegappan Lakshmanane5437c52023-12-16 14:11:19 +01001787
1788 ocmember_T *m =
1789 &defcl->class_class_members[lhs->lhs_classmember_idx];
1790 if (oc_var_check_ro(defcl, m))
1791 return FAIL;
1792
Bram Moolenaard505d172022-12-18 21:42:55 +00001793 lhs->lhs_dest = dest_class_member;
Yegappan Lakshmanan2ed5a112024-04-01 14:50:41 +02001794 // The class variable is defined either in the current class or
1795 // in one of the parent class in the hierarchy.
1796 lhs->lhs_class = defcl;
1797 lhs->lhs_type = oc_member_type_by_idx(defcl, FALSE,
1798 lhs->lhs_classmember_idx);
Bram Moolenaard505d172022-12-18 21:42:55 +00001799 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01001800 else
1801 {
1802 int script_namespace = lhs->lhs_varlen > 1
1803 && STRNCMP(var_start, "s:", 2) == 0;
1804 int script_var = (script_namespace
1805 ? script_var_exists(var_start + 2, lhs->lhs_varlen - 2,
Bram Moolenaardce24412022-02-08 20:35:30 +00001806 cctx, NULL)
Bram Moolenaar752fc692021-01-04 21:57:11 +01001807 : script_var_exists(var_start, lhs->lhs_varlen,
Bram Moolenaardce24412022-02-08 20:35:30 +00001808 cctx, NULL)) == OK;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001809 imported_T *import =
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00001810 find_imported(var_start, lhs->lhs_varlen, FALSE);
Bram Moolenaar752fc692021-01-04 21:57:11 +01001811
1812 if (script_namespace || script_var || import != NULL)
1813 {
1814 char_u *rawname = lhs->lhs_name
1815 + (lhs->lhs_name[1] == ':' ? 2 : 0);
1816
Bram Moolenaarafa048f2022-02-22 20:43:36 +00001817 if (script_namespace && current_script_is_vim9())
1818 {
1819 semsg(_(e_cannot_use_s_colon_in_vim9_script_str),
1820 var_start);
1821 return FAIL;
1822 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01001823 if (is_decl)
1824 {
1825 if (script_namespace)
Bram Moolenaara749a422022-02-12 19:52:25 +00001826 semsg(_(e_cannot_declare_script_variable_in_function_str),
Bram Moolenaar752fc692021-01-04 21:57:11 +01001827 lhs->lhs_name);
1828 else
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001829 semsg(_(e_variable_already_declared_in_script_str),
Bram Moolenaar752fc692021-01-04 21:57:11 +01001830 lhs->lhs_name);
1831 return FAIL;
1832 }
1833 else if (cctx->ctx_ufunc->uf_script_ctx_version
1834 == SCRIPT_VERSION_VIM9
1835 && script_namespace
1836 && !script_var && import == NULL)
1837 {
1838 semsg(_(e_unknown_variable_str), lhs->lhs_name);
1839 return FAIL;
1840 }
1841
Ernie Rael3f821d62024-04-24 20:07:50 +02001842 lhs->lhs_dest = current_script_is_vim9()
1843 ? dest_script_v9 : dest_script;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001844
1845 // existing script-local variables should have a type
1846 lhs->lhs_scriptvar_sid = current_sctx.sc_sid;
1847 if (import != NULL)
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001848 {
1849 char_u *dot = vim_strchr(var_start, '.');
1850 char_u *p;
1851
1852 // for an import the name is what comes after the dot
1853 if (dot == NULL)
1854 {
1855 semsg(_(e_no_dot_after_imported_name_str),
1856 var_start);
1857 return FAIL;
1858 }
1859 p = skipwhite(dot + 1);
1860 var_end = to_name_end(p, TRUE);
1861 if (var_end == p)
1862 {
1863 semsg(_(e_missing_name_after_imported_name_str),
1864 var_start);
1865 return FAIL;
1866 }
1867 vim_free(lhs->lhs_name);
1868 lhs->lhs_varlen = var_end - p;
1869 lhs->lhs_name = vim_strnsave(p, lhs->lhs_varlen);
1870 if (lhs->lhs_name == NULL)
1871 return FAIL;
1872 rawname = lhs->lhs_name;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001873 lhs->lhs_scriptvar_sid = import->imp_sid;
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001874 // TODO: where do we check this name is exported?
1875
1876 // Check if something follows: "exp.var[idx]" or
1877 // "exp.var.key".
1878 lhs->lhs_has_index = lhs->lhs_dest_end
1879 > skipwhite(var_end);
1880 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01001881 if (SCRIPT_ID_VALID(lhs->lhs_scriptvar_sid))
1882 {
Bram Moolenaar08251752021-01-11 21:20:18 +01001883 // Check writable only when no index follows.
Bram Moolenaar752fc692021-01-04 21:57:11 +01001884 lhs->lhs_scriptvar_idx = get_script_item_idx(
Bram Moolenaar08251752021-01-11 21:20:18 +01001885 lhs->lhs_scriptvar_sid, rawname,
1886 lhs->lhs_has_index ? ASSIGN_FINAL : ASSIGN_CONST,
Bram Moolenaarb6a138e2022-02-08 21:17:22 +00001887 cctx, NULL);
Bram Moolenaar752fc692021-01-04 21:57:11 +01001888 if (lhs->lhs_scriptvar_idx >= 0)
1889 {
1890 scriptitem_T *si = SCRIPT_ITEM(
1891 lhs->lhs_scriptvar_sid);
1892 svar_T *sv =
1893 ((svar_T *)si->sn_var_vals.ga_data)
1894 + lhs->lhs_scriptvar_idx;
1895 lhs->lhs_type = sv->sv_type;
1896 }
1897 }
1898 }
Bram Moolenaardce24412022-02-08 20:35:30 +00001899 else if (check_defined(var_start, lhs->lhs_varlen, cctx,
1900 NULL, FALSE) == FAIL)
Bram Moolenaar752fc692021-01-04 21:57:11 +01001901 return FAIL;
1902 }
1903 }
1904
1905 if (declare_error)
1906 {
1907 vim9_declare_error(lhs->lhs_name);
1908 return FAIL;
1909 }
1910 }
1911
Bram Moolenaarab36e6a2021-11-30 16:14:49 +00001912 // handle "a:name" as a name, not index "name" in "a"
Bram Moolenaar752fc692021-01-04 21:57:11 +01001913 if (lhs->lhs_varlen > 1 || var_start[lhs->lhs_varlen] != ':')
1914 var_end = lhs->lhs_dest_end;
1915
Bram Moolenaardcb53be2021-12-09 14:23:43 +00001916 if (lhs->lhs_dest != dest_option && lhs->lhs_dest != dest_func_option)
Bram Moolenaar752fc692021-01-04 21:57:11 +01001917 {
Bram Moolenaarce93d162023-01-30 21:12:34 +00001918 if (is_decl && *skipwhite(var_end) == ':')
Bram Moolenaar752fc692021-01-04 21:57:11 +01001919 {
1920 char_u *p;
1921
1922 // parse optional type: "let var: type = expr"
Bram Moolenaarce93d162023-01-30 21:12:34 +00001923 if (VIM_ISWHITE(*var_end))
1924 {
1925 semsg(_(e_no_white_space_allowed_before_colon_str), var_end);
1926 return FAIL;
1927 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01001928 if (!VIM_ISWHITE(var_end[1]))
1929 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +01001930 semsg(_(e_white_space_required_after_str_str), ":", var_end);
Bram Moolenaar752fc692021-01-04 21:57:11 +01001931 return FAIL;
1932 }
1933 p = skipwhite(var_end + 1);
1934 lhs->lhs_type = parse_type(&p, cctx->ctx_type_list, TRUE);
1935 if (lhs->lhs_type == NULL)
1936 return FAIL;
1937 lhs->lhs_has_type = TRUE;
Bram Moolenaarab36e6a2021-11-30 16:14:49 +00001938 lhs->lhs_end = p;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001939 }
1940 else if (lhs->lhs_lvar != NULL)
1941 lhs->lhs_type = lhs->lhs_lvar->lv_type;
1942 }
1943
Bram Moolenaare42939a2021-04-05 17:11:17 +02001944 if (oplen == 3 && !heredoc
1945 && lhs->lhs_dest != dest_global
1946 && !lhs->lhs_has_index
1947 && lhs->lhs_type->tt_type != VAR_STRING
1948 && lhs->lhs_type->tt_type != VAR_ANY)
Bram Moolenaar752fc692021-01-04 21:57:11 +01001949 {
1950 emsg(_(e_can_only_concatenate_to_string));
1951 return FAIL;
1952 }
1953
1954 if (lhs->lhs_lvar == NULL && lhs->lhs_dest == dest_local
1955 && cctx->ctx_skip != SKIP_YES)
1956 {
1957 if (oplen > 1 && !heredoc)
1958 {
1959 // +=, /=, etc. require an existing variable
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00001960 semsg(_(e_cannot_use_operator_on_new_variable_str), lhs->lhs_name);
Bram Moolenaar752fc692021-01-04 21:57:11 +01001961 return FAIL;
1962 }
Bram Moolenaar97f8c102022-04-02 19:43:57 +01001963 if (!is_decl || (lhs->lhs_has_index && !has_cmd
1964 && cctx->ctx_skip != SKIP_YES))
Bram Moolenaar752fc692021-01-04 21:57:11 +01001965 {
1966 semsg(_(e_unknown_variable_str), lhs->lhs_name);
1967 return FAIL;
1968 }
1969
Bram Moolenaar3f327882021-03-17 20:56:38 +01001970 // Check the name is valid for a funcref.
Bram Moolenaar752fc692021-01-04 21:57:11 +01001971 if ((lhs->lhs_type->tt_type == VAR_FUNC
1972 || lhs->lhs_type->tt_type == VAR_PARTIAL)
Bram Moolenaar3f327882021-03-17 20:56:38 +01001973 && var_wrong_func_name(lhs->lhs_name, TRUE))
Bram Moolenaar752fc692021-01-04 21:57:11 +01001974 return FAIL;
Bram Moolenaar3f327882021-03-17 20:56:38 +01001975
1976 // New local variable.
Bram Moolenaar6586a012022-09-30 11:04:50 +01001977 int assign = cmdidx == CMD_final ? ASSIGN_FINAL
1978 : cmdidx == CMD_const ? ASSIGN_CONST : ASSIGN_VAR;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001979 lhs->lhs_lvar = reserve_local(cctx, var_start, lhs->lhs_varlen,
Bram Moolenaar6586a012022-09-30 11:04:50 +01001980 assign, lhs->lhs_type);
Bram Moolenaar752fc692021-01-04 21:57:11 +01001981 if (lhs->lhs_lvar == NULL)
1982 return FAIL;
1983 lhs->lhs_new_local = TRUE;
1984 }
1985
1986 lhs->lhs_member_type = lhs->lhs_type;
Bram Moolenaar08251752021-01-11 21:20:18 +01001987 if (lhs->lhs_has_index)
Bram Moolenaar752fc692021-01-04 21:57:11 +01001988 {
Bram Moolenaarc750d912021-11-29 22:02:12 +00001989 char_u *after = var_start + lhs->lhs_varlen;
1990 char_u *p;
1991
Bram Moolenaar752fc692021-01-04 21:57:11 +01001992 // Something follows after the variable: "var[idx]" or "var.key".
Bram Moolenaar97f8c102022-04-02 19:43:57 +01001993 if (is_decl && cctx->ctx_skip != SKIP_YES)
Bram Moolenaar752fc692021-01-04 21:57:11 +01001994 {
Bram Moolenaar97f8c102022-04-02 19:43:57 +01001995 if (has_cmd)
1996 emsg(_(e_cannot_use_index_when_declaring_variable));
1997 else
1998 semsg(_(e_unknown_variable_str), lhs->lhs_name);
Bram Moolenaar752fc692021-01-04 21:57:11 +01001999 return FAIL;
2000 }
2001
Bram Moolenaarc750d912021-11-29 22:02:12 +00002002 // Now: var_start[lhs->lhs_varlen] is '[' or '.'
2003 // Only the last index is used below, if there are others
2004 // before it generate code for the expression. Thus for
2005 // "ll[1][2]" the expression is "ll[1]" and "[2]" is the index.
2006 for (;;)
Bram Moolenaar752fc692021-01-04 21:57:11 +01002007 {
Bram Moolenaarc750d912021-11-29 22:02:12 +00002008 p = skip_index(after);
2009 if (*p != '[' && *p != '.')
Bram Moolenaar752fc692021-01-04 21:57:11 +01002010 {
Bram Moolenaarc750d912021-11-29 22:02:12 +00002011 lhs->lhs_varlen_total = p - var_start;
2012 break;
Bram Moolenaar752fc692021-01-04 21:57:11 +01002013 }
Bram Moolenaarc750d912021-11-29 22:02:12 +00002014 after = p;
Bram Moolenaar752fc692021-01-04 21:57:11 +01002015 }
Bram Moolenaarc750d912021-11-29 22:02:12 +00002016 if (after > var_start + lhs->lhs_varlen)
2017 {
2018 lhs->lhs_varlen = after - var_start;
2019 lhs->lhs_dest = dest_expr;
2020 // We don't know the type before evaluating the expression,
2021 // use "any" until then.
2022 lhs->lhs_type = &t_any;
2023 }
2024
Bram Moolenaar666cb9c2023-02-22 12:35:17 +00002025 int use_class = lhs->lhs_type != NULL
2026 && (lhs->lhs_type->tt_type == VAR_CLASS
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02002027 || lhs->lhs_type->tt_type == VAR_OBJECT);
Bram Moolenaarb1e32ac2023-02-21 12:38:51 +00002028 if (lhs->lhs_type == NULL
2029 || (use_class ? lhs->lhs_type->tt_class == NULL
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02002030 : lhs->lhs_type->tt_member == NULL))
Bram Moolenaarb1e32ac2023-02-21 12:38:51 +00002031 {
Bram Moolenaarc750d912021-11-29 22:02:12 +00002032 lhs->lhs_member_type = &t_any;
Bram Moolenaarb1e32ac2023-02-21 12:38:51 +00002033 }
2034 else if (use_class)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002035 {
2036 // for an object or class member get the type of the member
Yegappan Lakshmananeb91e242023-08-31 18:10:46 +02002037 class_T *cl = lhs->lhs_type->tt_class;
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02002038 int is_object = lhs->lhs_type->tt_type == VAR_OBJECT;
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002039 char_u *name = var_start + lhs->lhs_varlen + 1;
2040 size_t namelen = lhs->lhs_end - var_start - lhs->lhs_varlen - 1;
Yegappan Lakshmananeb91e242023-08-31 18:10:46 +02002041
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002042 ocmember_T *m = member_lookup(cl, lhs->lhs_type->tt_type,
2043 name, namelen, &lhs->lhs_member_idx);
2044 if (m == NULL)
2045 {
2046 member_not_found_msg(cl, lhs->lhs_type->tt_type, name, namelen);
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02002047 return FAIL;
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002048 }
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02002049
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002050 if (IS_ENUM(cl))
2051 {
2052 if (!inside_class(cctx, cl))
2053 {
2054 semsg(_(e_enumvalue_str_cannot_be_modified),
2055 cl->class_name, m->ocm_name);
2056 return FALSE;
2057 }
2058 if (lhs->lhs_type->tt_type == VAR_OBJECT &&
2059 lhs->lhs_member_idx < 2)
2060 {
2061 char *msg = lhs->lhs_member_idx == 0 ?
2062 e_enum_str_name_cannot_be_modified :
2063 e_enum_str_ordinal_cannot_be_modified;
2064 semsg(_(msg), cl->class_name);
2065 return FALSE;
2066 }
2067 }
2068
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002069 // If it is private member variable, then accessing it outside the
2070 // class is not allowed.
2071 // If it is a read only class variable, then it can be modified
2072 // only inside the class where it is defined.
2073 if ((m->ocm_access != VIM_ACCESS_ALL) &&
2074 ((is_object && !inside_class(cctx, cl))
2075 || (!is_object && cctx->ctx_ufunc->uf_class != cl)))
2076 {
2077 char *msg = (m->ocm_access == VIM_ACCESS_PRIVATE)
Ernie Rael03042a22023-11-11 08:53:32 +01002078 ? e_cannot_access_protected_variable_str
2079 : e_variable_is_not_writable_str;
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002080 emsg_var_cl_define(msg, m->ocm_name, 0, cl);
Yegappan Lakshmananeb91e242023-08-31 18:10:46 +02002081 return FAIL;
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002082 }
2083
Yegappan Lakshmanane5437c52023-12-16 14:11:19 +01002084 if (!IS_CONSTRUCTOR_METHOD(cctx->ctx_ufunc)
2085 && oc_var_check_ro(cl, m))
2086 return FAIL;
2087
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002088 lhs->lhs_member_type = m->ocm_type;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002089 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01002090 else
Bram Moolenaarc750d912021-11-29 22:02:12 +00002091 lhs->lhs_member_type = lhs->lhs_type->tt_member;
Bram Moolenaar752fc692021-01-04 21:57:11 +01002092 }
2093 return OK;
2094}
2095
2096/*
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002097 * Figure out the LHS and check a few errors.
2098 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +00002099 int
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002100compile_assign_lhs(
Bram Moolenaar97f8c102022-04-02 19:43:57 +01002101 char_u *var_start,
2102 lhs_T *lhs,
2103 cmdidx_T cmdidx,
2104 int is_decl,
2105 int heredoc,
2106 int has_cmd, // "var" before "var_start"
2107 int oplen,
2108 cctx_T *cctx)
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002109{
Bram Moolenaar97f8c102022-04-02 19:43:57 +01002110 if (compile_lhs(var_start, lhs, cmdidx, heredoc, has_cmd, oplen, cctx)
2111 == FAIL)
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002112 return FAIL;
2113
2114 if (!lhs->lhs_has_index && lhs->lhs_lvar == &lhs->lhs_arg_lvar)
2115 {
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00002116 semsg(_(e_cannot_assign_to_argument_str), lhs->lhs_name);
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002117 return FAIL;
2118 }
2119 if (!is_decl && lhs->lhs_lvar != NULL
Bram Moolenaar6586a012022-09-30 11:04:50 +01002120 && lhs->lhs_lvar->lv_const != ASSIGN_VAR
2121 && !lhs->lhs_has_index)
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002122 {
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00002123 semsg(_(e_cannot_assign_to_constant_str), lhs->lhs_name);
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002124 return FAIL;
2125 }
2126 return OK;
2127}
2128
2129/*
Bram Moolenaar4f0884d2021-08-11 21:49:23 +02002130 * Return TRUE if "lhs" has a range index: "[expr : expr]".
2131 */
2132 static int
2133has_list_index(char_u *idx_start, cctx_T *cctx)
2134{
2135 char_u *p = idx_start;
2136 int save_skip;
2137
2138 if (*p != '[')
2139 return FALSE;
2140
2141 p = skipwhite(p + 1);
2142 if (*p == ':')
2143 return TRUE;
2144
2145 save_skip = cctx->ctx_skip;
2146 cctx->ctx_skip = SKIP_YES;
2147 (void)compile_expr0(&p, cctx);
2148 cctx->ctx_skip = save_skip;
2149 return *skipwhite(p) == ':';
2150}
2151
2152/*
Bram Moolenaare42939a2021-04-05 17:11:17 +02002153 * For an assignment with an index, compile the "idx" in "var[idx]" or "key" in
2154 * "var.key".
Bram Moolenaar752fc692021-01-04 21:57:11 +01002155 */
2156 static int
Bram Moolenaare42939a2021-04-05 17:11:17 +02002157compile_assign_index(
Bram Moolenaar752fc692021-01-04 21:57:11 +01002158 char_u *var_start,
2159 lhs_T *lhs,
Bram Moolenaare42939a2021-04-05 17:11:17 +02002160 int *range,
Bram Moolenaar752fc692021-01-04 21:57:11 +01002161 cctx_T *cctx)
2162{
Bram Moolenaar752fc692021-01-04 21:57:11 +01002163 size_t varlen = lhs->lhs_varlen;
Bram Moolenaare42939a2021-04-05 17:11:17 +02002164 char_u *p;
2165 int r = OK;
Bram Moolenaar68452172021-04-12 21:21:02 +02002166 int need_white_before = TRUE;
2167 int empty_second;
Bram Moolenaar752fc692021-01-04 21:57:11 +01002168
Bram Moolenaar752fc692021-01-04 21:57:11 +01002169 p = var_start + varlen;
2170 if (*p == '[')
2171 {
2172 p = skipwhite(p + 1);
Bram Moolenaar68452172021-04-12 21:21:02 +02002173 if (*p == ':')
2174 {
2175 // empty first index, push zero
2176 r = generate_PUSHNR(cctx, 0);
2177 need_white_before = FALSE;
2178 }
2179 else
2180 r = compile_expr0(&p, cctx);
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002181
2182 if (r == OK && *skipwhite(p) == ':')
2183 {
2184 // unlet var[idx : idx]
Bram Moolenaar68452172021-04-12 21:21:02 +02002185 // blob[idx : idx] = value
Bram Moolenaare42939a2021-04-05 17:11:17 +02002186 *range = TRUE;
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002187 p = skipwhite(p);
Bram Moolenaar68452172021-04-12 21:21:02 +02002188 empty_second = *skipwhite(p + 1) == ']';
2189 if ((need_white_before && !IS_WHITE_OR_NUL(p[-1]))
2190 || (!empty_second && !IS_WHITE_OR_NUL(p[1])))
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002191 {
2192 semsg(_(e_white_space_required_before_and_after_str_at_str),
2193 ":", p);
2194 return FAIL;
2195 }
2196 p = skipwhite(p + 1);
Bram Moolenaar68452172021-04-12 21:21:02 +02002197 if (*p == ']')
2198 // empty second index, push "none"
2199 r = generate_PUSHSPEC(cctx, VVAL_NONE);
2200 else
2201 r = compile_expr0(&p, cctx);
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002202 }
2203
Bram Moolenaar752fc692021-01-04 21:57:11 +01002204 if (r == OK && *skipwhite(p) != ']')
2205 {
2206 // this should not happen
Bram Moolenaare1242042021-12-16 20:56:57 +00002207 emsg(_(e_missing_closing_square_brace));
Bram Moolenaar752fc692021-01-04 21:57:11 +01002208 r = FAIL;
2209 }
2210 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002211 else if (lhs->lhs_member_idx >= 0)
2212 {
2213 // object member index
2214 r = generate_PUSHNR(cctx, lhs->lhs_member_idx);
2215 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01002216 else // if (*p == '.')
2217 {
2218 char_u *key_end = to_name_end(p + 1, TRUE);
2219 char_u *key = vim_strnsave(p + 1, key_end - p - 1);
2220
Zdenek Dohnal9fe17d42021-08-04 22:30:52 +02002221 r = generate_PUSHS(cctx, &key);
Bram Moolenaar752fc692021-01-04 21:57:11 +01002222 }
Bram Moolenaare42939a2021-04-05 17:11:17 +02002223 return r;
2224}
2225
2226/*
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002227 * For a LHS with an index, load the variable to be indexed.
2228 */
2229 static int
2230compile_load_lhs(
2231 lhs_T *lhs,
2232 char_u *var_start,
2233 type_T *rhs_type,
2234 cctx_T *cctx)
2235{
2236 if (lhs->lhs_dest == dest_expr)
2237 {
2238 size_t varlen = lhs->lhs_varlen;
2239 int c = var_start[varlen];
Bram Moolenaare97976b2021-08-01 13:17:17 +02002240 int lines_len = cctx->ctx_ufunc->uf_lines.ga_len;
Bram Moolenaare97976b2021-08-01 13:17:17 +02002241 int res;
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002242
Bram Moolenaare97976b2021-08-01 13:17:17 +02002243 // Evaluate "ll[expr]" of "ll[expr][idx]". End the line with a NUL and
2244 // limit the lines array length to avoid skipping to a following line.
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002245 var_start[varlen] = NUL;
Bram Moolenaare97976b2021-08-01 13:17:17 +02002246 cctx->ctx_ufunc->uf_lines.ga_len = cctx->ctx_lnum + 1;
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002247 char_u *p = var_start;
Bram Moolenaare97976b2021-08-01 13:17:17 +02002248 res = compile_expr0(&p, cctx);
2249 var_start[varlen] = c;
2250 cctx->ctx_ufunc->uf_lines.ga_len = lines_len;
2251 if (res == FAIL || p != var_start + varlen)
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002252 {
2253 // this should not happen
Bram Moolenaare97976b2021-08-01 13:17:17 +02002254 if (res != FAIL)
Bram Moolenaare1242042021-12-16 20:56:57 +00002255 emsg(_(e_missing_closing_square_brace));
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002256 return FAIL;
2257 }
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002258
Bram Moolenaar078a4612022-01-04 15:17:03 +00002259 lhs->lhs_type = cctx->ctx_type_stack.ga_len == 0 ? &t_void
2260 : get_type_on_stack(cctx, 0);
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02002261
2262 if (lhs->lhs_type->tt_type == VAR_OBJECT)
2263 {
2264 // Check whether the object variable is modifiable
2265 if (!lhs_class_member_modifiable(lhs, var_start, cctx))
2266 return FAIL;
2267 }
2268
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002269 // Now we can properly check the type. The variable is indexed, thus
2270 // we need the member type. For a class or object we don't know the
2271 // type yet, it depends on what member is used.
Yegappan Lakshmananc229a6a2023-10-26 23:05:07 +02002272 // The top item in the stack is the Dict, followed by the key and then
2273 // the type of the value.
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002274 vartype_T vartype = lhs->lhs_type->tt_type;
2275 type_T *member_type = lhs->lhs_type->tt_member;
2276 if (rhs_type != NULL && member_type != NULL
2277 && vartype != VAR_OBJECT && vartype != VAR_CLASS
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002278 && rhs_type != &t_void
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002279 && need_type(rhs_type, member_type, FALSE,
Yegappan Lakshmananc229a6a2023-10-26 23:05:07 +02002280 -3, 0, cctx, FALSE, FALSE) == FAIL)
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002281 return FAIL;
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02002282
2283 return OK;
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002284 }
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02002285
2286 return generate_loadvar(cctx, lhs);
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002287}
2288
2289/*
Bram Moolenaara369c3d2021-04-21 16:00:10 +02002290 * Produce code for loading "lhs" and also take care of an index.
2291 * Return OK/FAIL.
2292 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +00002293 int
Bram Moolenaara369c3d2021-04-21 16:00:10 +02002294compile_load_lhs_with_index(lhs_T *lhs, char_u *var_start, cctx_T *cctx)
2295{
Bram Moolenaar4cae8452023-01-15 15:51:48 +00002296 if (lhs->lhs_type->tt_type == VAR_OBJECT)
2297 {
Bram Moolenaar22363c62023-04-24 17:15:25 +01002298 // "this.value": load "this" object and get the value at index for an
2299 // object or class member get the type of the member.
2300 // Also for "obj.value".
Yegappan Lakshmananff6f0d52023-12-21 16:46:18 +01002301 char_u *dot = vim_strchr(var_start, '.');
2302 if (dot == NULL)
2303 {
2304 semsg(_(e_missing_dot_after_object_str), lhs->lhs_name);
2305 return FAIL;
2306 }
Bram Moolenaar22363c62023-04-24 17:15:25 +01002307
Yegappan Lakshmananeb91e242023-08-31 18:10:46 +02002308 class_T *cl = lhs->lhs_type->tt_class;
Yegappan Lakshmanan1ea42882023-10-11 21:43:52 +02002309 type_T *type = oc_member_type(cl, TRUE, dot + 1,
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02002310 lhs->lhs_end, &lhs->lhs_member_idx);
Bram Moolenaar4cae8452023-01-15 15:51:48 +00002311 if (lhs->lhs_member_idx < 0)
2312 return FAIL;
2313
Bram Moolenaar22363c62023-04-24 17:15:25 +01002314 if (dot - var_start == 4 && STRNCMP(var_start, "this", 4) == 0)
2315 {
2316 // load "this"
Yegappan Lakshmanand990bf02024-03-22 19:56:17 +01002317 lvar_T *lvar = lhs->lhs_lvar;
2318 int rc;
2319
2320 if (lvar->lv_from_outer > 0)
2321 rc = generate_LOADOUTER(cctx, lvar->lv_idx,
2322 lvar->lv_from_outer, lvar->lv_loop_depth,
2323 lvar->lv_loop_idx, type);
2324 else
2325 rc = generate_LOAD(cctx, ISN_LOAD, lvar->lv_idx, NULL, type);
2326
2327 if (rc == FAIL)
Bram Moolenaar22363c62023-04-24 17:15:25 +01002328 return FAIL;
2329 }
2330 else
2331 {
2332 // load object variable or argument
2333 if (compile_load_lhs(lhs, var_start, lhs->lhs_type, cctx) == FAIL)
2334 return FAIL;
2335 }
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002336 if (IS_INTERFACE(cl))
Yegappan Lakshmanan5a05d372023-09-29 19:43:11 +02002337 return generate_GET_ITF_MEMBER(cctx, cl, lhs->lhs_member_idx, type);
2338 return generate_GET_OBJ_MEMBER(cctx, lhs->lhs_member_idx, type);
Bram Moolenaar4cae8452023-01-15 15:51:48 +00002339 }
Yegappan Lakshmanan1ea42882023-10-11 21:43:52 +02002340 else if (lhs->lhs_type->tt_type == VAR_CLASS)
2341 {
2342 // "<classname>.value": load class variable "classname.value"
Yegappan Lakshmananff6f0d52023-12-21 16:46:18 +01002343 char_u *dot = vim_strchr(var_start, '.');
2344 if (dot == NULL)
2345 {
2346 check_type_is_value(lhs->lhs_type);
2347 return FAIL;
2348 }
Yegappan Lakshmanan1ea42882023-10-11 21:43:52 +02002349
2350 class_T *cl = lhs->lhs_type->tt_class;
2351 ocmember_T *m = class_member_lookup(cl, dot + 1,
2352 lhs->lhs_end - dot - 1,
2353 &lhs->lhs_member_idx);
2354 if (m == NULL)
2355 return FAIL;
2356
2357 return generate_CLASSMEMBER(cctx, TRUE, cl, lhs->lhs_member_idx);
2358 }
Bram Moolenaar4cae8452023-01-15 15:51:48 +00002359
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02002360 if (compile_load_lhs(lhs, var_start, NULL, cctx) == FAIL)
2361 return FAIL;
Bram Moolenaara369c3d2021-04-21 16:00:10 +02002362
2363 if (lhs->lhs_has_index)
2364 {
2365 int range = FALSE;
2366
2367 // Get member from list or dict. First compile the
2368 // index value.
2369 if (compile_assign_index(var_start, lhs, &range, cctx) == FAIL)
2370 return FAIL;
2371 if (range)
2372 {
2373 semsg(_(e_cannot_use_range_with_assignment_operator_str),
2374 var_start);
2375 return FAIL;
2376 }
2377
2378 // Get the member.
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02002379 if (compile_member(FALSE, NULL, cctx) == FAIL)
Bram Moolenaara369c3d2021-04-21 16:00:10 +02002380 return FAIL;
2381 }
2382 return OK;
2383}
2384
2385/*
Bram Moolenaare42939a2021-04-05 17:11:17 +02002386 * Assignment to a list or dict member, or ":unlet" for the item, using the
2387 * information in "lhs".
2388 * Returns OK or FAIL.
2389 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +00002390 int
Bram Moolenaare42939a2021-04-05 17:11:17 +02002391compile_assign_unlet(
2392 char_u *var_start,
2393 lhs_T *lhs,
2394 int is_assign,
2395 type_T *rhs_type,
2396 cctx_T *cctx)
2397{
Bram Moolenaare42939a2021-04-05 17:11:17 +02002398 vartype_T dest_type;
Bram Moolenaare42939a2021-04-05 17:11:17 +02002399 int range = FALSE;
2400
Bram Moolenaar68452172021-04-12 21:21:02 +02002401 if (compile_assign_index(var_start, lhs, &range, cctx) == FAIL)
Bram Moolenaar752fc692021-01-04 21:57:11 +01002402 return FAIL;
Bram Moolenaar4f0884d2021-08-11 21:49:23 +02002403 if (is_assign && range
2404 && lhs->lhs_type->tt_type != VAR_LIST
2405 && lhs->lhs_type != &t_blob
2406 && lhs->lhs_type != &t_any)
Bram Moolenaar68452172021-04-12 21:21:02 +02002407 {
2408 semsg(_(e_cannot_use_range_with_assignment_str), var_start);
2409 return FAIL;
2410 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01002411
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002412 if (lhs->lhs_type == NULL || lhs->lhs_type == &t_any)
Bram Moolenaar752fc692021-01-04 21:57:11 +01002413 {
2414 // Index on variable of unknown type: check at runtime.
2415 dest_type = VAR_ANY;
2416 }
2417 else
2418 {
2419 dest_type = lhs->lhs_type->tt_type;
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002420 if (dest_type == VAR_DICT && range)
2421 {
zeertzjq276410e2023-05-07 21:59:33 +01002422 emsg(_(e_cannot_use_range_with_dictionary));
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002423 return FAIL;
2424 }
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02002425 if (dest_type == VAR_DICT
Yegappan Lakshmananbce51d92024-04-15 19:19:52 +02002426 && may_generate_2STRING(-1, TOSTRING_NONE, cctx) == FAIL)
Bram Moolenaar752fc692021-01-04 21:57:11 +01002427 return FAIL;
Bram Moolenaar51e93322021-04-17 20:44:56 +02002428 if (dest_type == VAR_LIST || dest_type == VAR_BLOB)
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002429 {
Bram Moolenaar51e93322021-04-17 20:44:56 +02002430 type_T *type;
2431
2432 if (range)
2433 {
Bram Moolenaar078a4612022-01-04 15:17:03 +00002434 type = get_type_on_stack(cctx, 1);
Bram Moolenaarc6951a72022-12-29 20:56:24 +00002435 if (need_type(type, &t_number, FALSE,
Bram Moolenaar2995e5c2022-03-18 21:41:47 +00002436 -2, 0, cctx, FALSE, FALSE) == FAIL)
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002437 return FAIL;
Bram Moolenaar51e93322021-04-17 20:44:56 +02002438 }
Bram Moolenaar078a4612022-01-04 15:17:03 +00002439 type = get_type_on_stack(cctx, 0);
Bram Moolenaar53ba6ca2022-03-10 19:23:28 +00002440 if ((dest_type != VAR_BLOB && type->tt_type != VAR_SPECIAL)
Bram Moolenaarc6951a72022-12-29 20:56:24 +00002441 && need_type(type, &t_number, FALSE,
Bram Moolenaar51e93322021-04-17 20:44:56 +02002442 -1, 0, cctx, FALSE, FALSE) == FAIL)
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002443 return FAIL;
2444 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01002445 }
2446
Bram Moolenaar4875d6a2022-08-17 15:55:51 +01002447 if (cctx->ctx_skip == SKIP_YES)
2448 return OK;
2449
Bram Moolenaar22363c62023-04-24 17:15:25 +01002450 // Load the dict, list or object. On the stack we then have:
Bram Moolenaar752fc692021-01-04 21:57:11 +01002451 // - value (for assignment, not for :unlet)
2452 // - index
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002453 // - for [a : b] second index
Bram Moolenaar752fc692021-01-04 21:57:11 +01002454 // - variable
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002455 if (compile_load_lhs(lhs, var_start, rhs_type, cctx) == FAIL)
2456 return FAIL;
Bram Moolenaar752fc692021-01-04 21:57:11 +01002457
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002458 if (dest_type == VAR_LIST
2459 || dest_type == VAR_DICT
2460 || dest_type == VAR_BLOB
2461 || dest_type == VAR_CLASS
2462 || dest_type == VAR_OBJECT
2463 || dest_type == VAR_ANY)
Bram Moolenaar752fc692021-01-04 21:57:11 +01002464 {
2465 if (is_assign)
2466 {
Bram Moolenaar68452172021-04-12 21:21:02 +02002467 if (range)
2468 {
2469 if (generate_instr_drop(cctx, ISN_STORERANGE, 4) == NULL)
2470 return FAIL;
2471 }
2472 else
2473 {
2474 isn_T *isn = generate_instr_drop(cctx, ISN_STOREINDEX, 3);
Bram Moolenaar752fc692021-01-04 21:57:11 +01002475
Bram Moolenaar68452172021-04-12 21:21:02 +02002476 if (isn == NULL)
2477 return FAIL;
Bram Moolenaarf7d1c6e2023-01-16 20:47:57 +00002478 isn->isn_arg.storeindex.si_vartype = dest_type;
2479 isn->isn_arg.storeindex.si_class = NULL;
2480
2481 if (dest_type == VAR_OBJECT)
2482 {
Bram Moolenaarb1e32ac2023-02-21 12:38:51 +00002483 class_T *cl = lhs->lhs_type->tt_class;
Bram Moolenaarf7d1c6e2023-01-16 20:47:57 +00002484
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01002485 if (IS_INTERFACE(cl))
Bram Moolenaarf7d1c6e2023-01-16 20:47:57 +00002486 {
2487 // "this.value": load "this" object and get the value
2488 // at index for an object or class member get the type
2489 // of the member
2490 isn->isn_arg.storeindex.si_class = cl;
2491 ++cl->class_refcount;
2492 }
2493 }
Bram Moolenaar68452172021-04-12 21:21:02 +02002494 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01002495 }
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002496 else if (range)
2497 {
2498 if (generate_instr_drop(cctx, ISN_UNLETRANGE, 3) == NULL)
2499 return FAIL;
2500 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01002501 else
2502 {
2503 if (generate_instr_drop(cctx, ISN_UNLETINDEX, 2) == NULL)
2504 return FAIL;
2505 }
2506 }
2507 else
2508 {
2509 emsg(_(e_indexable_type_required));
2510 return FAIL;
2511 }
2512
2513 return OK;
2514}
2515
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01002516/*
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00002517 * Generate an instruction to push the default value for "vartype".
2518 * if "dest_local" is TRUE then for some types no instruction is generated.
2519 * "skip_store" is set to TRUE if no PUSH instruction is generated.
2520 * Returns OK or FAIL.
2521 */
2522 static int
2523push_default_value(
2524 cctx_T *cctx,
2525 vartype_T vartype,
2526 int dest_is_local,
2527 int *skip_store)
2528{
2529 int r = OK;
2530
2531 switch (vartype)
2532 {
2533 case VAR_BOOL:
2534 r = generate_PUSHBOOL(cctx, VVAL_FALSE);
2535 break;
2536 case VAR_FLOAT:
2537 r = generate_PUSHF(cctx, 0.0);
2538 break;
2539 case VAR_STRING:
2540 r = generate_PUSHS(cctx, NULL);
2541 break;
2542 case VAR_BLOB:
2543 r = generate_PUSHBLOB(cctx, blob_alloc());
2544 break;
2545 case VAR_FUNC:
2546 r = generate_PUSHFUNC(cctx, NULL, &t_func_void, TRUE);
2547 break;
2548 case VAR_LIST:
2549 r = generate_NEWLIST(cctx, 0, FALSE);
2550 break;
2551 case VAR_DICT:
2552 r = generate_NEWDICT(cctx, 0, FALSE);
2553 break;
2554 case VAR_JOB:
2555 r = generate_PUSHJOB(cctx);
2556 break;
2557 case VAR_CHANNEL:
2558 r = generate_PUSHCHANNEL(cctx);
2559 break;
Ernie Rael5c018be2023-08-27 18:40:26 +02002560 case VAR_OBJECT:
2561 r = generate_PUSHOBJ(cctx);
2562 break;
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00002563 case VAR_NUMBER:
2564 case VAR_UNKNOWN:
2565 case VAR_ANY:
2566 case VAR_PARTIAL:
2567 case VAR_VOID:
2568 case VAR_INSTR:
2569 case VAR_CLASS:
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02002570 case VAR_TYPEALIAS:
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00002571 case VAR_SPECIAL: // cannot happen
2572 // This is skipped for local variables, they are always
2573 // initialized to zero. But in a "for" or "while" loop
2574 // the value may have been changed.
2575 if (dest_is_local && !inside_loop_scope(cctx))
2576 *skip_store = TRUE;
2577 else
2578 r = generate_PUSHNR(cctx, 0);
2579 break;
2580 }
2581 return r;
2582}
2583
2584/*
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002585 * Compile declaration and assignment:
Bram Moolenaar30fd8202020-09-26 15:09:30 +02002586 * "let name"
2587 * "var name = expr"
2588 * "final name = expr"
2589 * "const name = expr"
2590 * "name = expr"
2591 * "arg" points to "name".
Bram Moolenaarbdc0f1c2021-04-24 19:08:24 +02002592 * "++arg" and "--arg"
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002593 * Return NULL for an error.
2594 * Return "arg" if it does not look like a variable list.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002595 */
2596 static char_u *
Bram Moolenaar65b0d162022-12-13 18:43:22 +00002597compile_assignment(
2598 char_u *arg_start,
2599 exarg_T *eap,
2600 cmdidx_T cmdidx,
2601 cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002602{
Bram Moolenaar65b0d162022-12-13 18:43:22 +00002603 char_u *arg = arg_start;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002604 char_u *var_start;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002605 char_u *p;
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02002606 char_u *end = arg;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002607 char_u *ret = NULL;
2608 int var_count = 0;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002609 int var_idx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002610 int semicolon = 0;
Bram Moolenaar4d5dfe22021-06-26 13:59:29 +02002611 int did_generate_slice = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002612 garray_T *instr = &cctx->ctx_instr;
Bram Moolenaar65b0d162022-12-13 18:43:22 +00002613 int jump_instr_idx = instr->ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002614 char_u *op;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002615 int oplen = 0;
2616 int heredoc = FALSE;
Bram Moolenaarbdc0f1c2021-04-24 19:08:24 +02002617 int incdec = FALSE;
Bram Moolenaardc234ca2020-11-28 18:52:33 +01002618 type_T *rhs_type = &t_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002619 char_u *sp;
Bram Moolenaar752fc692021-01-04 21:57:11 +01002620 int is_decl = is_decl_command(cmdidx);
2621 lhs_T lhs;
Bram Moolenaarf593fc82022-12-14 13:50:02 +00002622 CLEAR_FIELD(lhs);
Bram Moolenaar77709b12021-04-03 21:01:01 +02002623 long start_lnum = SOURCING_LNUM;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002624
Bram Moolenaar6acf7572023-01-01 19:53:30 +00002625 int has_arg_is_set_prefix = STRNCMP(arg, "ifargisset ", 11) == 0;
Bram Moolenaar65b0d162022-12-13 18:43:22 +00002626 if (has_arg_is_set_prefix)
2627 {
2628 arg += 11;
2629 int def_idx = getdigits(&arg);
2630 arg = skipwhite(arg);
2631
2632 // Use a JUMP_IF_ARG_NOT_SET instruction to skip if the value was not
2633 // given and the default value is "v:none".
2634 int off = STACK_FRAME_SIZE + (cctx->ctx_ufunc->uf_va_name != NULL
2635 ? 1 : 0);
2636 int count = cctx->ctx_ufunc->uf_def_args.ga_len;
2637 if (generate_JUMP_IF_ARG(cctx, ISN_JUMP_IF_ARG_NOT_SET,
2638 def_idx - count - off) == FAIL)
2639 goto theend;
2640 }
2641
Bram Moolenaare1d12112022-03-05 11:37:48 +00002642 // Skip over the "varname" or "[varname, varname]" to get to any "=".
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002643 p = skip_var_list(arg, TRUE, &var_count, &semicolon, TRUE);
2644 if (p == NULL)
2645 return *arg == '[' ? arg : NULL;
2646
Bram Moolenaarbdc0f1c2021-04-24 19:08:24 +02002647 if (eap->cmdidx == CMD_increment || eap->cmdidx == CMD_decrement)
2648 {
Bram Moolenaar22480d12021-06-25 21:31:09 +02002649 if (VIM_ISWHITE(eap->cmd[2]))
2650 {
2651 semsg(_(e_no_white_space_allowed_after_str_str),
2652 eap->cmdidx == CMD_increment ? "++" : "--", eap->cmd);
2653 return NULL;
2654 }
Bram Moolenaarbdc0f1c2021-04-24 19:08:24 +02002655 op = (char_u *)(eap->cmdidx == CMD_increment ? "+=" : "-=");
2656 oplen = 2;
2657 incdec = TRUE;
2658 }
Bram Moolenaar70d87692022-05-07 10:03:27 +01002659 else
2660 {
2661 sp = p;
2662 p = skipwhite(p);
2663 op = p;
2664 oplen = assignment_len(p, &heredoc);
2665
2666 if (var_count > 0 && oplen == 0)
2667 // can be something like "[1, 2]->func()"
2668 return arg;
2669
2670 if (oplen > 0 && (!VIM_ISWHITE(*sp) || !IS_WHITE_OR_NUL(op[oplen])))
2671 {
2672 error_white_both(op, oplen);
2673 return NULL;
2674 }
2675 }
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02002676
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002677 if (heredoc)
2678 {
2679 list_T *l;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002680
2681 // [let] varname =<< [trim] {end}
Zoltan Arpadffy6fdb6282023-12-19 20:53:07 +01002682 eap->ea_getline = exarg_getline;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002683 eap->cookie = cctx;
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01002684 l = heredoc_get(eap, op + 3, FALSE, TRUE);
Bram Moolenaarc0e29012020-09-27 14:22:48 +02002685 if (l == NULL)
2686 return NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002687
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002688 list_free(l);
2689 p += STRLEN(p);
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002690 end = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002691 }
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002692 else if (var_count > 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002693 {
Bram Moolenaar004d9b02020-11-30 21:40:03 +01002694 char_u *wp;
2695
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002696 // for "[var, var] = expr" evaluate the expression here, loop over the
2697 // list of variables below.
Bram Moolenaar004d9b02020-11-30 21:40:03 +01002698 // A line break may follow the "=".
Bram Moolenaard25ec2c2020-03-30 21:05:45 +02002699
Bram Moolenaar004d9b02020-11-30 21:40:03 +01002700 wp = op + oplen;
Bram Moolenaar8ff16e02020-12-07 21:49:52 +01002701 if (may_get_next_line_error(wp, &p, cctx) == FAIL)
Bram Moolenaar004d9b02020-11-30 21:40:03 +01002702 return FAIL;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002703 if (compile_expr0(&p, cctx) == FAIL)
2704 return NULL;
2705 end = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002706
Bram Moolenaar9b68c822020-06-18 19:31:08 +02002707 if (cctx->ctx_skip != SKIP_YES)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002708 {
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02002709 type_T *stacktype;
Bram Moolenaardb9ff9a2021-12-01 17:38:01 +00002710 int needed_list_len;
2711 int did_check = FALSE;
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02002712
Bram Moolenaar078a4612022-01-04 15:17:03 +00002713 stacktype = cctx->ctx_type_stack.ga_len == 0 ? &t_void
2714 : get_type_on_stack(cctx, 0);
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002715 if (stacktype->tt_type == VAR_VOID)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002716 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02002717 emsg(_(e_cannot_use_void_value));
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002718 goto theend;
2719 }
Bram Moolenaarc6951a72022-12-29 20:56:24 +00002720 if (need_type(stacktype, &t_list_any, FALSE, -1, 0, cctx,
Bram Moolenaar334a8b42020-10-19 16:07:42 +02002721 FALSE, FALSE) == FAIL)
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002722 goto theend;
Bram Moolenaardb9ff9a2021-12-01 17:38:01 +00002723 // If a constant list was used we can check the length right here.
2724 needed_list_len = semicolon ? var_count - 1 : var_count;
2725 if (instr->ga_len > 0)
2726 {
2727 isn_T *isn = ((isn_T *)instr->ga_data) + instr->ga_len - 1;
2728
2729 if (isn->isn_type == ISN_NEWLIST)
2730 {
2731 did_check = TRUE;
2732 if (semicolon ? isn->isn_arg.number < needed_list_len
2733 : isn->isn_arg.number != needed_list_len)
2734 {
2735 semsg(_(e_expected_nr_items_but_got_nr),
Bram Moolenaarf60a6342022-01-15 14:16:37 +00002736 needed_list_len, (int)isn->isn_arg.number);
Bram Moolenaardb9ff9a2021-12-01 17:38:01 +00002737 goto theend;
2738 }
2739 }
2740 }
2741 if (!did_check)
2742 generate_CHECKLEN(cctx, needed_list_len, semicolon);
Bram Moolenaardc234ca2020-11-28 18:52:33 +01002743 if (stacktype->tt_member != NULL)
2744 rhs_type = stacktype->tt_member;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002745 }
2746 }
2747
2748 /*
2749 * Loop over variables in "[var, var] = expr".
2750 * For "var = expr" and "let var: type" this is done only once.
2751 */
2752 if (var_count > 0)
2753 var_start = skipwhite(arg + 1); // skip over the "["
2754 else
2755 var_start = arg;
2756 for (var_idx = 0; var_idx == 0 || var_idx < var_count; var_idx++)
2757 {
Bram Moolenaar6977dba2021-07-04 22:48:12 +02002758 int instr_count = -1;
2759 int save_lnum;
Bram Moolenaar5cd64792021-12-25 18:23:24 +00002760 int skip_store = FALSE;
Bram Moolenaare88c6b72022-02-15 15:37:11 +00002761 type_T *inferred_type = NULL;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002762
Bram Moolenaarf93bbd02021-04-10 22:35:43 +02002763 if (var_start[0] == '_' && !eval_isnamec(var_start[1]))
2764 {
2765 // Ignore underscore in "[a, _, b] = list".
2766 if (var_count > 0)
2767 {
2768 var_start = skipwhite(var_start + 2);
2769 continue;
2770 }
2771 emsg(_(e_cannot_use_underscore_here));
2772 goto theend;
2773 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01002774 vim_free(lhs.lhs_name);
2775
2776 /*
2777 * Figure out the LHS type and other properties.
2778 */
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002779 if (compile_assign_lhs(var_start, &lhs, cmdidx,
Bram Moolenaar97f8c102022-04-02 19:43:57 +01002780 is_decl, heredoc, var_start > eap->cmd,
2781 oplen, cctx) == FAIL)
Bram Moolenaar752fc692021-01-04 21:57:11 +01002782 goto theend;
Bram Moolenaar81530e32021-07-28 21:25:49 +02002783 if (heredoc)
2784 {
2785 SOURCING_LNUM = start_lnum;
2786 if (lhs.lhs_has_type
Bram Moolenaarc6951a72022-12-29 20:56:24 +00002787 && need_type(&t_list_string, lhs.lhs_type, FALSE,
Bram Moolenaar81530e32021-07-28 21:25:49 +02002788 -1, 0, cctx, FALSE, FALSE) == FAIL)
2789 goto theend;
2790 }
2791 else
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002792 {
Bram Moolenaar9b68c822020-06-18 19:31:08 +02002793 if (cctx->ctx_skip == SKIP_YES)
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002794 {
Bram Moolenaar72abcf42020-06-18 18:26:24 +02002795 if (oplen > 0 && var_count == 0)
2796 {
2797 // skip over the "=" and the expression
2798 p = skipwhite(op + oplen);
Bram Moolenaar169502f2021-04-21 12:19:35 +02002799 (void)compile_expr0(&p, cctx);
Bram Moolenaar72abcf42020-06-18 18:26:24 +02002800 }
2801 }
2802 else if (oplen > 0)
2803 {
Bram Moolenaar334a8b42020-10-19 16:07:42 +02002804 int is_const = FALSE;
Bram Moolenaar7f764942020-12-02 15:11:18 +01002805 char_u *wp;
Bram Moolenaar72abcf42020-06-18 18:26:24 +02002806
Bram Moolenaar035bd1c2021-06-21 19:44:11 +02002807 // for "+=", "*=", "..=" etc. first load the current value
2808 if (*op != '='
2809 && compile_load_lhs_with_index(&lhs, var_start,
2810 cctx) == FAIL)
2811 goto theend;
2812
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002813 // For "var = expr" evaluate the expression.
2814 if (var_count == 0)
2815 {
2816 int r;
2817
Bram Moolenaarbdc0f1c2021-04-24 19:08:24 +02002818 // Compile the expression.
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002819 instr_count = instr->ga_len;
Bram Moolenaarbdc0f1c2021-04-24 19:08:24 +02002820 if (incdec)
Bram Moolenaar21e51222020-12-04 12:43:29 +01002821 {
Bram Moolenaarbdc0f1c2021-04-24 19:08:24 +02002822 r = generate_PUSHNR(cctx, 1);
2823 }
2824 else
2825 {
2826 // Temporarily hide the new local variable here, it is
2827 // not available to this expression.
2828 if (lhs.lhs_new_local)
2829 --cctx->ctx_locals.ga_len;
2830 wp = op + oplen;
2831 if (may_get_next_line_error(wp, &p, cctx) == FAIL)
2832 {
2833 if (lhs.lhs_new_local)
2834 ++cctx->ctx_locals.ga_len;
2835 goto theend;
2836 }
2837 r = compile_expr0_ext(&p, cctx, &is_const);
Bram Moolenaar752fc692021-01-04 21:57:11 +01002838 if (lhs.lhs_new_local)
Bram Moolenaar21e51222020-12-04 12:43:29 +01002839 ++cctx->ctx_locals.ga_len;
Bram Moolenaar21e51222020-12-04 12:43:29 +01002840 }
Yegappan Lakshmananc99e1822022-09-03 10:52:24 +01002841 if (r == FAIL)
2842 goto theend;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002843 }
Bram Moolenaar9af78762020-06-16 11:34:42 +02002844 else if (semicolon && var_idx == var_count - 1)
2845 {
2846 // For "[var; var] = expr" get the rest of the list
Bram Moolenaar4d5dfe22021-06-26 13:59:29 +02002847 did_generate_slice = TRUE;
Bram Moolenaar9af78762020-06-16 11:34:42 +02002848 if (generate_SLICE(cctx, var_count - 1) == FAIL)
2849 goto theend;
2850 }
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02002851 else
2852 {
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002853 // For "[var, var] = expr" get the "var_idx" item from the
2854 // list.
Bram Moolenaar035bd1c2021-06-21 19:44:11 +02002855 if (generate_GETITEM(cctx, var_idx, *op != '=') == FAIL)
Bram Moolenaar7f764942020-12-02 15:11:18 +01002856 goto theend;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002857 }
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02002858
Bram Moolenaar078a4612022-01-04 15:17:03 +00002859 rhs_type = cctx->ctx_type_stack.ga_len == 0 ? &t_void
2860 : get_type_on_stack(cctx, 0);
Ernie Rael9ed53752023-12-11 17:40:46 +01002861 if (check_type_is_value(rhs_type) == FAIL)
2862 goto theend;
Bram Moolenaar752fc692021-01-04 21:57:11 +01002863 if (lhs.lhs_lvar != NULL && (is_decl || !lhs.lhs_has_type))
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002864 {
Bram Moolenaardc234ca2020-11-28 18:52:33 +01002865 if ((rhs_type->tt_type == VAR_FUNC
2866 || rhs_type->tt_type == VAR_PARTIAL)
Bram Moolenaar3f327882021-03-17 20:56:38 +01002867 && !lhs.lhs_has_index
Bram Moolenaar752fc692021-01-04 21:57:11 +01002868 && var_wrong_func_name(lhs.lhs_name, TRUE))
Bram Moolenaar0f769812020-09-12 18:32:34 +02002869 goto theend;
2870
Bram Moolenaar752fc692021-01-04 21:57:11 +01002871 if (lhs.lhs_new_local && !lhs.lhs_has_type)
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02002872 {
Bram Moolenaardc234ca2020-11-28 18:52:33 +01002873 if (rhs_type->tt_type == VAR_VOID)
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002874 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02002875 emsg(_(e_cannot_use_void_value));
Bram Moolenaar72abcf42020-06-18 18:26:24 +02002876 goto theend;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002877 }
2878 else
2879 {
Bram Moolenaarfa103972022-09-29 19:14:42 +01002880 type_T *type;
2881
Bram Moolenaar04bdd572020-09-23 13:25:32 +02002882 // An empty list or dict has a &t_unknown member,
Bram Moolenaar72abcf42020-06-18 18:26:24 +02002883 // for a variable that implies &t_any.
Bram Moolenaardc234ca2020-11-28 18:52:33 +01002884 if (rhs_type == &t_list_empty)
Bram Moolenaarfa103972022-09-29 19:14:42 +01002885 type = &t_list_any;
Bram Moolenaardc234ca2020-11-28 18:52:33 +01002886 else if (rhs_type == &t_dict_empty)
Bram Moolenaarfa103972022-09-29 19:14:42 +01002887 type = &t_dict_any;
Bram Moolenaardc234ca2020-11-28 18:52:33 +01002888 else if (rhs_type == &t_unknown)
Bram Moolenaarfa103972022-09-29 19:14:42 +01002889 type = &t_any;
Bram Moolenaar72abcf42020-06-18 18:26:24 +02002890 else
Bram Moolenaare88c6b72022-02-15 15:37:11 +00002891 {
Bram Moolenaarfa103972022-09-29 19:14:42 +01002892 type = rhs_type;
Bram Moolenaare88c6b72022-02-15 15:37:11 +00002893 inferred_type = rhs_type;
2894 }
Bram Moolenaarfa103972022-09-29 19:14:42 +01002895 set_var_type(lhs.lhs_lvar, type, cctx);
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002896 }
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02002897 }
Bram Moolenaar93ad1472020-08-19 22:02:41 +02002898 else if (*op == '=')
Bram Moolenaar72abcf42020-06-18 18:26:24 +02002899 {
Bram Moolenaar752fc692021-01-04 21:57:11 +01002900 type_T *use_type = lhs.lhs_lvar->lv_type;
Bram Moolenaar4270d8b2021-08-07 16:30:42 +02002901 where_T where = WHERE_INIT;
Bram Moolenaar72abcf42020-06-18 18:26:24 +02002902
Bram Moolenaar77709b12021-04-03 21:01:01 +02002903 // Without operator check type here, otherwise below.
2904 // Use the line number of the assignment.
2905 SOURCING_LNUM = start_lnum;
LemonBoyc5d27442023-08-19 13:02:35 +02002906 if (var_count > 0)
2907 {
2908 where.wt_index = var_idx + 1;
2909 where.wt_kind = WT_VARIABLE;
2910 }
Bram Moolenaar4f0884d2021-08-11 21:49:23 +02002911 // If assigning to a list or dict member, use the
2912 // member type. Not for "list[:] =".
2913 if (lhs.lhs_has_index
2914 && !has_list_index(var_start + lhs.lhs_varlen,
2915 cctx))
Bram Moolenaar752fc692021-01-04 21:57:11 +01002916 use_type = lhs.lhs_member_type;
Bram Moolenaarc6951a72022-12-29 20:56:24 +00002917 if (need_type_where(rhs_type, use_type, FALSE, -1,
2918 where, cctx, FALSE, is_const) == FAIL)
Bram Moolenaar72abcf42020-06-18 18:26:24 +02002919 goto theend;
2920 }
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02002921 }
Bram Moolenaar74f4a962021-06-17 21:03:07 +02002922 else
2923 {
2924 type_T *lhs_type = lhs.lhs_member_type;
2925
2926 // Special case: assigning to @# can use a number or a
2927 // string.
Bram Moolenaaraf647e72021-08-05 19:01:17 +02002928 // Also: can assign a number to a float.
2929 if ((lhs_type == &t_number_or_string
2930 || lhs_type == &t_float)
2931 && rhs_type->tt_type == VAR_NUMBER)
Bram Moolenaar74f4a962021-06-17 21:03:07 +02002932 lhs_type = &t_number;
Bram Moolenaarc6951a72022-12-29 20:56:24 +00002933 if (*p != '=' && need_type(rhs_type, lhs_type, FALSE,
Bram Moolenaar351ead02021-01-16 16:07:01 +01002934 -1, 0, cctx, FALSE, FALSE) == FAIL)
Bram Moolenaarf39d9e92023-04-22 22:54:40 +01002935 goto theend;
Bram Moolenaar74f4a962021-06-17 21:03:07 +02002936 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002937 }
Bram Moolenaar30fd8202020-09-26 15:09:30 +02002938 else if (cmdidx == CMD_final)
2939 {
2940 emsg(_(e_final_requires_a_value));
2941 goto theend;
2942 }
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002943 else if (cmdidx == CMD_const)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002944 {
Bram Moolenaarbc4c5052020-08-13 22:47:35 +02002945 emsg(_(e_const_requires_a_value));
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002946 goto theend;
2947 }
Bram Moolenaardcb53be2021-12-09 14:23:43 +00002948 else if (!lhs.lhs_has_type || lhs.lhs_dest == dest_option
2949 || lhs.lhs_dest == dest_func_option)
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002950 {
Bram Moolenaarbc4c5052020-08-13 22:47:35 +02002951 emsg(_(e_type_or_initialization_required));
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002952 goto theend;
2953 }
2954 else
2955 {
2956 // variables are always initialized
Bram Moolenaar35578162021-08-02 19:10:38 +02002957 if (GA_GROW_FAILS(instr, 1))
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002958 goto theend;
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00002959 instr_count = instr->ga_len;
2960 int r = push_default_value(cctx, lhs.lhs_member_type->tt_type,
2961 lhs.lhs_dest == dest_local, &skip_store);
Bram Moolenaarc9af6172022-05-04 16:46:54 +01002962 if (r == FAIL)
2963 goto theend;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002964 }
2965 if (var_count == 0)
2966 end = p;
2967 }
2968
Bram Moolenaar72abcf42020-06-18 18:26:24 +02002969 // no need to parse more when skipping
Bram Moolenaar9b68c822020-06-18 19:31:08 +02002970 if (cctx->ctx_skip == SKIP_YES)
Bram Moolenaar72abcf42020-06-18 18:26:24 +02002971 break;
2972
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002973 if (oplen > 0 && *op != '=')
2974 {
Bram Moolenaar93ad1472020-08-19 22:02:41 +02002975 type_T *expected;
Bram Moolenaarc3160722021-08-02 21:12:05 +02002976 type_T *stacktype = NULL;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002977
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002978 if (*op == '.')
Bram Moolenaarf5d52c92021-07-31 22:51:10 +02002979 {
Yegappan Lakshmananbce51d92024-04-15 19:19:52 +02002980 if (may_generate_2STRING(-1, TOSTRING_NONE, cctx) == FAIL)
Bram Moolenaarf5d52c92021-07-31 22:51:10 +02002981 goto theend;
2982 }
Bram Moolenaar93ad1472020-08-19 22:02:41 +02002983 else
Bram Moolenaarf5d52c92021-07-31 22:51:10 +02002984 {
Bram Moolenaar752fc692021-01-04 21:57:11 +01002985 expected = lhs.lhs_member_type;
Bram Moolenaar078a4612022-01-04 15:17:03 +00002986 stacktype = get_type_on_stack(cctx, 0);
Bram Moolenaarf5d52c92021-07-31 22:51:10 +02002987 if (
Bram Moolenaarf5d52c92021-07-31 22:51:10 +02002988 // If variable is float operation with number is OK.
Bram Moolenaar7bf9a072021-08-02 21:55:15 +02002989 !(expected == &t_float && (stacktype == &t_number
Bram Moolenaarc6951a72022-12-29 20:56:24 +00002990 || stacktype == &t_number_bool))
2991 && need_type(stacktype, expected, TRUE, -1, 0, cctx,
Bram Moolenaar334a8b42020-10-19 16:07:42 +02002992 FALSE, FALSE) == FAIL)
Bram Moolenaarf5d52c92021-07-31 22:51:10 +02002993 goto theend;
2994 }
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002995
2996 if (*op == '.')
Bram Moolenaardd29f1b2020-08-07 20:46:20 +02002997 {
LemonBoy372bcce2022-04-25 12:43:20 +01002998 if (generate_CONCAT(cctx, 2) == FAIL)
Bram Moolenaardd29f1b2020-08-07 20:46:20 +02002999 goto theend;
3000 }
3001 else if (*op == '+')
3002 {
3003 if (generate_add_instr(cctx,
Bram Moolenaar752fc692021-01-04 21:57:11 +01003004 operator_type(lhs.lhs_member_type, stacktype),
Bram Moolenaar07802042021-09-09 23:01:14 +02003005 lhs.lhs_member_type, stacktype,
3006 EXPR_APPEND) == FAIL)
Bram Moolenaardd29f1b2020-08-07 20:46:20 +02003007 goto theend;
3008 }
Bram Moolenaar93ad1472020-08-19 22:02:41 +02003009 else if (generate_two_op(cctx, op) == FAIL)
3010 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003011 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003012
Bram Moolenaar6977dba2021-07-04 22:48:12 +02003013 // Use the line number of the assignment for store instruction.
3014 save_lnum = cctx->ctx_lnum;
3015 cctx->ctx_lnum = start_lnum - 1;
3016
Bram Moolenaar752fc692021-01-04 21:57:11 +01003017 if (lhs.lhs_has_index)
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02003018 {
Bram Moolenaar752fc692021-01-04 21:57:11 +01003019 // Use the info in "lhs" to store the value at the index in the
Bram Moolenaar22363c62023-04-24 17:15:25 +01003020 // list, dict or object.
Bram Moolenaar752fc692021-01-04 21:57:11 +01003021 if (compile_assign_unlet(var_start, &lhs, TRUE, rhs_type, cctx)
3022 == FAIL)
Bram Moolenaar6977dba2021-07-04 22:48:12 +02003023 {
3024 cctx->ctx_lnum = save_lnum;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02003025 goto theend;
Bram Moolenaar6977dba2021-07-04 22:48:12 +02003026 }
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02003027 }
3028 else
3029 {
Bram Moolenaar752fc692021-01-04 21:57:11 +01003030 if (is_decl && cmdidx == CMD_const && (lhs.lhs_dest == dest_script
Ernie Rael3f821d62024-04-24 20:07:50 +02003031 || lhs.lhs_dest == dest_script_v9
3032 || lhs.lhs_dest == dest_global
3033 || lhs.lhs_dest == dest_local))
Bram Moolenaar30fd8202020-09-26 15:09:30 +02003034 // ":const var": lock the value, but not referenced variables
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +02003035 generate_LOCKCONST(cctx);
3036
Bram Moolenaar10d6f182022-01-04 15:54:38 +00003037 if ((lhs.lhs_type->tt_type == VAR_DICT
Bram Moolenaar752fc692021-01-04 21:57:11 +01003038 || lhs.lhs_type->tt_type == VAR_LIST)
3039 && lhs.lhs_type->tt_member != NULL
Bram Moolenaare88c6b72022-02-15 15:37:11 +00003040 && lhs.lhs_type->tt_member != &t_any
Bram Moolenaar752fc692021-01-04 21:57:11 +01003041 && lhs.lhs_type->tt_member != &t_unknown)
Bram Moolenaaraa210a32021-01-02 15:41:03 +01003042 // Set the type in the list or dict, so that it can be checked,
Bram Moolenaar10d6f182022-01-04 15:54:38 +00003043 // also in legacy script.
Bram Moolenaar752fc692021-01-04 21:57:11 +01003044 generate_SETTYPE(cctx, lhs.lhs_type);
Bram Moolenaare88c6b72022-02-15 15:37:11 +00003045 else if (inferred_type != NULL
3046 && (inferred_type->tt_type == VAR_DICT
3047 || inferred_type->tt_type == VAR_LIST)
3048 && inferred_type->tt_member != NULL
3049 && inferred_type->tt_member != &t_unknown
3050 && inferred_type->tt_member != &t_any)
3051 // Set the type in the list or dict, so that it can be checked,
3052 // also in legacy script.
3053 generate_SETTYPE(cctx, inferred_type);
Bram Moolenaaraa210a32021-01-02 15:41:03 +01003054
Bram Moolenaar5cd64792021-12-25 18:23:24 +00003055 if (!skip_store && generate_store_lhs(cctx, &lhs,
3056 instr_count, is_decl) == FAIL)
Bram Moolenaar6977dba2021-07-04 22:48:12 +02003057 {
3058 cctx->ctx_lnum = save_lnum;
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02003059 goto theend;
Bram Moolenaar6977dba2021-07-04 22:48:12 +02003060 }
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02003061 }
Bram Moolenaar6977dba2021-07-04 22:48:12 +02003062 cctx->ctx_lnum = save_lnum;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02003063
3064 if (var_idx + 1 < var_count)
Bram Moolenaarab36e6a2021-11-30 16:14:49 +00003065 var_start = skipwhite(lhs.lhs_end + 1);
Bram Moolenaar65b0d162022-12-13 18:43:22 +00003066
3067 if (has_arg_is_set_prefix)
3068 {
3069 // set instruction index in JUMP_IF_ARG_SET to here
3070 isn_T *isn = ((isn_T *)instr->ga_data) + jump_instr_idx;
3071 isn->isn_arg.jumparg.jump_where = instr->ga_len;
3072 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003073 }
Bram Moolenaar47a519a2020-06-14 23:05:10 +02003074
Bram Moolenaar4d5dfe22021-06-26 13:59:29 +02003075 // For "[var, var] = expr" drop the "expr" value.
3076 // Also for "[var, var; _] = expr".
3077 if (var_count > 0 && (!semicolon || !did_generate_slice))
Bram Moolenaar9af78762020-06-16 11:34:42 +02003078 {
Bram Moolenaarec792292020-12-13 21:26:56 +01003079 if (generate_instr_drop(cctx, ISN_DROP, 1) == NULL)
Bram Moolenaar9af78762020-06-16 11:34:42 +02003080 goto theend;
3081 }
Bram Moolenaar47a519a2020-06-14 23:05:10 +02003082
Bram Moolenaarb2097502020-07-19 17:17:02 +02003083 ret = skipwhite(end);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003084
3085theend:
Bram Moolenaar752fc692021-01-04 21:57:11 +01003086 vim_free(lhs.lhs_name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003087 return ret;
3088}
3089
3090/*
Bram Moolenaar17126b12021-01-07 22:03:02 +01003091 * Check for an assignment at "eap->cmd", compile it if found.
3092 * Return NOTDONE if there is none, FAIL for failure, OK if done.
3093 */
3094 static int
3095may_compile_assignment(exarg_T *eap, char_u **line, cctx_T *cctx)
3096{
3097 char_u *pskip;
3098 char_u *p;
3099
3100 // Assuming the command starts with a variable or function name,
3101 // find what follows.
3102 // Skip over "var.member", "var[idx]" and the like.
3103 // Also "&opt = val", "$ENV = val" and "@r = val".
3104 pskip = (*eap->cmd == '&' || *eap->cmd == '$' || *eap->cmd == '@')
3105 ? eap->cmd + 1 : eap->cmd;
3106 p = to_name_end(pskip, TRUE);
3107 if (p > eap->cmd && *p != NUL)
3108 {
3109 char_u *var_end;
3110 int oplen;
3111 int heredoc;
3112
3113 if (eap->cmd[0] == '@')
3114 var_end = eap->cmd + 2;
3115 else
3116 var_end = find_name_end(pskip, NULL, NULL,
3117 FNE_CHECK_START | FNE_INCL_BR);
3118 oplen = assignment_len(skipwhite(var_end), &heredoc);
3119 if (oplen > 0)
3120 {
3121 size_t len = p - eap->cmd;
3122
3123 // Recognize an assignment if we recognize the variable
3124 // name:
Bram Moolenaar17126b12021-01-07 22:03:02 +01003125 // "&opt = expr"
3126 // "$ENV = expr"
3127 // "@r = expr"
Bram Moolenaar2e17fef2022-03-18 19:44:48 +00003128 // "g:var = expr"
3129 // "g:[key] = expr"
3130 // "local = expr" where "local" is a local var.
3131 // "script = expr" where "script" is a script-local var.
3132 // "import = expr" where "import" is an imported var
Bram Moolenaar17126b12021-01-07 22:03:02 +01003133 if (*eap->cmd == '&'
3134 || *eap->cmd == '$'
3135 || *eap->cmd == '@'
3136 || ((len) > 2 && eap->cmd[1] == ':')
Bram Moolenaar2e17fef2022-03-18 19:44:48 +00003137 || STRNCMP(eap->cmd, "g:[", 3) == 0
Bram Moolenaare0890d62021-02-17 14:52:14 +01003138 || variable_exists(eap->cmd, len, cctx))
Bram Moolenaar17126b12021-01-07 22:03:02 +01003139 {
3140 *line = compile_assignment(eap->cmd, eap, CMD_SIZE, cctx);
3141 if (*line == NULL || *line == eap->cmd)
3142 return FAIL;
3143 return OK;
3144 }
3145 }
3146 }
3147
Bram Moolenaar65b0d162022-12-13 18:43:22 +00003148 // might be "[var, var] = expr" or "ifargisset this.member = expr"
3149 if (*eap->cmd == '[' || STRNCMP(eap->cmd, "ifargisset ", 11) == 0)
Bram Moolenaar17126b12021-01-07 22:03:02 +01003150 {
Bram Moolenaar17126b12021-01-07 22:03:02 +01003151 *line = compile_assignment(eap->cmd, eap, CMD_SIZE, cctx);
3152 if (*line == NULL)
3153 return FAIL;
3154 if (*line != eap->cmd)
3155 return OK;
3156 }
3157 return NOTDONE;
3158}
3159
Bram Moolenaar9a015112021-12-31 14:06:45 +00003160/*
3161 * Check if arguments of "ufunc" shadow variables in "cctx".
3162 * Return OK or FAIL.
3163 */
3164 static int
3165check_args_shadowing(ufunc_T *ufunc, cctx_T *cctx)
3166{
3167 int i;
3168 char_u *arg;
3169 int r = OK;
3170
3171 // Make sure arguments are not found when compiling a second time.
3172 ufunc->uf_args_visible = 0;
3173
3174 // Check for arguments shadowing variables from the context.
3175 for (i = 0; i < ufunc->uf_args.ga_len; ++i)
3176 {
3177 arg = ((char_u **)(ufunc->uf_args.ga_data))[i];
Bram Moolenaardce24412022-02-08 20:35:30 +00003178 if (check_defined(arg, STRLEN(arg), cctx, NULL, TRUE) == FAIL)
Bram Moolenaar9a015112021-12-31 14:06:45 +00003179 {
3180 r = FAIL;
3181 break;
3182 }
3183 }
3184 ufunc->uf_args_visible = ufunc->uf_args.ga_len;
3185 return r;
3186}
3187
Bram Moolenaarfcb86b02022-10-07 22:46:24 +01003188#ifdef HAS_MESSAGE_WINDOW
Bram Moolenaar139575d2022-03-15 19:29:30 +00003189/*
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003190 * Get a count before a command. Can only be a number.
3191 * Returns zero if there is no count.
3192 * Returns -1 if there is something wrong.
3193 */
3194 static long
3195get_cmd_count(char_u *line, exarg_T *eap)
3196{
3197 char_u *p;
3198
3199 // skip over colons and white space
3200 for (p = line; *p == ':' || VIM_ISWHITE(*p); ++p)
3201 ;
Keith Thompson184f71c2024-01-04 21:19:04 +01003202 if (!SAFE_isdigit(*p))
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003203 {
Bram Moolenaar2435adf2022-10-21 12:05:46 +01003204 // The command or modifiers must be following. Assume a lower case
3205 // character means there is a modifier.
3206 if (p < eap->cmd && !vim_islower(*p))
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003207 {
3208 emsg(_(e_invalid_range));
3209 return -1;
3210 }
3211 return 0;
3212 }
3213 return atol((char *)p);
3214}
Bram Moolenaarfcb86b02022-10-07 22:46:24 +01003215#endif
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003216
3217/*
Bram Moolenaar139575d2022-03-15 19:29:30 +00003218 * Get the compilation type that should be used for "ufunc".
3219 * Keep in sync with INSTRUCTIONS().
3220 */
3221 compiletype_T
3222get_compile_type(ufunc_T *ufunc)
3223{
3224 // Update uf_has_breakpoint if needed.
3225 update_has_breakpoint(ufunc);
3226
3227 if (debug_break_level > 0 || may_break_in_function(ufunc))
3228 return CT_DEBUG;
3229#ifdef FEAT_PROFILE
3230 if (do_profiling == PROF_YES)
3231 {
Ernie Rael21d32122023-09-02 15:09:18 +02003232 if (!ufunc->uf_profiling && has_profiling(FALSE, ufunc->uf_name, NULL,
3233 &ufunc->uf_hash))
Bram Moolenaar139575d2022-03-15 19:29:30 +00003234 func_do_profile(ufunc);
3235 if (ufunc->uf_profiling)
3236 return CT_PROFILE;
3237 }
3238#endif
3239 return CT_NONE;
3240}
3241
Bram Moolenaar7b829262021-10-13 15:04:34 +01003242
3243/*
Bram Moolenaar09689a02020-05-09 22:50:08 +02003244 * Add a function to the list of :def functions.
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003245 * This sets "ufunc->uf_dfunc_idx" but the function isn't compiled yet.
Bram Moolenaar09689a02020-05-09 22:50:08 +02003246 */
Bram Moolenaar822ba242020-05-24 23:00:18 +02003247 static int
Bram Moolenaar09689a02020-05-09 22:50:08 +02003248add_def_function(ufunc_T *ufunc)
3249{
3250 dfunc_T *dfunc;
3251
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003252 if (def_functions.ga_len == 0)
3253 {
3254 // The first position is not used, so that a zero uf_dfunc_idx means it
3255 // wasn't set.
Bram Moolenaar35578162021-08-02 19:10:38 +02003256 if (GA_GROW_FAILS(&def_functions, 1))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003257 return FAIL;
3258 ++def_functions.ga_len;
3259 }
3260
Bram Moolenaar09689a02020-05-09 22:50:08 +02003261 // Add the function to "def_functions".
Bram Moolenaar35578162021-08-02 19:10:38 +02003262 if (GA_GROW_FAILS(&def_functions, 1))
Bram Moolenaar09689a02020-05-09 22:50:08 +02003263 return FAIL;
3264 dfunc = ((dfunc_T *)def_functions.ga_data) + def_functions.ga_len;
3265 CLEAR_POINTER(dfunc);
3266 dfunc->df_idx = def_functions.ga_len;
3267 ufunc->uf_dfunc_idx = dfunc->df_idx;
3268 dfunc->df_ufunc = ufunc;
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01003269 dfunc->df_name = vim_strsave(ufunc->uf_name);
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02003270 ga_init2(&dfunc->df_var_names, sizeof(char_u *), 10);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01003271 ++dfunc->df_refcount;
Bram Moolenaar09689a02020-05-09 22:50:08 +02003272 ++def_functions.ga_len;
3273 return OK;
3274}
3275
3276/*
Yegappan Lakshmananf6c1fb22024-04-25 21:30:56 +02003277 * For an object constructor, generate instruction to setup "this" (the first
3278 * local variable) and to initialize the object variables.
3279 */
3280 static int
3281obj_constructor_prologue(ufunc_T *ufunc, cctx_T *cctx)
3282{
3283 generate_CONSTRUCT(cctx, ufunc->uf_class);
3284
3285 for (int i = 0; i < ufunc->uf_class->class_obj_member_count; ++i)
3286 {
3287 ocmember_T *m = &ufunc->uf_class->class_obj_members[i];
3288
3289 if (i < 2 && IS_ENUM(ufunc->uf_class))
3290 // The first two object variables in an enum are the name
3291 // and the ordinal. These are set by the ISN_CONSTRUCT
3292 // instruction. So don't generate instructions to set
3293 // these variables.
3294 continue;
3295
3296 if (m->ocm_init != NULL)
3297 {
3298 char_u *expr = m->ocm_init;
3299
3300 if (compile_expr0(&expr, cctx) == FAIL)
3301 return FAIL;
3302
3303 if (!ends_excmd2(m->ocm_init, expr))
3304 {
3305 semsg(_(e_trailing_characters_str), expr);
3306 return FAIL;
3307 }
3308
3309 type_T *type = get_type_on_stack(cctx, 0);
3310 if (m->ocm_type->tt_type == VAR_ANY
3311 && !(m->ocm_flags & OCMFLAG_HAS_TYPE)
3312 && type->tt_type != VAR_SPECIAL)
3313 {
3314 // If the member variable type is not yet set, then use
3315 // the initialization expression type.
3316 m->ocm_type = type;
3317 }
LemonBoyf4af3312024-07-04 13:43:12 +02003318 else
Yegappan Lakshmananf6c1fb22024-04-25 21:30:56 +02003319 {
3320 // The type of the member initialization expression is
3321 // determined at run time. Add a runtime type check.
3322 where_T where = WHERE_INIT;
3323 where.wt_kind = WT_MEMBER;
3324 where.wt_func_name = (char *)m->ocm_name;
3325 if (need_type_where(type, m->ocm_type, FALSE, -1,
3326 where, cctx, FALSE, FALSE) == FAIL)
3327 return FAIL;
3328 }
3329 }
3330 else
3331 push_default_value(cctx, m->ocm_type->tt_type, FALSE, NULL);
3332
LemonBoyf4af3312024-07-04 13:43:12 +02003333 if ((m->ocm_type->tt_type == VAR_DICT
3334 || m->ocm_type->tt_type == VAR_LIST)
3335 && m->ocm_type->tt_member != NULL
3336 && m->ocm_type->tt_member != &t_any
3337 && m->ocm_type->tt_member != &t_unknown)
3338 // Set the type in the list or dict, so that it can be checked,
3339 // also in legacy script.
3340 generate_SETTYPE(cctx, m->ocm_type);
3341
Yegappan Lakshmananf6c1fb22024-04-25 21:30:56 +02003342 generate_STORE_THIS(cctx, i);
3343 }
3344
3345 return OK;
3346}
3347
3348/*
3349 * For an object method and an constructor, generate instruction to setup
3350 * "this" (the first local variable). For a constructor, generate instructions
3351 * to initialize the object variables.
3352 */
3353 static int
3354obj_method_prologue(ufunc_T *ufunc, cctx_T *cctx)
3355{
3356 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data) + ufunc->uf_dfunc_idx;
3357
3358 if (GA_GROW_FAILS(&dfunc->df_var_names, 1))
3359 return FAIL;
3360
3361 ((char_u **)dfunc->df_var_names.ga_data)[0] =
3362 vim_strsave((char_u *)"this");
3363 ++dfunc->df_var_names.ga_len;
3364
3365 // In the constructor allocate memory for the object and initialize the
3366 // object members.
3367 if (IS_CONSTRUCTOR_METHOD(ufunc))
3368 return obj_constructor_prologue(ufunc, cctx);
3369
3370 return OK;
3371}
3372
3373/*
3374 * Produce instructions for the default values of optional arguments.
3375 */
3376 static int
3377compile_def_function_default_args(
3378 ufunc_T *ufunc,
3379 cctx_T *cctx,
3380 garray_T *instr)
3381{
3382 int count = ufunc->uf_def_args.ga_len;
3383 int first_def_arg = ufunc->uf_args.ga_len - count;
3384 int i;
3385 int off = STACK_FRAME_SIZE + (ufunc->uf_va_name != NULL ? 1 : 0);
3386 int did_set_arg_type = FALSE;
3387
3388 // Produce instructions for the default values of optional arguments.
3389 SOURCING_LNUM = 0; // line number unknown
3390 for (i = 0; i < count; ++i)
3391 {
3392 char_u *arg = ((char_u **)(ufunc->uf_def_args.ga_data))[i];
3393 if (STRCMP(arg, "v:none") == 0)
3394 // "arg = v:none" means the argument is optional without
3395 // setting a value when the argument is missing.
3396 continue;
3397
3398 type_T *val_type;
3399 int arg_idx = first_def_arg + i;
3400 where_T where = WHERE_INIT;
3401 int jump_instr_idx = instr->ga_len;
3402 isn_T *isn;
3403
3404 // Use a JUMP_IF_ARG_SET instruction to skip if the value was given.
3405 if (generate_JUMP_IF_ARG(cctx, ISN_JUMP_IF_ARG_SET,
3406 i - count - off) == FAIL)
3407 return FAIL;
3408
3409 // Make sure later arguments are not found.
3410 ufunc->uf_args_visible = arg_idx;
3411
3412 int r = compile_expr0(&arg, cctx);
3413 if (r == FAIL)
3414 return FAIL;
3415
3416 // If no type specified use the type of the default value.
3417 // Otherwise check that the default value type matches the
3418 // specified type.
3419 val_type = get_type_on_stack(cctx, 0);
3420 where.wt_index = arg_idx + 1;
3421 where.wt_kind = WT_ARGUMENT;
3422 if (ufunc->uf_arg_types[arg_idx] == &t_unknown)
3423 {
3424 did_set_arg_type = TRUE;
3425 ufunc->uf_arg_types[arg_idx] = val_type;
3426 }
3427 else if (need_type_where(val_type, ufunc->uf_arg_types[arg_idx],
3428 FALSE, -1, where, cctx, FALSE, FALSE) == FAIL)
3429 return FAIL;
3430
3431 if (generate_STORE(cctx, ISN_STORE, i - count - off, NULL) == FAIL)
3432 return FAIL;
3433
3434 // set instruction index in JUMP_IF_ARG_SET to here
3435 isn = ((isn_T *)instr->ga_data) + jump_instr_idx;
3436 isn->isn_arg.jumparg.jump_where = instr->ga_len;
3437 }
3438
3439 if (did_set_arg_type)
3440 set_function_type(ufunc);
3441
3442 return OK;
3443}
3444
3445/*
Yegappan Lakshmanana16f2512024-04-23 20:14:46 +02003446 * Compile def function body. Loop over all the lines in the function and
3447 * generate instructions.
3448 */
3449 static int
3450compile_def_function_body(
3451 cctx_T *cctx,
3452 int last_func_lnum,
3453 int check_return_type,
3454 garray_T *lines_to_free,
3455 char **errormsg)
3456{
3457 char_u *line = NULL;
3458 char_u *p;
3459 int did_emsg_before = did_emsg;
3460#ifdef FEAT_PROFILE
3461 int prof_lnum = -1;
3462#endif
3463 int debug_lnum = -1;
3464
3465 for (;;)
3466 {
3467 exarg_T ea;
3468 int starts_with_colon = FALSE;
3469 char_u *cmd;
3470 cmdmod_T local_cmdmod;
3471
3472 // Bail out on the first error to avoid a flood of errors and report
3473 // the right line number when inside try/catch.
3474 if (did_emsg_before != did_emsg)
3475 return FAIL;
3476
3477 if (line != NULL && *line == '|')
3478 // the line continues after a '|'
3479 ++line;
3480 else if (line != NULL && *skipwhite(line) != NUL
3481 && !(*line == '#' && (line == cctx->ctx_line_start
3482 || VIM_ISWHITE(line[-1]))))
3483 {
3484 semsg(_(e_trailing_characters_str), line);
3485 return FAIL;
3486 }
3487 else if (line != NULL && vim9_bad_comment(skipwhite(line)))
3488 return FAIL;
3489 else
3490 {
3491 line = next_line_from_context(cctx, FALSE);
3492 if (cctx->ctx_lnum >= last_func_lnum)
3493 {
3494 // beyond the last line
3495#ifdef FEAT_PROFILE
3496 if (cctx->ctx_skip != SKIP_YES)
3497 may_generate_prof_end(cctx, prof_lnum);
3498#endif
3499 break;
3500 }
3501 // Make a copy, splitting off nextcmd and removing trailing spaces
3502 // may change it.
3503 if (line != NULL)
3504 {
3505 line = vim_strsave(line);
3506 if (ga_add_string(lines_to_free, line) == FAIL)
3507 return FAIL;
3508 }
3509 }
3510
3511 CLEAR_FIELD(ea);
3512 ea.cmdlinep = &line;
3513 ea.cmd = skipwhite(line);
3514 ea.skip = cctx->ctx_skip == SKIP_YES;
3515
3516 if (*ea.cmd == '#')
3517 {
3518 // "#" starts a comment, but "#{" is an error
3519 if (vim9_bad_comment(ea.cmd))
3520 return FAIL;
3521 line = (char_u *)"";
3522 continue;
3523 }
3524
3525#ifdef FEAT_PROFILE
3526 if (cctx->ctx_compile_type == CT_PROFILE && cctx->ctx_lnum != prof_lnum
3527 && cctx->ctx_skip != SKIP_YES)
3528 {
3529 may_generate_prof_end(cctx, prof_lnum);
3530
3531 prof_lnum = cctx->ctx_lnum;
3532 generate_instr(cctx, ISN_PROF_START);
3533 }
3534#endif
3535 if (cctx->ctx_compile_type == CT_DEBUG && cctx->ctx_lnum != debug_lnum
3536 && cctx->ctx_skip != SKIP_YES)
3537 {
3538 debug_lnum = cctx->ctx_lnum;
3539 generate_instr_debug(cctx);
3540 }
3541 cctx->ctx_prev_lnum = cctx->ctx_lnum + 1;
3542
3543 // Some things can be recognized by the first character.
3544 switch (*ea.cmd)
3545 {
3546 case '}':
3547 {
3548 // "}" ends a block scope
3549 scopetype_T stype = cctx->ctx_scope == NULL
3550 ? NO_SCOPE : cctx->ctx_scope->se_type;
3551
3552 if (stype == BLOCK_SCOPE)
3553 {
3554 compile_endblock(cctx);
3555 line = ea.cmd;
3556 }
3557 else
3558 {
3559 emsg(_(e_using_rcurly_outside_if_block_scope));
3560 return FAIL;
3561 }
3562 if (line != NULL)
3563 line = skipwhite(ea.cmd + 1);
3564 continue;
3565 }
3566
3567 case '{':
3568 // "{" starts a block scope
3569 // "{'a': 1}->func() is something else
3570 if (ends_excmd(*skipwhite(ea.cmd + 1)))
3571 {
3572 line = compile_block(ea.cmd, cctx);
3573 continue;
3574 }
3575 break;
3576 }
3577
3578 /*
3579 * COMMAND MODIFIERS
3580 */
3581 cctx->ctx_has_cmdmod = FALSE;
3582 if (parse_command_modifiers(&ea, errormsg, &local_cmdmod, FALSE)
3583 == FAIL)
3584 return FAIL;
3585 generate_cmdmods(cctx, &local_cmdmod);
3586 undo_cmdmod(&local_cmdmod);
3587
3588 // Check if there was a colon after the last command modifier or before
3589 // the current position.
3590 for (p = ea.cmd; p >= line; --p)
3591 {
3592 if (*p == ':')
3593 starts_with_colon = TRUE;
3594 if (p < ea.cmd && !VIM_ISWHITE(*p))
3595 break;
3596 }
3597
3598 // Skip ":call" to get to the function name, unless using :legacy
3599 p = ea.cmd;
3600 if (!(local_cmdmod.cmod_flags & CMOD_LEGACY))
3601 {
3602 if (checkforcmd(&ea.cmd, "call", 3))
3603 {
3604 if (*ea.cmd == '(')
3605 // not for "call()"
3606 ea.cmd = p;
3607 else
3608 ea.cmd = skipwhite(ea.cmd);
3609 }
3610
3611 if (!starts_with_colon)
3612 {
3613 int assign;
3614
3615 // Check for assignment after command modifiers.
3616 assign = may_compile_assignment(&ea, &line, cctx);
3617 if (assign == OK)
3618 goto nextline;
3619 if (assign == FAIL)
3620 return FAIL;
3621 }
3622 }
3623
3624 /*
3625 * COMMAND after range
3626 * 'text'->func() should not be confused with 'a mark
3627 * 0z1234->func() should not be confused with a zero line number
3628 * "++nr" and "--nr" are eval commands
3629 * in "$ENV->func()" the "$" is not a range
3630 * "123->func()" is a method call
3631 */
3632 cmd = ea.cmd;
3633 if ((*cmd != '$' || starts_with_colon)
3634 && (starts_with_colon
3635 || !(*cmd == '\''
3636 || (cmd[0] == '0' && cmd[1] == 'z')
3637 || (cmd[0] != NUL && cmd[0] == cmd[1]
3638 && (*cmd == '+' || *cmd == '-'))
3639 || number_method(cmd))))
3640 {
3641 ea.cmd = skip_range(ea.cmd, TRUE, NULL);
3642 if (ea.cmd > cmd)
3643 {
3644 if (!starts_with_colon
3645 && !(local_cmdmod.cmod_flags & CMOD_LEGACY))
3646 {
3647 semsg(_(e_colon_required_before_range_str), cmd);
3648 return FAIL;
3649 }
3650 ea.addr_count = 1;
3651 if (ends_excmd2(line, ea.cmd))
3652 {
3653 // A range without a command: jump to the line.
3654 generate_EXEC(cctx, ISN_EXECRANGE,
3655 vim_strnsave(cmd, ea.cmd - cmd));
3656 line = ea.cmd;
3657 goto nextline;
3658 }
3659 }
3660 }
3661 p = find_ex_command(&ea, NULL,
3662 starts_with_colon || (local_cmdmod.cmod_flags & CMOD_LEGACY)
3663 ? NULL : item_exists, cctx);
3664
3665 if (p == NULL)
3666 {
3667 if (cctx->ctx_skip != SKIP_YES)
3668 semsg(_(e_ambiguous_use_of_user_defined_command_str), ea.cmd);
3669 return FAIL;
3670 }
3671
3672 // When using ":legacy cmd" always use compile_exec().
3673 if (local_cmdmod.cmod_flags & CMOD_LEGACY)
3674 {
3675 char_u *start = ea.cmd;
3676
3677 switch (ea.cmdidx)
3678 {
3679 case CMD_if:
3680 case CMD_elseif:
3681 case CMD_else:
3682 case CMD_endif:
3683 case CMD_for:
3684 case CMD_endfor:
3685 case CMD_continue:
3686 case CMD_break:
3687 case CMD_while:
3688 case CMD_endwhile:
3689 case CMD_try:
3690 case CMD_catch:
3691 case CMD_finally:
3692 case CMD_endtry:
3693 semsg(_(e_cannot_use_legacy_with_command_str), ea.cmd);
3694 return FAIL;
3695 default: break;
3696 }
3697
3698 // ":legacy return expr" needs to be handled differently.
3699 if (checkforcmd(&start, "return", 4))
3700 ea.cmdidx = CMD_return;
3701 else
3702 ea.cmdidx = CMD_legacy;
3703 }
3704
3705 if (p == ea.cmd && ea.cmdidx != CMD_SIZE)
3706 {
3707 // "eval" is used for "val->func()" and "var" for "var = val", then
3708 // "p" is equal to "ea.cmd" for a valid command.
3709 if (ea.cmdidx == CMD_eval || ea.cmdidx == CMD_var)
3710 ;
3711 else if (cctx->ctx_skip == SKIP_YES)
3712 {
3713 line += STRLEN(line);
3714 goto nextline;
3715 }
3716 else
3717 {
3718 semsg(_(e_command_not_recognized_str), ea.cmd);
3719 return FAIL;
3720 }
3721 }
3722
3723 if ((cctx->ctx_had_return || cctx->ctx_had_throw)
3724 && ea.cmdidx != CMD_elseif
3725 && ea.cmdidx != CMD_else
3726 && ea.cmdidx != CMD_endif
3727 && ea.cmdidx != CMD_endfor
3728 && ea.cmdidx != CMD_endwhile
3729 && ea.cmdidx != CMD_catch
3730 && ea.cmdidx != CMD_finally
3731 && ea.cmdidx != CMD_endtry
3732 && !ignore_unreachable_code_for_testing)
3733 {
3734 semsg(_(e_unreachable_code_after_str),
3735 cctx->ctx_had_return ? "return" : "throw");
3736 return FAIL;
3737 }
3738 cctx->ctx_had_throw = FALSE;
3739
3740 p = skipwhite(p);
3741 if (ea.cmdidx != CMD_SIZE
3742 && ea.cmdidx != CMD_write && ea.cmdidx != CMD_read)
3743 {
3744 if (ea.cmdidx >= 0)
3745 ea.argt = excmd_get_argt(ea.cmdidx);
3746 if ((ea.argt & EX_BANG) && *p == '!')
3747 {
3748 ea.forceit = TRUE;
3749 p = skipwhite(p + 1);
3750 }
3751 if ((ea.argt & EX_RANGE) == 0 && ea.addr_count > 0)
3752 {
3753 emsg(_(e_no_range_allowed));
3754 return FAIL;
3755 }
3756 }
3757
3758 switch (ea.cmdidx)
3759 {
3760 case CMD_def:
3761 case CMD_function:
3762 ea.arg = p;
3763 line = compile_nested_function(&ea, cctx, lines_to_free);
3764 break;
3765
3766 case CMD_return:
3767 line = compile_return(p, check_return_type,
3768 local_cmdmod.cmod_flags & CMOD_LEGACY, cctx);
3769 cctx->ctx_had_return = TRUE;
3770 break;
3771
3772 case CMD_let:
3773 emsg(_(e_cannot_use_let_in_vim9_script));
3774 break;
3775 case CMD_var:
3776 case CMD_final:
3777 case CMD_const:
3778 case CMD_increment:
3779 case CMD_decrement:
3780 line = compile_assignment(p, &ea, ea.cmdidx, cctx);
3781 if (line == p)
3782 {
3783 emsg(_(e_invalid_assignment));
3784 line = NULL;
3785 }
3786 break;
3787
3788 case CMD_unlet:
3789 case CMD_unlockvar:
3790 case CMD_lockvar:
3791 line = compile_unletlock(p, &ea, cctx);
3792 break;
3793
3794 case CMD_import:
3795 emsg(_(e_import_can_only_be_used_in_script));
3796 line = NULL;
3797 break;
3798
3799 case CMD_if:
3800 line = compile_if(p, cctx);
3801 break;
3802 case CMD_elseif:
3803 line = compile_elseif(p, cctx);
3804 cctx->ctx_had_return = FALSE;
3805 break;
3806 case CMD_else:
3807 line = compile_else(p, cctx);
3808 cctx->ctx_had_return = FALSE;
3809 break;
3810 case CMD_endif:
3811 line = compile_endif(p, cctx);
3812 break;
3813
3814 case CMD_while:
3815 line = compile_while(p, cctx);
3816 break;
3817 case CMD_endwhile:
3818 line = compile_endwhile(p, cctx);
3819 cctx->ctx_had_return = FALSE;
3820 break;
3821
3822 case CMD_for:
3823 line = compile_for(p, cctx);
3824 break;
3825 case CMD_endfor:
3826 line = compile_endfor(p, cctx);
3827 cctx->ctx_had_return = FALSE;
3828 break;
3829 case CMD_continue:
3830 line = compile_continue(p, cctx);
3831 break;
3832 case CMD_break:
3833 line = compile_break(p, cctx);
3834 break;
3835
3836 case CMD_try:
3837 line = compile_try(p, cctx);
3838 break;
3839 case CMD_catch:
3840 line = compile_catch(p, cctx);
3841 cctx->ctx_had_return = FALSE;
3842 break;
3843 case CMD_finally:
3844 line = compile_finally(p, cctx);
3845 cctx->ctx_had_return = FALSE;
3846 break;
3847 case CMD_endtry:
3848 line = compile_endtry(p, cctx);
3849 break;
3850 case CMD_throw:
3851 line = compile_throw(p, cctx);
3852 cctx->ctx_had_throw = TRUE;
3853 break;
3854
3855 case CMD_eval:
3856 line = compile_eval(p, cctx);
3857 break;
3858
3859 case CMD_defer:
3860 line = compile_defer(p, cctx);
3861 break;
3862
3863#ifdef HAS_MESSAGE_WINDOW
3864 case CMD_echowindow:
3865 {
3866 long cmd_count = get_cmd_count(line, &ea);
3867 if (cmd_count < 0)
3868 line = NULL;
3869 else
3870 line = compile_mult_expr(p, ea.cmdidx,
3871 cmd_count, cctx);
3872 }
3873 break;
3874#endif
3875 case CMD_echo:
3876 case CMD_echon:
3877 case CMD_echoconsole:
3878 case CMD_echoerr:
3879 case CMD_echomsg:
3880 case CMD_execute:
3881 line = compile_mult_expr(p, ea.cmdidx, 0, cctx);
3882 break;
3883
3884 case CMD_put:
3885 ea.cmd = cmd;
3886 line = compile_put(p, &ea, cctx);
3887 break;
3888
3889 case CMD_substitute:
3890 if (check_global_and_subst(ea.cmd, p) == FAIL)
3891 return FAIL;
3892 if (cctx->ctx_skip == SKIP_YES)
3893 line = (char_u *)"";
3894 else
3895 {
3896 ea.arg = p;
3897 line = compile_substitute(line, &ea, cctx);
3898 }
3899 break;
3900
3901 case CMD_redir:
3902 ea.arg = p;
3903 line = compile_redir(line, &ea, cctx);
3904 break;
3905
3906 case CMD_cexpr:
3907 case CMD_lexpr:
3908 case CMD_caddexpr:
3909 case CMD_laddexpr:
3910 case CMD_cgetexpr:
3911 case CMD_lgetexpr:
3912#ifdef FEAT_QUICKFIX
3913 ea.arg = p;
3914 line = compile_cexpr(line, &ea, cctx);
3915#else
3916 ex_ni(&ea);
3917 line = NULL;
3918#endif
3919 break;
3920
3921 case CMD_append:
3922 case CMD_change:
3923 case CMD_insert:
3924 case CMD_k:
3925 case CMD_t:
3926 case CMD_xit:
3927 not_in_vim9(&ea);
3928 return FAIL;
3929
3930 case CMD_SIZE:
3931 if (cctx->ctx_skip != SKIP_YES)
3932 {
3933 semsg(_(e_invalid_command_str), ea.cmd);
3934 return FAIL;
3935 }
3936 // We don't check for a next command here.
3937 line = (char_u *)"";
3938 break;
3939
3940 case CMD_lua:
3941 case CMD_mzscheme:
3942 case CMD_perl:
3943 case CMD_py3:
3944 case CMD_python3:
3945 case CMD_python:
3946 case CMD_pythonx:
3947 case CMD_ruby:
3948 case CMD_tcl:
3949 ea.arg = p;
3950 if (vim_strchr(line, '\n') == NULL)
3951 line = compile_exec(line, &ea, cctx);
3952 else
3953 // heredoc lines have been concatenated with NL
3954 // characters in get_function_body()
3955 line = compile_script(line, cctx);
3956 break;
3957
3958 case CMD_vim9script:
3959 if (cctx->ctx_skip != SKIP_YES)
3960 {
3961 emsg(_(e_vim9script_can_only_be_used_in_script));
3962 return FAIL;
3963 }
3964 line = (char_u *)"";
3965 break;
3966
3967 case CMD_class:
3968 emsg(_(e_class_can_only_be_used_in_script));
3969 return FAIL;
3970
3971 case CMD_type:
3972 emsg(_(e_type_can_only_be_used_in_script));
3973 return FAIL;
3974
3975 case CMD_global:
3976 if (check_global_and_subst(ea.cmd, p) == FAIL)
3977 return FAIL;
3978 // FALLTHROUGH
3979 default:
3980 // Not recognized, execute with do_cmdline_cmd().
3981 ea.arg = p;
3982 line = compile_exec(line, &ea, cctx);
3983 break;
3984 }
3985nextline:
3986 if (line == NULL)
3987 return FAIL;
3988 line = skipwhite(line);
3989
3990 // Undo any command modifiers.
3991 generate_undo_cmdmods(cctx);
3992
3993 if (cctx->ctx_type_stack.ga_len < 0)
3994 {
3995 iemsg("Type stack underflow");
3996 return FAIL;
3997 }
3998 } // END of the loop over all the function body lines.
3999
4000 return OK;
4001}
4002
4003/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004004 * After ex_function() has collected all the function lines: parse and compile
4005 * the lines into instructions.
4006 * Adds the function to "def_functions".
Bram Moolenaar9e68c322020-12-25 12:38:04 +01004007 * When "check_return_type" is set then set ufunc->uf_ret_type to the type of
4008 * the return statement (used for lambda). When uf_ret_type is already set
4009 * then check that it matches.
Bram Moolenaarb2049902021-01-24 12:53:53 +01004010 * When "profiling" is true add ISN_PROF_START instructions.
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +02004011 * "outer_cctx" is set for a nested function.
Bram Moolenaar05afcee2020-03-31 23:32:31 +02004012 * This can be used recursively through compile_lambda(), which may reallocate
4013 * "def_functions".
Bram Moolenaar822ba242020-05-24 23:00:18 +02004014 * Returns OK or FAIL.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004015 */
Bram Moolenaar822ba242020-05-24 23:00:18 +02004016 int
Bram Moolenaarb2049902021-01-24 12:53:53 +01004017compile_def_function(
Bram Moolenaare99d4222021-06-13 14:01:26 +02004018 ufunc_T *ufunc,
4019 int check_return_type,
4020 compiletype_T compile_type,
4021 cctx_T *outer_cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004022{
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004023 garray_T lines_to_free;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004024 char *errormsg = NULL; // error message
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004025 cctx_T cctx;
4026 garray_T *instr;
Bram Moolenaard66960b2020-10-30 20:46:26 +01004027 int did_emsg_before = did_emsg;
Bram Moolenaar599410c2021-04-10 14:03:43 +02004028 int did_emsg_silent_before = did_emsg_silent;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004029 int ret = FAIL;
4030 sctx_T save_current_sctx = current_sctx;
Bram Moolenaarf4e8cdd2020-10-12 22:07:13 +02004031 int save_estack_compiling = estack_compiling;
Bram Moolenaardc4c2302021-04-25 13:54:42 +02004032 int save_cmod_flags = cmdmod.cmod_flags;
Bram Moolenaar25e0f582020-05-25 22:36:50 +02004033 int do_estack_push;
Bram Moolenaar6c4bfe42020-07-23 18:26:30 +02004034 int new_def_function = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004035
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004036 // allocated lines are freed at the end
4037 ga_init2(&lines_to_free, sizeof(char_u *), 50);
4038
Bram Moolenaar25e0f582020-05-25 22:36:50 +02004039 // When using a function that was compiled before: Free old instructions.
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004040 // The index is reused. Otherwise add a new entry in "def_functions".
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004041 if (ufunc->uf_dfunc_idx > 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004042 {
Bram Moolenaar09689a02020-05-09 22:50:08 +02004043 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
4044 + ufunc->uf_dfunc_idx;
Bram Moolenaar3b814af2021-06-15 10:22:17 +02004045 isn_T *instr_dest = NULL;
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02004046
4047 switch (compile_type)
4048 {
4049 case CT_PROFILE:
4050#ifdef FEAT_PROFILE
4051 instr_dest = dfunc->df_instr_prof; break;
4052#endif
4053 case CT_NONE: instr_dest = dfunc->df_instr; break;
4054 case CT_DEBUG: instr_dest = dfunc->df_instr_debug; break;
4055 }
4056 if (instr_dest != NULL)
4057 // Was compiled in this mode before: Free old instructions.
4058 delete_def_function_contents(dfunc, FALSE);
4059 ga_clear_strings(&dfunc->df_var_names);
Bram Moolenaar1d84f762022-09-03 21:35:53 +01004060 dfunc->df_defer_var_idx = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004061 }
Bram Moolenaar6c4bfe42020-07-23 18:26:30 +02004062 else
4063 {
4064 if (add_def_function(ufunc) == FAIL)
4065 return FAIL;
4066 new_def_function = TRUE;
4067 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004068
Bram Moolenaar96923b72022-03-15 15:57:04 +00004069 if ((ufunc->uf_flags & FC_CLOSURE) && outer_cctx == NULL)
4070 {
4071 semsg(_(e_compiling_closure_without_context_str),
4072 printable_func_name(ufunc));
4073 return FAIL;
4074 }
4075
Bram Moolenaar985116a2020-07-12 17:31:09 +02004076 ufunc->uf_def_status = UF_COMPILING;
4077
Bram Moolenaara80faa82020-04-12 19:37:17 +02004078 CLEAR_FIELD(cctx);
Bram Moolenaarb2049902021-01-24 12:53:53 +01004079
Bram Moolenaare99d4222021-06-13 14:01:26 +02004080 cctx.ctx_compile_type = compile_type;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004081 cctx.ctx_ufunc = ufunc;
4082 cctx.ctx_lnum = -1;
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +02004083 cctx.ctx_outer = outer_cctx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004084 ga_init2(&cctx.ctx_locals, sizeof(lvar_T), 10);
Bram Moolenaar078a4612022-01-04 15:17:03 +00004085 // Each entry on the type stack consists of two type pointers.
4086 ga_init2(&cctx.ctx_type_stack, sizeof(type2_T), 50);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004087 cctx.ctx_type_list = &ufunc->uf_type_list;
4088 ga_init2(&cctx.ctx_instr, sizeof(isn_T), 50);
4089 instr = &cctx.ctx_instr;
4090
Bram Moolenaar25e0f582020-05-25 22:36:50 +02004091 // Set the context to the function, it may be compiled when called from
4092 // another script. Set the script version to the most modern one.
4093 // The line number will be set in next_line_from_context().
4094 current_sctx = ufunc->uf_script_ctx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004095 current_sctx.sc_version = SCRIPT_VERSION_VIM9;
4096
Bram Moolenaardc4c2302021-04-25 13:54:42 +02004097 // Don't use the flag from ":legacy" here.
4098 cmdmod.cmod_flags &= ~CMOD_LEGACY;
4099
Bram Moolenaar25e0f582020-05-25 22:36:50 +02004100 // Make sure error messages are OK.
4101 do_estack_push = !estack_top_is_ufunc(ufunc, 1);
4102 if (do_estack_push)
4103 estack_push_ufunc(ufunc, 1);
Bram Moolenaarf4e8cdd2020-10-12 22:07:13 +02004104 estack_compiling = TRUE;
Bram Moolenaar25e0f582020-05-25 22:36:50 +02004105
Bram Moolenaar9a015112021-12-31 14:06:45 +00004106 if (check_args_shadowing(ufunc, &cctx) == FAIL)
4107 goto erret;
4108
Yegappan Lakshmananf6c1fb22024-04-25 21:30:56 +02004109 // For an object method and a constructor generate instructions to
4110 // initialize "this" and the object variables.
Bram Moolenaar574950d2023-01-03 19:08:50 +00004111 if (ufunc->uf_flags & (FC_OBJECT|FC_NEW))
Yegappan Lakshmananf6c1fb22024-04-25 21:30:56 +02004112 if (obj_method_prologue(ufunc, &cctx) == FAIL)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004113 goto erret;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004114
Bram Moolenaar170fcfc2020-02-06 17:51:35 +01004115 if (ufunc->uf_def_args.ga_len > 0)
Yegappan Lakshmananf6c1fb22024-04-25 21:30:56 +02004116 if (compile_def_function_default_args(ufunc, &cctx, instr) == FAIL)
4117 goto erret;
Bram Moolenaare28d9b32021-07-03 18:56:53 +02004118 ufunc->uf_args_visible = ufunc->uf_args.ga_len;
Bram Moolenaar170fcfc2020-02-06 17:51:35 +01004119
Bram Moolenaarb8bebd02023-01-30 20:24:23 +00004120 // Compiling a function in an interface is done to get the function type.
4121 // No code is actually compiled.
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01004122 if (ufunc->uf_class != NULL && IS_INTERFACE(ufunc->uf_class))
Bram Moolenaarb8bebd02023-01-30 20:24:23 +00004123 {
4124 ufunc->uf_def_status = UF_NOT_COMPILED;
4125 ret = OK;
4126 goto erret;
4127 }
4128
Yegappan Lakshmananf6c1fb22024-04-25 21:30:56 +02004129 // compile the function body
Yegappan Lakshmanana16f2512024-04-23 20:14:46 +02004130 if (compile_def_function_body(&cctx, ufunc->uf_lines.ga_len,
4131 check_return_type, &lines_to_free, &errormsg) == FAIL)
4132 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004133
4134 if (cctx.ctx_scope != NULL)
4135 {
4136 if (cctx.ctx_scope->se_type == IF_SCOPE)
Bram Moolenaar1a992222021-12-31 17:25:48 +00004137 emsg(_(e_missing_endif));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004138 else if (cctx.ctx_scope->se_type == WHILE_SCOPE)
Bram Moolenaar1a992222021-12-31 17:25:48 +00004139 emsg(_(e_missing_endwhile));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004140 else if (cctx.ctx_scope->se_type == FOR_SCOPE)
Bram Moolenaar1a992222021-12-31 17:25:48 +00004141 emsg(_(e_missing_endfor));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004142 else
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004143 emsg(_(e_missing_rcurly));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004144 goto erret;
4145 }
4146
Bram Moolenaara2c00282023-05-14 22:05:15 +01004147 // TODO: if a function ends in "throw" but there was a return elsewhere we
4148 // should not assume the return type is "void".
4149 if (!cctx.ctx_had_return && !cctx.ctx_had_throw)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004150 {
Bram Moolenaare6174fd2021-06-12 18:30:56 +02004151 if (ufunc->uf_ret_type->tt_type == VAR_UNKNOWN)
4152 ufunc->uf_ret_type = &t_void;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004153 else if (ufunc->uf_ret_type->tt_type != VAR_VOID
Yegappan Lakshmanan1db15142023-09-19 20:34:05 +02004154 && !IS_CONSTRUCTOR_METHOD(ufunc))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004155 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004156 emsg(_(e_missing_return_statement));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004157 goto erret;
4158 }
4159
Bram Moolenaarf57b43c2021-06-15 22:13:27 +02004160 // Return void if there is no return at the end.
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004161 // For a constructor return the object.
Yegappan Lakshmanan1db15142023-09-19 20:34:05 +02004162 if (IS_CONSTRUCTOR_METHOD(ufunc))
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00004163 {
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004164 generate_instr(&cctx, ISN_RETURN_OBJECT);
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00004165 ufunc->uf_ret_type = &ufunc->uf_class->class_object_type;
4166 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004167 else
4168 generate_instr(&cctx, ISN_RETURN_VOID);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004169 }
4170
Bram Moolenaar599410c2021-04-10 14:03:43 +02004171 // When compiled with ":silent!" and there was an error don't consider the
4172 // function compiled.
4173 if (emsg_silent == 0 || did_emsg_silent == did_emsg_silent_before)
Bram Moolenaar05afcee2020-03-31 23:32:31 +02004174 {
4175 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
4176 + ufunc->uf_dfunc_idx;
4177 dfunc->df_deleted = FALSE;
Bram Moolenaar4aab88d2020-12-24 21:56:41 +01004178 dfunc->df_script_seq = current_sctx.sc_seq;
Bram Moolenaarf002a412021-01-24 13:34:18 +01004179#ifdef FEAT_PROFILE
Bram Moolenaare99d4222021-06-13 14:01:26 +02004180 if (cctx.ctx_compile_type == CT_PROFILE)
Bram Moolenaarb2049902021-01-24 12:53:53 +01004181 {
4182 dfunc->df_instr_prof = instr->ga_data;
4183 dfunc->df_instr_prof_count = instr->ga_len;
4184 }
4185 else
Bram Moolenaarf002a412021-01-24 13:34:18 +01004186#endif
Bram Moolenaare99d4222021-06-13 14:01:26 +02004187 if (cctx.ctx_compile_type == CT_DEBUG)
4188 {
4189 dfunc->df_instr_debug = instr->ga_data;
4190 dfunc->df_instr_debug_count = instr->ga_len;
4191 }
4192 else
Bram Moolenaarb2049902021-01-24 12:53:53 +01004193 {
4194 dfunc->df_instr = instr->ga_data;
4195 dfunc->df_instr_count = instr->ga_len;
4196 }
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02004197 dfunc->df_varcount = dfunc->df_var_names.ga_len;
Bram Moolenaar148ce7a2020-09-23 21:57:23 +02004198 dfunc->df_has_closure = cctx.ctx_has_closure;
Bram Moolenaarb46c0832022-09-15 17:19:37 +01004199
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +02004200 if (cctx.ctx_outer_used)
Bram Moolenaarb46c0832022-09-15 17:19:37 +01004201 {
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +02004202 ufunc->uf_flags |= FC_CLOSURE;
Bram Moolenaarb46c0832022-09-15 17:19:37 +01004203 if (outer_cctx != NULL)
4204 ++outer_cctx->ctx_closure_count;
4205 }
4206
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004207 ufunc->uf_def_status = UF_COMPILED;
Bram Moolenaar05afcee2020-03-31 23:32:31 +02004208 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004209
4210 ret = OK;
4211
4212erret:
Bram Moolenaar599410c2021-04-10 14:03:43 +02004213 if (ufunc->uf_def_status == UF_COMPILING)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004214 {
Bram Moolenaar05afcee2020-03-31 23:32:31 +02004215 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
4216 + ufunc->uf_dfunc_idx;
Bram Moolenaar20431c92020-03-20 18:39:46 +01004217
Bram Moolenaarcaf1a2f2021-06-15 11:27:21 +02004218 // Compiling aborted, free the generated instructions.
Bram Moolenaar8238f082021-04-20 21:10:48 +02004219 clear_instr_ga(instr);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01004220 VIM_CLEAR(dfunc->df_name);
Bram Moolenaarcaf1a2f2021-06-15 11:27:21 +02004221 ga_clear_strings(&dfunc->df_var_names);
Bram Moolenaar20431c92020-03-20 18:39:46 +01004222
Bram Moolenaar6c4bfe42020-07-23 18:26:30 +02004223 // If using the last entry in the table and it was added above, we
4224 // might as well remove it.
4225 if (!dfunc->df_deleted && new_def_function
Bram Moolenaar45a15082020-05-25 00:28:33 +02004226 && ufunc->uf_dfunc_idx == def_functions.ga_len - 1)
Bram Moolenaar6c4bfe42020-07-23 18:26:30 +02004227 {
Bram Moolenaar20431c92020-03-20 18:39:46 +01004228 --def_functions.ga_len;
Bram Moolenaar6c4bfe42020-07-23 18:26:30 +02004229 ufunc->uf_dfunc_idx = 0;
4230 }
Bram Moolenaar701cc6c2021-04-10 13:33:48 +02004231 ufunc->uf_def_status = UF_COMPILE_ERROR;
Bram Moolenaar20431c92020-03-20 18:39:46 +01004232
Bram Moolenaar3cca2992020-04-02 22:57:36 +02004233 while (cctx.ctx_scope != NULL)
4234 drop_scope(&cctx);
4235
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004236 if (errormsg != NULL)
4237 emsg(errormsg);
Bram Moolenaard66960b2020-10-30 20:46:26 +01004238 else if (did_emsg == did_emsg_before)
Bram Moolenaare13bdec2020-10-16 23:16:47 +02004239 emsg(_(e_compiling_def_function_failed));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004240 }
4241
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004242 if (cctx.ctx_redir_lhs.lhs_name != NULL)
4243 {
4244 if (ret == OK)
4245 {
4246 emsg(_(e_missing_redir_end));
4247 ret = FAIL;
4248 }
4249 vim_free(cctx.ctx_redir_lhs.lhs_name);
Bram Moolenaar753bcf82021-04-21 14:24:24 +02004250 vim_free(cctx.ctx_redir_lhs.lhs_whole);
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004251 }
4252
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004253 current_sctx = save_current_sctx;
Bram Moolenaarf4e8cdd2020-10-12 22:07:13 +02004254 estack_compiling = save_estack_compiling;
Bram Moolenaardc4c2302021-04-25 13:54:42 +02004255 cmdmod.cmod_flags = save_cmod_flags;
Bram Moolenaar25e0f582020-05-25 22:36:50 +02004256 if (do_estack_push)
4257 estack_pop();
4258
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004259 ga_clear_strings(&lines_to_free);
Bram Moolenaarb84a3812020-05-01 15:44:29 +02004260 free_locals(&cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004261 ga_clear(&cctx.ctx_type_stack);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004262 return ret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004263}
4264
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004265 void
4266set_function_type(ufunc_T *ufunc)
4267{
4268 int varargs = ufunc->uf_va_name != NULL;
4269 int argcount = ufunc->uf_args.ga_len;
4270
4271 // Create a type for the function, with the return type and any
4272 // argument types.
4273 // A vararg is included in uf_args.ga_len but not in uf_arg_types.
4274 // The type is included in "tt_args".
4275 if (argcount > 0 || varargs)
4276 {
Bram Moolenaar18062fc2021-03-05 21:35:47 +01004277 if (ufunc->uf_type_list.ga_itemsize == 0)
4278 ga_init2(&ufunc->uf_type_list, sizeof(type_T *), 10);
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004279 ufunc->uf_func_type = alloc_func_type(ufunc->uf_ret_type,
4280 argcount, &ufunc->uf_type_list);
4281 // Add argument types to the function type.
4282 if (func_type_add_arg_types(ufunc->uf_func_type,
4283 argcount + varargs,
4284 &ufunc->uf_type_list) == FAIL)
4285 return;
4286 ufunc->uf_func_type->tt_argcount = argcount + varargs;
4287 ufunc->uf_func_type->tt_min_argcount =
4288 argcount - ufunc->uf_def_args.ga_len;
4289 if (ufunc->uf_arg_types == NULL)
4290 {
4291 int i;
4292
4293 // lambda does not have argument types.
4294 for (i = 0; i < argcount; ++i)
4295 ufunc->uf_func_type->tt_args[i] = &t_any;
4296 }
4297 else
4298 mch_memmove(ufunc->uf_func_type->tt_args,
4299 ufunc->uf_arg_types, sizeof(type_T *) * argcount);
4300 if (varargs)
4301 {
4302 ufunc->uf_func_type->tt_args[argcount] =
Bram Moolenaar2a389082021-04-09 20:24:31 +02004303 ufunc->uf_va_type == NULL ? &t_list_any : ufunc->uf_va_type;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004304 ufunc->uf_func_type->tt_flags = TTFLAG_VARARGS;
4305 }
4306 }
4307 else
4308 // No arguments, can use a predefined type.
4309 ufunc->uf_func_type = get_func_type(ufunc->uf_ret_type,
4310 argcount, &ufunc->uf_type_list);
4311}
4312
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004313/*
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01004314 * Free all instructions for "dfunc" except df_name.
Bram Moolenaar20431c92020-03-20 18:39:46 +01004315 */
4316 static void
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004317delete_def_function_contents(dfunc_T *dfunc, int mark_deleted)
Bram Moolenaar20431c92020-03-20 18:39:46 +01004318{
4319 int idx;
4320
Bram Moolenaard505d172022-12-18 21:42:55 +00004321 // In same cases the instructions may refer to a class in which the
4322 // function is defined and unreferencing the class may call back here
4323 // recursively. Set the df_delete_busy to avoid problems.
4324 if (dfunc->df_delete_busy)
4325 return;
4326 dfunc->df_delete_busy = TRUE;
4327
Bram Moolenaar20431c92020-03-20 18:39:46 +01004328 ga_clear(&dfunc->df_def_args_isn);
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02004329 ga_clear_strings(&dfunc->df_var_names);
Bram Moolenaar20431c92020-03-20 18:39:46 +01004330
4331 if (dfunc->df_instr != NULL)
4332 {
4333 for (idx = 0; idx < dfunc->df_instr_count; ++idx)
4334 delete_instr(dfunc->df_instr + idx);
4335 VIM_CLEAR(dfunc->df_instr);
4336 }
Bram Moolenaarc2dec4c2021-06-13 15:39:00 +02004337 if (dfunc->df_instr_debug != NULL)
4338 {
4339 for (idx = 0; idx < dfunc->df_instr_debug_count; ++idx)
4340 delete_instr(dfunc->df_instr_debug + idx);
4341 VIM_CLEAR(dfunc->df_instr_debug);
Bram Moolenaarc2dec4c2021-06-13 15:39:00 +02004342 }
Bram Moolenaarc05fe072021-01-24 21:30:48 +01004343#ifdef FEAT_PROFILE
4344 if (dfunc->df_instr_prof != NULL)
4345 {
4346 for (idx = 0; idx < dfunc->df_instr_prof_count; ++idx)
4347 delete_instr(dfunc->df_instr_prof + idx);
4348 VIM_CLEAR(dfunc->df_instr_prof);
Bram Moolenaarc05fe072021-01-24 21:30:48 +01004349 }
4350#endif
Bram Moolenaar20431c92020-03-20 18:39:46 +01004351
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004352 if (mark_deleted)
4353 dfunc->df_deleted = TRUE;
4354 if (dfunc->df_ufunc != NULL)
4355 dfunc->df_ufunc->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaard505d172022-12-18 21:42:55 +00004356
4357 dfunc->df_delete_busy = FALSE;
Bram Moolenaar20431c92020-03-20 18:39:46 +01004358}
4359
4360/*
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004361 * When a user function is deleted, clear the contents of any associated def
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01004362 * function, unless another user function still uses it.
4363 * The position in def_functions can be re-used.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004364 */
4365 void
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01004366unlink_def_function(ufunc_T *ufunc)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004367{
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00004368 if (ufunc->uf_dfunc_idx <= 0)
4369 return;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004370
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00004371 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
4372 + ufunc->uf_dfunc_idx;
4373
4374 if (--dfunc->df_refcount <= 0)
4375 delete_def_function_contents(dfunc, TRUE);
4376 ufunc->uf_def_status = UF_NOT_COMPILED;
4377 ufunc->uf_dfunc_idx = 0;
4378 if (dfunc->df_ufunc == ufunc)
4379 dfunc->df_ufunc = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004380}
4381
Bram Moolenaarfdeab652020-09-19 15:16:50 +02004382/*
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01004383 * Used when a user function refers to an existing dfunc.
Bram Moolenaarfdeab652020-09-19 15:16:50 +02004384 */
4385 void
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01004386link_def_function(ufunc_T *ufunc)
Bram Moolenaarfdeab652020-09-19 15:16:50 +02004387{
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00004388 if (ufunc->uf_dfunc_idx <= 0)
4389 return;
Bram Moolenaarfdeab652020-09-19 15:16:50 +02004390
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00004391 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
4392 + ufunc->uf_dfunc_idx;
4393
4394 ++dfunc->df_refcount;
Bram Moolenaarfdeab652020-09-19 15:16:50 +02004395}
4396
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004397#if defined(EXITFREE) || defined(PROTO)
Bram Moolenaar20431c92020-03-20 18:39:46 +01004398/*
4399 * Free all functions defined with ":def".
4400 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004401 void
4402free_def_functions(void)
4403{
Bram Moolenaar20431c92020-03-20 18:39:46 +01004404 int idx;
4405
4406 for (idx = 0; idx < def_functions.ga_len; ++idx)
4407 {
4408 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data) + idx;
4409
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004410 delete_def_function_contents(dfunc, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01004411 vim_free(dfunc->df_name);
Bram Moolenaar20431c92020-03-20 18:39:46 +01004412 }
4413
4414 ga_clear(&def_functions);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004415}
4416#endif
4417
4418
4419#endif // FEAT_EVAL