blob: d6faa7bb9751f4f997910be22f195ab88f2111e2 [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;
1225 may_generate_2STRING(-1, TRUE, cctx);
1226
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:
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02001370 res = compile_load_scriptvar(cctx,
Bram Moolenaard0132f42022-05-12 11:05:40 +01001371 name + (name[1] == ':' ? 2 : 0), NULL, NULL);
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001372 break;
1373 case dest_env:
1374 // Include $ in the name here
1375 generate_LOAD(cctx, ISN_LOADENV, 0, name, type);
1376 break;
1377 case dest_reg:
1378 generate_LOAD(cctx, ISN_LOADREG, name[1], NULL, &t_string);
1379 break;
1380 case dest_vimvar:
Bram Moolenaarc3caa7f2022-05-25 19:15:10 +01001381 generate_LOADV(cctx, name + 2);
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001382 break;
1383 case dest_local:
Bram Moolenaar4875d6a2022-08-17 15:55:51 +01001384 if (cctx->ctx_skip != SKIP_YES)
1385 {
Bram Moolenaard505d172022-12-18 21:42:55 +00001386 lvar_T *lvar = lhs->lhs_lvar;
Bram Moolenaar4875d6a2022-08-17 15:55:51 +01001387 if (lvar->lv_from_outer > 0)
1388 generate_LOADOUTER(cctx, lvar->lv_idx, lvar->lv_from_outer,
Bram Moolenaar65449bd2022-09-19 16:02:43 +01001389 lvar->lv_loop_depth, lvar->lv_loop_idx, type);
Bram Moolenaar4875d6a2022-08-17 15:55:51 +01001390 else
1391 generate_LOAD(cctx, ISN_LOAD, lvar->lv_idx, NULL, type);
1392 }
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001393 break;
Bram Moolenaard505d172022-12-18 21:42:55 +00001394 case dest_class_member:
1395 generate_CLASSMEMBER(cctx, TRUE, lhs->lhs_class,
1396 lhs->lhs_classmember_idx);
1397 break;
Bram Moolenaardc234ca2020-11-28 18:52:33 +01001398 case dest_expr:
1399 // list or dict value should already be on the stack.
1400 break;
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001401 }
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02001402
1403 return res;
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001404}
1405
Bram Moolenaardc234ca2020-11-28 18:52:33 +01001406/*
1407 * Skip over "[expr]" or ".member".
1408 * Does not check for any errors.
1409 */
1410 static char_u *
1411skip_index(char_u *start)
1412{
1413 char_u *p = start;
1414
1415 if (*p == '[')
1416 {
1417 p = skipwhite(p + 1);
1418 (void)skip_expr(&p, NULL);
1419 p = skipwhite(p);
1420 if (*p == ']')
1421 return p + 1;
1422 return p;
1423 }
1424 // if (*p == '.')
1425 return to_name_end(p + 1, TRUE);
1426}
1427
Bram Moolenaare55b1c02020-06-21 15:52:59 +02001428 void
1429vim9_declare_error(char_u *name)
1430{
1431 char *scope = "";
1432
1433 switch (*name)
1434 {
Bram Moolenaar7fe87552020-06-21 20:38:28 +02001435 case 'g': scope = _("global"); break;
1436 case 'b': scope = _("buffer"); break;
1437 case 'w': scope = _("window"); break;
1438 case 't': scope = _("tab"); break;
1439 case 'v': scope = "v:"; break;
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00001440 case '$': semsg(_(e_cannot_declare_an_environment_variable_str), name);
Bram Moolenaarc2ee44c2020-08-02 16:59:00 +02001441 return;
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00001442 case '&': semsg(_(e_cannot_declare_an_option_str), name);
Bram Moolenaarc2ee44c2020-08-02 16:59:00 +02001443 return;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001444 case '@': semsg(_(e_cannot_declare_a_register_str), name);
Bram Moolenaarc2ee44c2020-08-02 16:59:00 +02001445 return;
Bram Moolenaar7fe87552020-06-21 20:38:28 +02001446 default: return;
Bram Moolenaare55b1c02020-06-21 15:52:59 +02001447 }
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00001448 semsg(_(e_cannot_declare_a_scope_variable_str), scope, name);
Bram Moolenaare55b1c02020-06-21 15:52:59 +02001449}
1450
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02001451/*
Bram Moolenaar3558afe2022-10-13 16:12:57 +01001452 * Return TRUE if "name" is a valid register to use.
1453 * Return FALSE and give an error message if not.
1454 */
1455 static int
1456valid_dest_reg(int name)
1457{
1458 if ((name == '@' || valid_yank_reg(name, FALSE)) && name != '.')
1459 return TRUE;
1460 emsg_invreg(name);
1461 return FAIL;
1462}
1463
1464/*
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001465 * For one assignment figure out the type of destination. Return it in "dest".
1466 * When not recognized "dest" is not set.
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001467 * For an option "option_scope" is set.
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001468 * For a v:var "vimvaridx" is set.
1469 * "type" is set to the destination type if known, unchanted otherwise.
1470 * Return FAIL if an error message was given.
1471 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +00001472 int
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001473get_var_dest(
1474 char_u *name,
1475 assign_dest_T *dest,
Bram Moolenaar97f8c102022-04-02 19:43:57 +01001476 cmdidx_T cmdidx,
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001477 int *option_scope,
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001478 int *vimvaridx,
1479 type_T **type,
1480 cctx_T *cctx)
1481{
1482 char_u *p;
1483
1484 if (*name == '&')
1485 {
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001486 int cc;
1487 long numval;
1488 getoption_T opt_type;
Bram Moolenaardcb53be2021-12-09 14:23:43 +00001489 int opt_p_flags;
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001490
1491 *dest = dest_option;
1492 if (cmdidx == CMD_final || cmdidx == CMD_const)
1493 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00001494 emsg(_(e_cannot_lock_option));
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001495 return FAIL;
1496 }
1497 p = name;
Yegappan Lakshmanan64095532021-12-06 11:03:55 +00001498 p = find_option_end(&p, option_scope);
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001499 if (p == NULL)
1500 {
1501 // cannot happen?
Bram Moolenaar108010a2021-06-27 22:03:33 +02001502 emsg(_(e_unexpected_characters_in_assignment));
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001503 return FAIL;
1504 }
1505 cc = *p;
1506 *p = NUL;
1507 opt_type = get_option_value(skip_option_env_lead(name),
Bram Moolenaardcb53be2021-12-09 14:23:43 +00001508 &numval, NULL, &opt_p_flags, *option_scope);
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001509 *p = cc;
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001510 switch (opt_type)
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001511 {
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001512 case gov_unknown:
Bram Moolenaare1242042021-12-16 20:56:57 +00001513 semsg(_(e_unknown_option_str), name);
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001514 return FAIL;
1515 case gov_string:
1516 case gov_hidden_string:
Bram Moolenaardcb53be2021-12-09 14:23:43 +00001517 if (opt_p_flags & P_FUNC)
1518 {
1519 // might be a Funcref, check the type later
1520 *type = &t_any;
1521 *dest = dest_func_option;
1522 }
1523 else
1524 {
1525 *type = &t_string;
1526 }
Bram Moolenaardd1f4262020-12-31 17:41:01 +01001527 break;
1528 case gov_bool:
1529 case gov_hidden_bool:
1530 *type = &t_bool;
1531 break;
1532 case gov_number:
1533 case gov_hidden_number:
1534 *type = &t_number;
1535 break;
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001536 }
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001537 }
1538 else if (*name == '$')
1539 {
1540 *dest = dest_env;
1541 *type = &t_string;
1542 }
1543 else if (*name == '@')
1544 {
Bram Moolenaar3558afe2022-10-13 16:12:57 +01001545 if (!valid_dest_reg(name[1]))
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001546 return FAIL;
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001547 *dest = dest_reg;
Bram Moolenaar74f4a962021-06-17 21:03:07 +02001548 *type = name[1] == '#' ? &t_number_or_string : &t_string;
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01001549 }
1550 else if (STRNCMP(name, "g:", 2) == 0)
1551 {
1552 *dest = dest_global;
1553 }
1554 else if (STRNCMP(name, "b:", 2) == 0)
1555 {
1556 *dest = dest_buffer;
1557 }
1558 else if (STRNCMP(name, "w:", 2) == 0)
1559 {
1560 *dest = dest_window;
1561 }
1562 else if (STRNCMP(name, "t:", 2) == 0)
1563 {
1564 *dest = dest_tab;
1565 }
1566 else if (STRNCMP(name, "v:", 2) == 0)
1567 {
1568 typval_T *vtv;
1569 int di_flags;
1570
1571 *vimvaridx = find_vim_var(name + 2, &di_flags);
1572 if (*vimvaridx < 0)
1573 {
1574 semsg(_(e_variable_not_found_str), name);
1575 return FAIL;
1576 }
1577 // We use the current value of "sandbox" here, is that OK?
1578 if (var_check_ro(di_flags, name, FALSE))
1579 return FAIL;
1580 *dest = dest_vimvar;
1581 vtv = get_vim_var_tv(*vimvaridx);
1582 *type = typval2type_vimvar(vtv, cctx->ctx_type_list);
1583 }
1584 return OK;
1585}
1586
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02001587 static int
Bram Moolenaar97f8c102022-04-02 19:43:57 +01001588is_decl_command(cmdidx_T cmdidx)
Bram Moolenaar752fc692021-01-04 21:57:11 +01001589{
1590 return cmdidx == CMD_let || cmdidx == CMD_var
1591 || cmdidx == CMD_final || cmdidx == CMD_const;
1592}
1593
1594/*
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02001595 * Returns TRUE if the class or object variable in "lhs" is modifiable.
1596 * "var_start" points to the start of the variable name and "lhs->lhs_varlen"
1597 * has the total length. Note that the "lhs" can be nested an object reference
1598 * (e.g. a.b.c.d.var).
1599 */
1600 static int
1601lhs_class_member_modifiable(lhs_T *lhs, char_u *var_start, cctx_T *cctx)
1602{
1603 size_t varlen = lhs->lhs_varlen;
1604 class_T *cl = lhs->lhs_type->tt_class;
1605 int is_object = lhs->lhs_type->tt_type == VAR_OBJECT;
1606 char_u *name = var_start + varlen + 1;
1607 size_t namelen = lhs->lhs_end - var_start - varlen - 1;
1608 ocmember_T *m;
1609
1610 m = member_lookup(cl, lhs->lhs_type->tt_type, name, namelen, NULL);
1611 if (m == NULL)
1612 {
1613 member_not_found_msg(cl, lhs->lhs_type->tt_type, name, namelen);
1614 return FALSE;
1615 }
1616
1617 // If it is private member variable, then accessing it outside the
1618 // class is not allowed.
1619 // If it is a read only class variable, then it can be modified
1620 // only inside the class where it is defined.
1621 if ((m->ocm_access != VIM_ACCESS_ALL) &&
1622 ((is_object && !inside_class(cctx, cl))
1623 || (!is_object && cctx->ctx_ufunc->uf_class != cl)))
1624 {
1625 char *msg = (m->ocm_access == VIM_ACCESS_PRIVATE)
Ernie Rael03042a22023-11-11 08:53:32 +01001626 ? e_cannot_access_protected_variable_str
RestorerZ7fe8f432023-09-24 23:21:24 +02001627 : e_variable_is_not_writable_str;
Ernie Raele6c9aa52023-10-06 19:55:52 +02001628 emsg_var_cl_define(msg, m->ocm_name, 0, cl);
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02001629 return FALSE;
1630 }
1631
1632 return TRUE;
1633}
1634
1635/*
Bram Moolenaar752fc692021-01-04 21:57:11 +01001636 * Figure out the LHS type and other properties for an assignment or one item
1637 * of ":unlet" with an index.
1638 * Returns OK or FAIL.
1639 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +00001640 int
Bram Moolenaar752fc692021-01-04 21:57:11 +01001641compile_lhs(
Bram Moolenaar97f8c102022-04-02 19:43:57 +01001642 char_u *var_start,
1643 lhs_T *lhs,
1644 cmdidx_T cmdidx,
1645 int heredoc,
1646 int has_cmd, // "var" before "var_start"
1647 int oplen,
1648 cctx_T *cctx)
Bram Moolenaar752fc692021-01-04 21:57:11 +01001649{
1650 char_u *var_end;
1651 int is_decl = is_decl_command(cmdidx);
1652
1653 CLEAR_POINTER(lhs);
1654 lhs->lhs_dest = dest_local;
1655 lhs->lhs_vimvaridx = -1;
1656 lhs->lhs_scriptvar_idx = -1;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001657 lhs->lhs_member_idx = -1;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001658
1659 // "dest_end" is the end of the destination, including "[expr]" or
1660 // ".name".
1661 // "var_end" is the end of the variable/option/etc. name.
1662 lhs->lhs_dest_end = skip_var_one(var_start, FALSE);
1663 if (*var_start == '@')
Bram Moolenaar3558afe2022-10-13 16:12:57 +01001664 {
1665 if (!valid_dest_reg(var_start[1]))
1666 return FAIL;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001667 var_end = var_start + 2;
Bram Moolenaar3558afe2022-10-13 16:12:57 +01001668 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01001669 else
1670 {
1671 // skip over the leading "&", "&l:", "&g:" and "$"
1672 var_end = skip_option_env_lead(var_start);
1673 var_end = to_name_end(var_end, TRUE);
1674 }
1675
1676 // "a: type" is declaring variable "a" with a type, not dict "a:".
1677 if (is_decl && lhs->lhs_dest_end == var_start + 2
1678 && lhs->lhs_dest_end[-1] == ':')
1679 --lhs->lhs_dest_end;
1680 if (is_decl && var_end == var_start + 2 && var_end[-1] == ':')
1681 --var_end;
Bram Moolenaarab36e6a2021-11-30 16:14:49 +00001682 lhs->lhs_end = lhs->lhs_dest_end;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001683
1684 // compute the length of the destination without "[expr]" or ".name"
1685 lhs->lhs_varlen = var_end - var_start;
Bram Moolenaar753bcf82021-04-21 14:24:24 +02001686 lhs->lhs_varlen_total = lhs->lhs_varlen;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001687 lhs->lhs_name = vim_strnsave(var_start, lhs->lhs_varlen);
1688 if (lhs->lhs_name == NULL)
1689 return FAIL;
Bram Moolenaar08251752021-01-11 21:20:18 +01001690
1691 if (lhs->lhs_dest_end > var_start + lhs->lhs_varlen)
1692 // Something follows after the variable: "var[idx]" or "var.key".
1693 lhs->lhs_has_index = TRUE;
1694
Bram Moolenaar752fc692021-01-04 21:57:11 +01001695 if (heredoc)
1696 lhs->lhs_type = &t_list_string;
1697 else
1698 lhs->lhs_type = &t_any;
1699
1700 if (cctx->ctx_skip != SKIP_YES)
1701 {
1702 int declare_error = FALSE;
1703
1704 if (get_var_dest(lhs->lhs_name, &lhs->lhs_dest, cmdidx,
1705 &lhs->lhs_opt_flags, &lhs->lhs_vimvaridx,
1706 &lhs->lhs_type, cctx) == FAIL)
1707 return FAIL;
Bram Moolenaard877a572021-04-01 19:42:48 +02001708 if (lhs->lhs_dest != dest_local
1709 && cmdidx != CMD_const && cmdidx != CMD_final)
Bram Moolenaar752fc692021-01-04 21:57:11 +01001710 {
1711 // Specific kind of variable recognized.
1712 declare_error = is_decl;
1713 }
1714 else
1715 {
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02001716 class_T *defcl;
1717
Bram Moolenaar752fc692021-01-04 21:57:11 +01001718 // No specific kind of variable recognized, just a name.
h-east2bd6a092023-05-19 19:01:17 +01001719 if (check_reserved_name(lhs->lhs_name, lhs->lhs_has_index
1720 && *var_end == '.') == FAIL)
Bram Moolenaard0edaf92021-05-28 21:06:08 +02001721 return FAIL;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001722
1723 if (lookup_local(var_start, lhs->lhs_varlen,
1724 &lhs->lhs_local_lvar, cctx) == OK)
Bram Moolenaard505d172022-12-18 21:42:55 +00001725 {
Bram Moolenaar752fc692021-01-04 21:57:11 +01001726 lhs->lhs_lvar = &lhs->lhs_local_lvar;
Bram Moolenaard505d172022-12-18 21:42:55 +00001727 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01001728 else
1729 {
1730 CLEAR_FIELD(lhs->lhs_arg_lvar);
1731 if (arg_exists(var_start, lhs->lhs_varlen,
1732 &lhs->lhs_arg_lvar.lv_idx, &lhs->lhs_arg_lvar.lv_type,
1733 &lhs->lhs_arg_lvar.lv_from_outer, cctx) == OK)
1734 {
1735 if (is_decl)
1736 {
1737 semsg(_(e_str_is_used_as_argument), lhs->lhs_name);
1738 return FAIL;
1739 }
1740 lhs->lhs_lvar = &lhs->lhs_arg_lvar;
1741 }
1742 }
Bram Moolenaard505d172022-12-18 21:42:55 +00001743
Bram Moolenaar752fc692021-01-04 21:57:11 +01001744 if (lhs->lhs_lvar != NULL)
1745 {
1746 if (is_decl)
1747 {
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02001748 // if we come here with what looks like an assignment like
Yegappan Lakshmananb5a07192023-10-05 20:14:43 +02001749 // .= but which has been rejected by assignment_len() from
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02001750 // may_compile_assignment give a better error message
Christian Brabandt504543f2023-09-11 20:08:50 +02001751 char_u *p = skipwhite(lhs->lhs_end);
1752 if (p[0] == '.' && p[1] == '=')
1753 emsg(_(e_dot_equal_not_supported_with_script_version_two));
Yegappan Lakshmananb5a07192023-10-05 20:14:43 +02001754 else if (p[0] == ':')
1755 // type specified in a non-var assignment
1756 semsg(_(e_trailing_characters_str), p);
Christian Brabandt504543f2023-09-11 20:08:50 +02001757 else
1758 semsg(_(e_variable_already_declared_str), lhs->lhs_name);
Bram Moolenaar752fc692021-01-04 21:57:11 +01001759 return FAIL;
1760 }
1761 }
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02001762 else if ((lhs->lhs_classmember_idx = cctx_class_member_idx(
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02001763 cctx, var_start, lhs->lhs_varlen, &defcl)) >= 0)
Bram Moolenaard505d172022-12-18 21:42:55 +00001764 {
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02001765 if (cctx->ctx_ufunc->uf_defclass != defcl)
1766 {
1767 // A class variable can be accessed without the class name
1768 // only inside a class.
RestorerZ7fe8f432023-09-24 23:21:24 +02001769 semsg(_(e_class_variable_str_accessible_only_inside_class_str),
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02001770 lhs->lhs_name, defcl->class_name);
1771 return FAIL;
1772 }
Bram Moolenaar6acf7572023-01-01 19:53:30 +00001773 if (is_decl)
1774 {
1775 semsg(_(e_variable_already_declared_in_class_str),
1776 lhs->lhs_name);
1777 return FAIL;
1778 }
Yegappan Lakshmanane5437c52023-12-16 14:11:19 +01001779
1780 ocmember_T *m =
1781 &defcl->class_class_members[lhs->lhs_classmember_idx];
1782 if (oc_var_check_ro(defcl, m))
1783 return FAIL;
1784
Bram Moolenaard505d172022-12-18 21:42:55 +00001785 lhs->lhs_dest = dest_class_member;
1786 lhs->lhs_class = cctx->ctx_ufunc->uf_class;
Yegappan Lakshmananfe7b20a2023-10-04 19:47:52 +02001787 lhs->lhs_type =
Yegappan Lakshmanan1ea42882023-10-11 21:43:52 +02001788 oc_member_type_by_idx(cctx->ctx_ufunc->uf_class,
Yegappan Lakshmananfe7b20a2023-10-04 19:47:52 +02001789 FALSE, lhs->lhs_classmember_idx);
Bram Moolenaard505d172022-12-18 21:42:55 +00001790 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01001791 else
1792 {
1793 int script_namespace = lhs->lhs_varlen > 1
1794 && STRNCMP(var_start, "s:", 2) == 0;
1795 int script_var = (script_namespace
1796 ? script_var_exists(var_start + 2, lhs->lhs_varlen - 2,
Bram Moolenaardce24412022-02-08 20:35:30 +00001797 cctx, NULL)
Bram Moolenaar752fc692021-01-04 21:57:11 +01001798 : script_var_exists(var_start, lhs->lhs_varlen,
Bram Moolenaardce24412022-02-08 20:35:30 +00001799 cctx, NULL)) == OK;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001800 imported_T *import =
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00001801 find_imported(var_start, lhs->lhs_varlen, FALSE);
Bram Moolenaar752fc692021-01-04 21:57:11 +01001802
1803 if (script_namespace || script_var || import != NULL)
1804 {
1805 char_u *rawname = lhs->lhs_name
1806 + (lhs->lhs_name[1] == ':' ? 2 : 0);
1807
Bram Moolenaarafa048f2022-02-22 20:43:36 +00001808 if (script_namespace && current_script_is_vim9())
1809 {
1810 semsg(_(e_cannot_use_s_colon_in_vim9_script_str),
1811 var_start);
1812 return FAIL;
1813 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01001814 if (is_decl)
1815 {
1816 if (script_namespace)
Bram Moolenaara749a422022-02-12 19:52:25 +00001817 semsg(_(e_cannot_declare_script_variable_in_function_str),
Bram Moolenaar752fc692021-01-04 21:57:11 +01001818 lhs->lhs_name);
1819 else
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001820 semsg(_(e_variable_already_declared_in_script_str),
Bram Moolenaar752fc692021-01-04 21:57:11 +01001821 lhs->lhs_name);
1822 return FAIL;
1823 }
1824 else if (cctx->ctx_ufunc->uf_script_ctx_version
1825 == SCRIPT_VERSION_VIM9
1826 && script_namespace
1827 && !script_var && import == NULL)
1828 {
1829 semsg(_(e_unknown_variable_str), lhs->lhs_name);
1830 return FAIL;
1831 }
1832
1833 lhs->lhs_dest = dest_script;
1834
1835 // existing script-local variables should have a type
1836 lhs->lhs_scriptvar_sid = current_sctx.sc_sid;
1837 if (import != NULL)
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001838 {
1839 char_u *dot = vim_strchr(var_start, '.');
1840 char_u *p;
1841
1842 // for an import the name is what comes after the dot
1843 if (dot == NULL)
1844 {
1845 semsg(_(e_no_dot_after_imported_name_str),
1846 var_start);
1847 return FAIL;
1848 }
1849 p = skipwhite(dot + 1);
1850 var_end = to_name_end(p, TRUE);
1851 if (var_end == p)
1852 {
1853 semsg(_(e_missing_name_after_imported_name_str),
1854 var_start);
1855 return FAIL;
1856 }
1857 vim_free(lhs->lhs_name);
1858 lhs->lhs_varlen = var_end - p;
1859 lhs->lhs_name = vim_strnsave(p, lhs->lhs_varlen);
1860 if (lhs->lhs_name == NULL)
1861 return FAIL;
1862 rawname = lhs->lhs_name;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001863 lhs->lhs_scriptvar_sid = import->imp_sid;
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001864 // TODO: where do we check this name is exported?
1865
1866 // Check if something follows: "exp.var[idx]" or
1867 // "exp.var.key".
1868 lhs->lhs_has_index = lhs->lhs_dest_end
1869 > skipwhite(var_end);
1870 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01001871 if (SCRIPT_ID_VALID(lhs->lhs_scriptvar_sid))
1872 {
Bram Moolenaar08251752021-01-11 21:20:18 +01001873 // Check writable only when no index follows.
Bram Moolenaar752fc692021-01-04 21:57:11 +01001874 lhs->lhs_scriptvar_idx = get_script_item_idx(
Bram Moolenaar08251752021-01-11 21:20:18 +01001875 lhs->lhs_scriptvar_sid, rawname,
1876 lhs->lhs_has_index ? ASSIGN_FINAL : ASSIGN_CONST,
Bram Moolenaarb6a138e2022-02-08 21:17:22 +00001877 cctx, NULL);
Bram Moolenaar752fc692021-01-04 21:57:11 +01001878 if (lhs->lhs_scriptvar_idx >= 0)
1879 {
1880 scriptitem_T *si = SCRIPT_ITEM(
1881 lhs->lhs_scriptvar_sid);
1882 svar_T *sv =
1883 ((svar_T *)si->sn_var_vals.ga_data)
1884 + lhs->lhs_scriptvar_idx;
1885 lhs->lhs_type = sv->sv_type;
1886 }
1887 }
1888 }
Bram Moolenaardce24412022-02-08 20:35:30 +00001889 else if (check_defined(var_start, lhs->lhs_varlen, cctx,
1890 NULL, FALSE) == FAIL)
Bram Moolenaar752fc692021-01-04 21:57:11 +01001891 return FAIL;
1892 }
1893 }
1894
1895 if (declare_error)
1896 {
1897 vim9_declare_error(lhs->lhs_name);
1898 return FAIL;
1899 }
1900 }
1901
Bram Moolenaarab36e6a2021-11-30 16:14:49 +00001902 // handle "a:name" as a name, not index "name" in "a"
Bram Moolenaar752fc692021-01-04 21:57:11 +01001903 if (lhs->lhs_varlen > 1 || var_start[lhs->lhs_varlen] != ':')
1904 var_end = lhs->lhs_dest_end;
1905
Bram Moolenaardcb53be2021-12-09 14:23:43 +00001906 if (lhs->lhs_dest != dest_option && lhs->lhs_dest != dest_func_option)
Bram Moolenaar752fc692021-01-04 21:57:11 +01001907 {
Bram Moolenaarce93d162023-01-30 21:12:34 +00001908 if (is_decl && *skipwhite(var_end) == ':')
Bram Moolenaar752fc692021-01-04 21:57:11 +01001909 {
1910 char_u *p;
1911
1912 // parse optional type: "let var: type = expr"
Bram Moolenaarce93d162023-01-30 21:12:34 +00001913 if (VIM_ISWHITE(*var_end))
1914 {
1915 semsg(_(e_no_white_space_allowed_before_colon_str), var_end);
1916 return FAIL;
1917 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01001918 if (!VIM_ISWHITE(var_end[1]))
1919 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +01001920 semsg(_(e_white_space_required_after_str_str), ":", var_end);
Bram Moolenaar752fc692021-01-04 21:57:11 +01001921 return FAIL;
1922 }
1923 p = skipwhite(var_end + 1);
1924 lhs->lhs_type = parse_type(&p, cctx->ctx_type_list, TRUE);
1925 if (lhs->lhs_type == NULL)
1926 return FAIL;
1927 lhs->lhs_has_type = TRUE;
Bram Moolenaarab36e6a2021-11-30 16:14:49 +00001928 lhs->lhs_end = p;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001929 }
1930 else if (lhs->lhs_lvar != NULL)
1931 lhs->lhs_type = lhs->lhs_lvar->lv_type;
1932 }
1933
Bram Moolenaare42939a2021-04-05 17:11:17 +02001934 if (oplen == 3 && !heredoc
1935 && lhs->lhs_dest != dest_global
1936 && !lhs->lhs_has_index
1937 && lhs->lhs_type->tt_type != VAR_STRING
1938 && lhs->lhs_type->tt_type != VAR_ANY)
Bram Moolenaar752fc692021-01-04 21:57:11 +01001939 {
1940 emsg(_(e_can_only_concatenate_to_string));
1941 return FAIL;
1942 }
1943
1944 if (lhs->lhs_lvar == NULL && lhs->lhs_dest == dest_local
1945 && cctx->ctx_skip != SKIP_YES)
1946 {
1947 if (oplen > 1 && !heredoc)
1948 {
1949 // +=, /=, etc. require an existing variable
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00001950 semsg(_(e_cannot_use_operator_on_new_variable_str), lhs->lhs_name);
Bram Moolenaar752fc692021-01-04 21:57:11 +01001951 return FAIL;
1952 }
Bram Moolenaar97f8c102022-04-02 19:43:57 +01001953 if (!is_decl || (lhs->lhs_has_index && !has_cmd
1954 && cctx->ctx_skip != SKIP_YES))
Bram Moolenaar752fc692021-01-04 21:57:11 +01001955 {
1956 semsg(_(e_unknown_variable_str), lhs->lhs_name);
1957 return FAIL;
1958 }
1959
Bram Moolenaar3f327882021-03-17 20:56:38 +01001960 // Check the name is valid for a funcref.
Bram Moolenaar752fc692021-01-04 21:57:11 +01001961 if ((lhs->lhs_type->tt_type == VAR_FUNC
1962 || lhs->lhs_type->tt_type == VAR_PARTIAL)
Bram Moolenaar3f327882021-03-17 20:56:38 +01001963 && var_wrong_func_name(lhs->lhs_name, TRUE))
Bram Moolenaar752fc692021-01-04 21:57:11 +01001964 return FAIL;
Bram Moolenaar3f327882021-03-17 20:56:38 +01001965
1966 // New local variable.
Bram Moolenaar6586a012022-09-30 11:04:50 +01001967 int assign = cmdidx == CMD_final ? ASSIGN_FINAL
1968 : cmdidx == CMD_const ? ASSIGN_CONST : ASSIGN_VAR;
Bram Moolenaar752fc692021-01-04 21:57:11 +01001969 lhs->lhs_lvar = reserve_local(cctx, var_start, lhs->lhs_varlen,
Bram Moolenaar6586a012022-09-30 11:04:50 +01001970 assign, lhs->lhs_type);
Bram Moolenaar752fc692021-01-04 21:57:11 +01001971 if (lhs->lhs_lvar == NULL)
1972 return FAIL;
1973 lhs->lhs_new_local = TRUE;
1974 }
1975
1976 lhs->lhs_member_type = lhs->lhs_type;
Bram Moolenaar08251752021-01-11 21:20:18 +01001977 if (lhs->lhs_has_index)
Bram Moolenaar752fc692021-01-04 21:57:11 +01001978 {
Bram Moolenaarc750d912021-11-29 22:02:12 +00001979 char_u *after = var_start + lhs->lhs_varlen;
1980 char_u *p;
1981
Bram Moolenaar752fc692021-01-04 21:57:11 +01001982 // Something follows after the variable: "var[idx]" or "var.key".
Bram Moolenaar97f8c102022-04-02 19:43:57 +01001983 if (is_decl && cctx->ctx_skip != SKIP_YES)
Bram Moolenaar752fc692021-01-04 21:57:11 +01001984 {
Bram Moolenaar97f8c102022-04-02 19:43:57 +01001985 if (has_cmd)
1986 emsg(_(e_cannot_use_index_when_declaring_variable));
1987 else
1988 semsg(_(e_unknown_variable_str), lhs->lhs_name);
Bram Moolenaar752fc692021-01-04 21:57:11 +01001989 return FAIL;
1990 }
1991
Bram Moolenaarc750d912021-11-29 22:02:12 +00001992 // Now: var_start[lhs->lhs_varlen] is '[' or '.'
1993 // Only the last index is used below, if there are others
1994 // before it generate code for the expression. Thus for
1995 // "ll[1][2]" the expression is "ll[1]" and "[2]" is the index.
1996 for (;;)
Bram Moolenaar752fc692021-01-04 21:57:11 +01001997 {
Bram Moolenaarc750d912021-11-29 22:02:12 +00001998 p = skip_index(after);
1999 if (*p != '[' && *p != '.')
Bram Moolenaar752fc692021-01-04 21:57:11 +01002000 {
Bram Moolenaarc750d912021-11-29 22:02:12 +00002001 lhs->lhs_varlen_total = p - var_start;
2002 break;
Bram Moolenaar752fc692021-01-04 21:57:11 +01002003 }
Bram Moolenaarc750d912021-11-29 22:02:12 +00002004 after = p;
Bram Moolenaar752fc692021-01-04 21:57:11 +01002005 }
Bram Moolenaarc750d912021-11-29 22:02:12 +00002006 if (after > var_start + lhs->lhs_varlen)
2007 {
2008 lhs->lhs_varlen = after - var_start;
2009 lhs->lhs_dest = dest_expr;
2010 // We don't know the type before evaluating the expression,
2011 // use "any" until then.
2012 lhs->lhs_type = &t_any;
2013 }
2014
Bram Moolenaar666cb9c2023-02-22 12:35:17 +00002015 int use_class = lhs->lhs_type != NULL
2016 && (lhs->lhs_type->tt_type == VAR_CLASS
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02002017 || lhs->lhs_type->tt_type == VAR_OBJECT);
Bram Moolenaarb1e32ac2023-02-21 12:38:51 +00002018 if (lhs->lhs_type == NULL
2019 || (use_class ? lhs->lhs_type->tt_class == NULL
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02002020 : lhs->lhs_type->tt_member == NULL))
Bram Moolenaarb1e32ac2023-02-21 12:38:51 +00002021 {
Bram Moolenaarc750d912021-11-29 22:02:12 +00002022 lhs->lhs_member_type = &t_any;
Bram Moolenaarb1e32ac2023-02-21 12:38:51 +00002023 }
2024 else if (use_class)
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002025 {
2026 // for an object or class member get the type of the member
Yegappan Lakshmananeb91e242023-08-31 18:10:46 +02002027 class_T *cl = lhs->lhs_type->tt_class;
Yegappan Lakshmananc30a90d2023-09-15 20:14:55 +02002028 int is_object = lhs->lhs_type->tt_type == VAR_OBJECT;
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002029 char_u *name = var_start + lhs->lhs_varlen + 1;
2030 size_t namelen = lhs->lhs_end - var_start - lhs->lhs_varlen - 1;
Yegappan Lakshmananeb91e242023-08-31 18:10:46 +02002031
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002032 ocmember_T *m = member_lookup(cl, lhs->lhs_type->tt_type,
2033 name, namelen, &lhs->lhs_member_idx);
2034 if (m == NULL)
2035 {
2036 member_not_found_msg(cl, lhs->lhs_type->tt_type, name, namelen);
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02002037 return FAIL;
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002038 }
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02002039
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002040 // If it is private member variable, then accessing it outside the
2041 // class is not allowed.
2042 // If it is a read only class variable, then it can be modified
2043 // only inside the class where it is defined.
2044 if ((m->ocm_access != VIM_ACCESS_ALL) &&
2045 ((is_object && !inside_class(cctx, cl))
2046 || (!is_object && cctx->ctx_ufunc->uf_class != cl)))
2047 {
2048 char *msg = (m->ocm_access == VIM_ACCESS_PRIVATE)
Ernie Rael03042a22023-11-11 08:53:32 +01002049 ? e_cannot_access_protected_variable_str
2050 : e_variable_is_not_writable_str;
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002051 emsg_var_cl_define(msg, m->ocm_name, 0, cl);
Yegappan Lakshmananeb91e242023-08-31 18:10:46 +02002052 return FAIL;
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002053 }
2054
Yegappan Lakshmanane5437c52023-12-16 14:11:19 +01002055 if (!IS_CONSTRUCTOR_METHOD(cctx->ctx_ufunc)
2056 && oc_var_check_ro(cl, m))
2057 return FAIL;
2058
Yegappan Lakshmananb8523052023-10-08 19:07:39 +02002059 lhs->lhs_member_type = m->ocm_type;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002060 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01002061 else
Bram Moolenaarc750d912021-11-29 22:02:12 +00002062 lhs->lhs_member_type = lhs->lhs_type->tt_member;
Bram Moolenaar752fc692021-01-04 21:57:11 +01002063 }
2064 return OK;
2065}
2066
2067/*
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002068 * Figure out the LHS and check a few errors.
2069 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +00002070 int
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002071compile_assign_lhs(
Bram Moolenaar97f8c102022-04-02 19:43:57 +01002072 char_u *var_start,
2073 lhs_T *lhs,
2074 cmdidx_T cmdidx,
2075 int is_decl,
2076 int heredoc,
2077 int has_cmd, // "var" before "var_start"
2078 int oplen,
2079 cctx_T *cctx)
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002080{
Bram Moolenaar97f8c102022-04-02 19:43:57 +01002081 if (compile_lhs(var_start, lhs, cmdidx, heredoc, has_cmd, oplen, cctx)
2082 == FAIL)
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002083 return FAIL;
2084
2085 if (!lhs->lhs_has_index && lhs->lhs_lvar == &lhs->lhs_arg_lvar)
2086 {
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00002087 semsg(_(e_cannot_assign_to_argument_str), lhs->lhs_name);
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002088 return FAIL;
2089 }
2090 if (!is_decl && lhs->lhs_lvar != NULL
Bram Moolenaar6586a012022-09-30 11:04:50 +01002091 && lhs->lhs_lvar->lv_const != ASSIGN_VAR
2092 && !lhs->lhs_has_index)
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002093 {
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00002094 semsg(_(e_cannot_assign_to_constant_str), lhs->lhs_name);
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002095 return FAIL;
2096 }
2097 return OK;
2098}
2099
2100/*
Bram Moolenaar4f0884d2021-08-11 21:49:23 +02002101 * Return TRUE if "lhs" has a range index: "[expr : expr]".
2102 */
2103 static int
2104has_list_index(char_u *idx_start, cctx_T *cctx)
2105{
2106 char_u *p = idx_start;
2107 int save_skip;
2108
2109 if (*p != '[')
2110 return FALSE;
2111
2112 p = skipwhite(p + 1);
2113 if (*p == ':')
2114 return TRUE;
2115
2116 save_skip = cctx->ctx_skip;
2117 cctx->ctx_skip = SKIP_YES;
2118 (void)compile_expr0(&p, cctx);
2119 cctx->ctx_skip = save_skip;
2120 return *skipwhite(p) == ':';
2121}
2122
2123/*
Bram Moolenaare42939a2021-04-05 17:11:17 +02002124 * For an assignment with an index, compile the "idx" in "var[idx]" or "key" in
2125 * "var.key".
Bram Moolenaar752fc692021-01-04 21:57:11 +01002126 */
2127 static int
Bram Moolenaare42939a2021-04-05 17:11:17 +02002128compile_assign_index(
Bram Moolenaar752fc692021-01-04 21:57:11 +01002129 char_u *var_start,
2130 lhs_T *lhs,
Bram Moolenaare42939a2021-04-05 17:11:17 +02002131 int *range,
Bram Moolenaar752fc692021-01-04 21:57:11 +01002132 cctx_T *cctx)
2133{
Bram Moolenaar752fc692021-01-04 21:57:11 +01002134 size_t varlen = lhs->lhs_varlen;
Bram Moolenaare42939a2021-04-05 17:11:17 +02002135 char_u *p;
2136 int r = OK;
Bram Moolenaar68452172021-04-12 21:21:02 +02002137 int need_white_before = TRUE;
2138 int empty_second;
Bram Moolenaar752fc692021-01-04 21:57:11 +01002139
Bram Moolenaar752fc692021-01-04 21:57:11 +01002140 p = var_start + varlen;
2141 if (*p == '[')
2142 {
2143 p = skipwhite(p + 1);
Bram Moolenaar68452172021-04-12 21:21:02 +02002144 if (*p == ':')
2145 {
2146 // empty first index, push zero
2147 r = generate_PUSHNR(cctx, 0);
2148 need_white_before = FALSE;
2149 }
2150 else
2151 r = compile_expr0(&p, cctx);
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002152
2153 if (r == OK && *skipwhite(p) == ':')
2154 {
2155 // unlet var[idx : idx]
Bram Moolenaar68452172021-04-12 21:21:02 +02002156 // blob[idx : idx] = value
Bram Moolenaare42939a2021-04-05 17:11:17 +02002157 *range = TRUE;
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002158 p = skipwhite(p);
Bram Moolenaar68452172021-04-12 21:21:02 +02002159 empty_second = *skipwhite(p + 1) == ']';
2160 if ((need_white_before && !IS_WHITE_OR_NUL(p[-1]))
2161 || (!empty_second && !IS_WHITE_OR_NUL(p[1])))
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002162 {
2163 semsg(_(e_white_space_required_before_and_after_str_at_str),
2164 ":", p);
2165 return FAIL;
2166 }
2167 p = skipwhite(p + 1);
Bram Moolenaar68452172021-04-12 21:21:02 +02002168 if (*p == ']')
2169 // empty second index, push "none"
2170 r = generate_PUSHSPEC(cctx, VVAL_NONE);
2171 else
2172 r = compile_expr0(&p, cctx);
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002173 }
2174
Bram Moolenaar752fc692021-01-04 21:57:11 +01002175 if (r == OK && *skipwhite(p) != ']')
2176 {
2177 // this should not happen
Bram Moolenaare1242042021-12-16 20:56:57 +00002178 emsg(_(e_missing_closing_square_brace));
Bram Moolenaar752fc692021-01-04 21:57:11 +01002179 r = FAIL;
2180 }
2181 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002182 else if (lhs->lhs_member_idx >= 0)
2183 {
2184 // object member index
2185 r = generate_PUSHNR(cctx, lhs->lhs_member_idx);
2186 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01002187 else // if (*p == '.')
2188 {
2189 char_u *key_end = to_name_end(p + 1, TRUE);
2190 char_u *key = vim_strnsave(p + 1, key_end - p - 1);
2191
Zdenek Dohnal9fe17d42021-08-04 22:30:52 +02002192 r = generate_PUSHS(cctx, &key);
Bram Moolenaar752fc692021-01-04 21:57:11 +01002193 }
Bram Moolenaare42939a2021-04-05 17:11:17 +02002194 return r;
2195}
2196
2197/*
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002198 * For a LHS with an index, load the variable to be indexed.
2199 */
2200 static int
2201compile_load_lhs(
2202 lhs_T *lhs,
2203 char_u *var_start,
2204 type_T *rhs_type,
2205 cctx_T *cctx)
2206{
2207 if (lhs->lhs_dest == dest_expr)
2208 {
2209 size_t varlen = lhs->lhs_varlen;
2210 int c = var_start[varlen];
Bram Moolenaare97976b2021-08-01 13:17:17 +02002211 int lines_len = cctx->ctx_ufunc->uf_lines.ga_len;
Bram Moolenaare97976b2021-08-01 13:17:17 +02002212 int res;
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002213
Bram Moolenaare97976b2021-08-01 13:17:17 +02002214 // Evaluate "ll[expr]" of "ll[expr][idx]". End the line with a NUL and
2215 // limit the lines array length to avoid skipping to a following line.
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002216 var_start[varlen] = NUL;
Bram Moolenaare97976b2021-08-01 13:17:17 +02002217 cctx->ctx_ufunc->uf_lines.ga_len = cctx->ctx_lnum + 1;
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002218 char_u *p = var_start;
Bram Moolenaare97976b2021-08-01 13:17:17 +02002219 res = compile_expr0(&p, cctx);
2220 var_start[varlen] = c;
2221 cctx->ctx_ufunc->uf_lines.ga_len = lines_len;
2222 if (res == FAIL || p != var_start + varlen)
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002223 {
2224 // this should not happen
Bram Moolenaare97976b2021-08-01 13:17:17 +02002225 if (res != FAIL)
Bram Moolenaare1242042021-12-16 20:56:57 +00002226 emsg(_(e_missing_closing_square_brace));
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002227 return FAIL;
2228 }
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002229
Bram Moolenaar078a4612022-01-04 15:17:03 +00002230 lhs->lhs_type = cctx->ctx_type_stack.ga_len == 0 ? &t_void
2231 : get_type_on_stack(cctx, 0);
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02002232
2233 if (lhs->lhs_type->tt_type == VAR_OBJECT)
2234 {
2235 // Check whether the object variable is modifiable
2236 if (!lhs_class_member_modifiable(lhs, var_start, cctx))
2237 return FAIL;
2238 }
2239
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002240 // Now we can properly check the type. The variable is indexed, thus
2241 // we need the member type. For a class or object we don't know the
2242 // type yet, it depends on what member is used.
Yegappan Lakshmananc229a6a2023-10-26 23:05:07 +02002243 // The top item in the stack is the Dict, followed by the key and then
2244 // the type of the value.
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002245 vartype_T vartype = lhs->lhs_type->tt_type;
2246 type_T *member_type = lhs->lhs_type->tt_member;
2247 if (rhs_type != NULL && member_type != NULL
2248 && vartype != VAR_OBJECT && vartype != VAR_CLASS
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002249 && rhs_type != &t_void
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002250 && need_type(rhs_type, member_type, FALSE,
Yegappan Lakshmananc229a6a2023-10-26 23:05:07 +02002251 -3, 0, cctx, FALSE, FALSE) == FAIL)
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002252 return FAIL;
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02002253
2254 return OK;
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002255 }
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02002256
2257 return generate_loadvar(cctx, lhs);
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002258}
2259
2260/*
Bram Moolenaara369c3d2021-04-21 16:00:10 +02002261 * Produce code for loading "lhs" and also take care of an index.
2262 * Return OK/FAIL.
2263 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +00002264 int
Bram Moolenaara369c3d2021-04-21 16:00:10 +02002265compile_load_lhs_with_index(lhs_T *lhs, char_u *var_start, cctx_T *cctx)
2266{
Bram Moolenaar4cae8452023-01-15 15:51:48 +00002267 if (lhs->lhs_type->tt_type == VAR_OBJECT)
2268 {
Bram Moolenaar22363c62023-04-24 17:15:25 +01002269 // "this.value": load "this" object and get the value at index for an
2270 // object or class member get the type of the member.
2271 // Also for "obj.value".
Yegappan Lakshmananff6f0d52023-12-21 16:46:18 +01002272 char_u *dot = vim_strchr(var_start, '.');
2273 if (dot == NULL)
2274 {
2275 semsg(_(e_missing_dot_after_object_str), lhs->lhs_name);
2276 return FAIL;
2277 }
Bram Moolenaar22363c62023-04-24 17:15:25 +01002278
Yegappan Lakshmananeb91e242023-08-31 18:10:46 +02002279 class_T *cl = lhs->lhs_type->tt_class;
Yegappan Lakshmanan1ea42882023-10-11 21:43:52 +02002280 type_T *type = oc_member_type(cl, TRUE, dot + 1,
Yegappan Lakshmanan00cd1822023-09-18 19:56:49 +02002281 lhs->lhs_end, &lhs->lhs_member_idx);
Bram Moolenaar4cae8452023-01-15 15:51:48 +00002282 if (lhs->lhs_member_idx < 0)
2283 return FAIL;
2284
Bram Moolenaar22363c62023-04-24 17:15:25 +01002285 if (dot - var_start == 4 && STRNCMP(var_start, "this", 4) == 0)
2286 {
2287 // load "this"
2288 if (generate_LOAD(cctx, ISN_LOAD, 0, NULL, lhs->lhs_type) == FAIL)
2289 return FAIL;
2290 }
2291 else
2292 {
2293 // load object variable or argument
2294 if (compile_load_lhs(lhs, var_start, lhs->lhs_type, cctx) == FAIL)
2295 return FAIL;
2296 }
Bram Moolenaar29ac5df2023-01-16 19:43:47 +00002297 if (cl->class_flags & CLASS_INTERFACE)
Yegappan Lakshmanan5a05d372023-09-29 19:43:11 +02002298 return generate_GET_ITF_MEMBER(cctx, cl, lhs->lhs_member_idx, type);
2299 return generate_GET_OBJ_MEMBER(cctx, lhs->lhs_member_idx, type);
Bram Moolenaar4cae8452023-01-15 15:51:48 +00002300 }
Yegappan Lakshmanan1ea42882023-10-11 21:43:52 +02002301 else if (lhs->lhs_type->tt_type == VAR_CLASS)
2302 {
2303 // "<classname>.value": load class variable "classname.value"
Yegappan Lakshmananff6f0d52023-12-21 16:46:18 +01002304 char_u *dot = vim_strchr(var_start, '.');
2305 if (dot == NULL)
2306 {
2307 check_type_is_value(lhs->lhs_type);
2308 return FAIL;
2309 }
Yegappan Lakshmanan1ea42882023-10-11 21:43:52 +02002310
2311 class_T *cl = lhs->lhs_type->tt_class;
2312 ocmember_T *m = class_member_lookup(cl, dot + 1,
2313 lhs->lhs_end - dot - 1,
2314 &lhs->lhs_member_idx);
2315 if (m == NULL)
2316 return FAIL;
2317
2318 return generate_CLASSMEMBER(cctx, TRUE, cl, lhs->lhs_member_idx);
2319 }
Bram Moolenaar4cae8452023-01-15 15:51:48 +00002320
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02002321 if (compile_load_lhs(lhs, var_start, NULL, cctx) == FAIL)
2322 return FAIL;
Bram Moolenaara369c3d2021-04-21 16:00:10 +02002323
2324 if (lhs->lhs_has_index)
2325 {
2326 int range = FALSE;
2327
2328 // Get member from list or dict. First compile the
2329 // index value.
2330 if (compile_assign_index(var_start, lhs, &range, cctx) == FAIL)
2331 return FAIL;
2332 if (range)
2333 {
2334 semsg(_(e_cannot_use_range_with_assignment_operator_str),
2335 var_start);
2336 return FAIL;
2337 }
2338
2339 // Get the member.
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02002340 if (compile_member(FALSE, NULL, cctx) == FAIL)
Bram Moolenaara369c3d2021-04-21 16:00:10 +02002341 return FAIL;
2342 }
2343 return OK;
2344}
2345
2346/*
Bram Moolenaare42939a2021-04-05 17:11:17 +02002347 * Assignment to a list or dict member, or ":unlet" for the item, using the
2348 * information in "lhs".
2349 * Returns OK or FAIL.
2350 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +00002351 int
Bram Moolenaare42939a2021-04-05 17:11:17 +02002352compile_assign_unlet(
2353 char_u *var_start,
2354 lhs_T *lhs,
2355 int is_assign,
2356 type_T *rhs_type,
2357 cctx_T *cctx)
2358{
Bram Moolenaare42939a2021-04-05 17:11:17 +02002359 vartype_T dest_type;
Bram Moolenaare42939a2021-04-05 17:11:17 +02002360 int range = FALSE;
2361
Bram Moolenaar68452172021-04-12 21:21:02 +02002362 if (compile_assign_index(var_start, lhs, &range, cctx) == FAIL)
Bram Moolenaar752fc692021-01-04 21:57:11 +01002363 return FAIL;
Bram Moolenaar4f0884d2021-08-11 21:49:23 +02002364 if (is_assign && range
2365 && lhs->lhs_type->tt_type != VAR_LIST
2366 && lhs->lhs_type != &t_blob
2367 && lhs->lhs_type != &t_any)
Bram Moolenaar68452172021-04-12 21:21:02 +02002368 {
2369 semsg(_(e_cannot_use_range_with_assignment_str), var_start);
2370 return FAIL;
2371 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01002372
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002373 if (lhs->lhs_type == NULL || lhs->lhs_type == &t_any)
Bram Moolenaar752fc692021-01-04 21:57:11 +01002374 {
2375 // Index on variable of unknown type: check at runtime.
2376 dest_type = VAR_ANY;
2377 }
2378 else
2379 {
2380 dest_type = lhs->lhs_type->tt_type;
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002381 if (dest_type == VAR_DICT && range)
2382 {
zeertzjq276410e2023-05-07 21:59:33 +01002383 emsg(_(e_cannot_use_range_with_dictionary));
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002384 return FAIL;
2385 }
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02002386 if (dest_type == VAR_DICT
2387 && may_generate_2STRING(-1, FALSE, cctx) == FAIL)
Bram Moolenaar752fc692021-01-04 21:57:11 +01002388 return FAIL;
Bram Moolenaar51e93322021-04-17 20:44:56 +02002389 if (dest_type == VAR_LIST || dest_type == VAR_BLOB)
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002390 {
Bram Moolenaar51e93322021-04-17 20:44:56 +02002391 type_T *type;
2392
2393 if (range)
2394 {
Bram Moolenaar078a4612022-01-04 15:17:03 +00002395 type = get_type_on_stack(cctx, 1);
Bram Moolenaarc6951a72022-12-29 20:56:24 +00002396 if (need_type(type, &t_number, FALSE,
Bram Moolenaar2995e5c2022-03-18 21:41:47 +00002397 -2, 0, cctx, FALSE, FALSE) == FAIL)
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002398 return FAIL;
Bram Moolenaar51e93322021-04-17 20:44:56 +02002399 }
Bram Moolenaar078a4612022-01-04 15:17:03 +00002400 type = get_type_on_stack(cctx, 0);
Bram Moolenaar53ba6ca2022-03-10 19:23:28 +00002401 if ((dest_type != VAR_BLOB && type->tt_type != VAR_SPECIAL)
Bram Moolenaarc6951a72022-12-29 20:56:24 +00002402 && need_type(type, &t_number, FALSE,
Bram Moolenaar51e93322021-04-17 20:44:56 +02002403 -1, 0, cctx, FALSE, FALSE) == FAIL)
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002404 return FAIL;
2405 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01002406 }
2407
Bram Moolenaar4875d6a2022-08-17 15:55:51 +01002408 if (cctx->ctx_skip == SKIP_YES)
2409 return OK;
2410
Bram Moolenaar22363c62023-04-24 17:15:25 +01002411 // Load the dict, list or object. On the stack we then have:
Bram Moolenaar752fc692021-01-04 21:57:11 +01002412 // - value (for assignment, not for :unlet)
2413 // - index
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002414 // - for [a : b] second index
Bram Moolenaar752fc692021-01-04 21:57:11 +01002415 // - variable
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002416 if (compile_load_lhs(lhs, var_start, rhs_type, cctx) == FAIL)
2417 return FAIL;
Bram Moolenaar752fc692021-01-04 21:57:11 +01002418
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002419 if (dest_type == VAR_LIST
2420 || dest_type == VAR_DICT
2421 || dest_type == VAR_BLOB
2422 || dest_type == VAR_CLASS
2423 || dest_type == VAR_OBJECT
2424 || dest_type == VAR_ANY)
Bram Moolenaar752fc692021-01-04 21:57:11 +01002425 {
2426 if (is_assign)
2427 {
Bram Moolenaar68452172021-04-12 21:21:02 +02002428 if (range)
2429 {
2430 if (generate_instr_drop(cctx, ISN_STORERANGE, 4) == NULL)
2431 return FAIL;
2432 }
2433 else
2434 {
2435 isn_T *isn = generate_instr_drop(cctx, ISN_STOREINDEX, 3);
Bram Moolenaar752fc692021-01-04 21:57:11 +01002436
Bram Moolenaar68452172021-04-12 21:21:02 +02002437 if (isn == NULL)
2438 return FAIL;
Bram Moolenaarf7d1c6e2023-01-16 20:47:57 +00002439 isn->isn_arg.storeindex.si_vartype = dest_type;
2440 isn->isn_arg.storeindex.si_class = NULL;
2441
2442 if (dest_type == VAR_OBJECT)
2443 {
Bram Moolenaarb1e32ac2023-02-21 12:38:51 +00002444 class_T *cl = lhs->lhs_type->tt_class;
Bram Moolenaarf7d1c6e2023-01-16 20:47:57 +00002445
2446 if (cl->class_flags & CLASS_INTERFACE)
2447 {
2448 // "this.value": load "this" object and get the value
2449 // at index for an object or class member get the type
2450 // of the member
2451 isn->isn_arg.storeindex.si_class = cl;
2452 ++cl->class_refcount;
2453 }
2454 }
Bram Moolenaar68452172021-04-12 21:21:02 +02002455 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01002456 }
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002457 else if (range)
2458 {
2459 if (generate_instr_drop(cctx, ISN_UNLETRANGE, 3) == NULL)
2460 return FAIL;
2461 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01002462 else
2463 {
2464 if (generate_instr_drop(cctx, ISN_UNLETINDEX, 2) == NULL)
2465 return FAIL;
2466 }
2467 }
2468 else
2469 {
2470 emsg(_(e_indexable_type_required));
2471 return FAIL;
2472 }
2473
2474 return OK;
2475}
2476
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01002477/*
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00002478 * Generate an instruction to push the default value for "vartype".
2479 * if "dest_local" is TRUE then for some types no instruction is generated.
2480 * "skip_store" is set to TRUE if no PUSH instruction is generated.
2481 * Returns OK or FAIL.
2482 */
2483 static int
2484push_default_value(
2485 cctx_T *cctx,
2486 vartype_T vartype,
2487 int dest_is_local,
2488 int *skip_store)
2489{
2490 int r = OK;
2491
2492 switch (vartype)
2493 {
2494 case VAR_BOOL:
2495 r = generate_PUSHBOOL(cctx, VVAL_FALSE);
2496 break;
2497 case VAR_FLOAT:
2498 r = generate_PUSHF(cctx, 0.0);
2499 break;
2500 case VAR_STRING:
2501 r = generate_PUSHS(cctx, NULL);
2502 break;
2503 case VAR_BLOB:
2504 r = generate_PUSHBLOB(cctx, blob_alloc());
2505 break;
2506 case VAR_FUNC:
2507 r = generate_PUSHFUNC(cctx, NULL, &t_func_void, TRUE);
2508 break;
2509 case VAR_LIST:
2510 r = generate_NEWLIST(cctx, 0, FALSE);
2511 break;
2512 case VAR_DICT:
2513 r = generate_NEWDICT(cctx, 0, FALSE);
2514 break;
2515 case VAR_JOB:
2516 r = generate_PUSHJOB(cctx);
2517 break;
2518 case VAR_CHANNEL:
2519 r = generate_PUSHCHANNEL(cctx);
2520 break;
Ernie Rael5c018be2023-08-27 18:40:26 +02002521 case VAR_OBJECT:
2522 r = generate_PUSHOBJ(cctx);
2523 break;
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00002524 case VAR_NUMBER:
2525 case VAR_UNKNOWN:
2526 case VAR_ANY:
2527 case VAR_PARTIAL:
2528 case VAR_VOID:
2529 case VAR_INSTR:
2530 case VAR_CLASS:
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02002531 case VAR_TYPEALIAS:
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00002532 case VAR_SPECIAL: // cannot happen
2533 // This is skipped for local variables, they are always
2534 // initialized to zero. But in a "for" or "while" loop
2535 // the value may have been changed.
2536 if (dest_is_local && !inside_loop_scope(cctx))
2537 *skip_store = TRUE;
2538 else
2539 r = generate_PUSHNR(cctx, 0);
2540 break;
2541 }
2542 return r;
2543}
2544
2545/*
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002546 * Compile declaration and assignment:
Bram Moolenaar30fd8202020-09-26 15:09:30 +02002547 * "let name"
2548 * "var name = expr"
2549 * "final name = expr"
2550 * "const name = expr"
2551 * "name = expr"
2552 * "arg" points to "name".
Bram Moolenaarbdc0f1c2021-04-24 19:08:24 +02002553 * "++arg" and "--arg"
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002554 * Return NULL for an error.
2555 * Return "arg" if it does not look like a variable list.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002556 */
2557 static char_u *
Bram Moolenaar65b0d162022-12-13 18:43:22 +00002558compile_assignment(
2559 char_u *arg_start,
2560 exarg_T *eap,
2561 cmdidx_T cmdidx,
2562 cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002563{
Bram Moolenaar65b0d162022-12-13 18:43:22 +00002564 char_u *arg = arg_start;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002565 char_u *var_start;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002566 char_u *p;
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02002567 char_u *end = arg;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002568 char_u *ret = NULL;
2569 int var_count = 0;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002570 int var_idx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002571 int semicolon = 0;
Bram Moolenaar4d5dfe22021-06-26 13:59:29 +02002572 int did_generate_slice = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002573 garray_T *instr = &cctx->ctx_instr;
Bram Moolenaar65b0d162022-12-13 18:43:22 +00002574 int jump_instr_idx = instr->ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002575 char_u *op;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002576 int oplen = 0;
2577 int heredoc = FALSE;
Bram Moolenaarbdc0f1c2021-04-24 19:08:24 +02002578 int incdec = FALSE;
Bram Moolenaardc234ca2020-11-28 18:52:33 +01002579 type_T *rhs_type = &t_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002580 char_u *sp;
Bram Moolenaar752fc692021-01-04 21:57:11 +01002581 int is_decl = is_decl_command(cmdidx);
2582 lhs_T lhs;
Bram Moolenaarf593fc82022-12-14 13:50:02 +00002583 CLEAR_FIELD(lhs);
Bram Moolenaar77709b12021-04-03 21:01:01 +02002584 long start_lnum = SOURCING_LNUM;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002585
Bram Moolenaar6acf7572023-01-01 19:53:30 +00002586 int has_arg_is_set_prefix = STRNCMP(arg, "ifargisset ", 11) == 0;
Bram Moolenaar65b0d162022-12-13 18:43:22 +00002587 if (has_arg_is_set_prefix)
2588 {
2589 arg += 11;
2590 int def_idx = getdigits(&arg);
2591 arg = skipwhite(arg);
2592
2593 // Use a JUMP_IF_ARG_NOT_SET instruction to skip if the value was not
2594 // given and the default value is "v:none".
2595 int off = STACK_FRAME_SIZE + (cctx->ctx_ufunc->uf_va_name != NULL
2596 ? 1 : 0);
2597 int count = cctx->ctx_ufunc->uf_def_args.ga_len;
2598 if (generate_JUMP_IF_ARG(cctx, ISN_JUMP_IF_ARG_NOT_SET,
2599 def_idx - count - off) == FAIL)
2600 goto theend;
2601 }
2602
Bram Moolenaare1d12112022-03-05 11:37:48 +00002603 // Skip over the "varname" or "[varname, varname]" to get to any "=".
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002604 p = skip_var_list(arg, TRUE, &var_count, &semicolon, TRUE);
2605 if (p == NULL)
2606 return *arg == '[' ? arg : NULL;
2607
Bram Moolenaarbdc0f1c2021-04-24 19:08:24 +02002608 if (eap->cmdidx == CMD_increment || eap->cmdidx == CMD_decrement)
2609 {
Bram Moolenaar22480d12021-06-25 21:31:09 +02002610 if (VIM_ISWHITE(eap->cmd[2]))
2611 {
2612 semsg(_(e_no_white_space_allowed_after_str_str),
2613 eap->cmdidx == CMD_increment ? "++" : "--", eap->cmd);
2614 return NULL;
2615 }
Bram Moolenaarbdc0f1c2021-04-24 19:08:24 +02002616 op = (char_u *)(eap->cmdidx == CMD_increment ? "+=" : "-=");
2617 oplen = 2;
2618 incdec = TRUE;
2619 }
Bram Moolenaar70d87692022-05-07 10:03:27 +01002620 else
2621 {
2622 sp = p;
2623 p = skipwhite(p);
2624 op = p;
2625 oplen = assignment_len(p, &heredoc);
2626
2627 if (var_count > 0 && oplen == 0)
2628 // can be something like "[1, 2]->func()"
2629 return arg;
2630
2631 if (oplen > 0 && (!VIM_ISWHITE(*sp) || !IS_WHITE_OR_NUL(op[oplen])))
2632 {
2633 error_white_both(op, oplen);
2634 return NULL;
2635 }
2636 }
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02002637
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002638 if (heredoc)
2639 {
2640 list_T *l;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002641
2642 // [let] varname =<< [trim] {end}
Zoltan Arpadffy6fdb6282023-12-19 20:53:07 +01002643 eap->ea_getline = exarg_getline;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002644 eap->cookie = cctx;
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01002645 l = heredoc_get(eap, op + 3, FALSE, TRUE);
Bram Moolenaarc0e29012020-09-27 14:22:48 +02002646 if (l == NULL)
2647 return NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002648
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002649 list_free(l);
2650 p += STRLEN(p);
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002651 end = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002652 }
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002653 else if (var_count > 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002654 {
Bram Moolenaar004d9b02020-11-30 21:40:03 +01002655 char_u *wp;
2656
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002657 // for "[var, var] = expr" evaluate the expression here, loop over the
2658 // list of variables below.
Bram Moolenaar004d9b02020-11-30 21:40:03 +01002659 // A line break may follow the "=".
Bram Moolenaard25ec2c2020-03-30 21:05:45 +02002660
Bram Moolenaar004d9b02020-11-30 21:40:03 +01002661 wp = op + oplen;
Bram Moolenaar8ff16e02020-12-07 21:49:52 +01002662 if (may_get_next_line_error(wp, &p, cctx) == FAIL)
Bram Moolenaar004d9b02020-11-30 21:40:03 +01002663 return FAIL;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002664 if (compile_expr0(&p, cctx) == FAIL)
2665 return NULL;
2666 end = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002667
Bram Moolenaar9b68c822020-06-18 19:31:08 +02002668 if (cctx->ctx_skip != SKIP_YES)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002669 {
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02002670 type_T *stacktype;
Bram Moolenaardb9ff9a2021-12-01 17:38:01 +00002671 int needed_list_len;
2672 int did_check = FALSE;
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02002673
Bram Moolenaar078a4612022-01-04 15:17:03 +00002674 stacktype = cctx->ctx_type_stack.ga_len == 0 ? &t_void
2675 : get_type_on_stack(cctx, 0);
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002676 if (stacktype->tt_type == VAR_VOID)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002677 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02002678 emsg(_(e_cannot_use_void_value));
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002679 goto theend;
2680 }
Bram Moolenaarc6951a72022-12-29 20:56:24 +00002681 if (need_type(stacktype, &t_list_any, FALSE, -1, 0, cctx,
Bram Moolenaar334a8b42020-10-19 16:07:42 +02002682 FALSE, FALSE) == FAIL)
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002683 goto theend;
Bram Moolenaardb9ff9a2021-12-01 17:38:01 +00002684 // If a constant list was used we can check the length right here.
2685 needed_list_len = semicolon ? var_count - 1 : var_count;
2686 if (instr->ga_len > 0)
2687 {
2688 isn_T *isn = ((isn_T *)instr->ga_data) + instr->ga_len - 1;
2689
2690 if (isn->isn_type == ISN_NEWLIST)
2691 {
2692 did_check = TRUE;
2693 if (semicolon ? isn->isn_arg.number < needed_list_len
2694 : isn->isn_arg.number != needed_list_len)
2695 {
2696 semsg(_(e_expected_nr_items_but_got_nr),
Bram Moolenaarf60a6342022-01-15 14:16:37 +00002697 needed_list_len, (int)isn->isn_arg.number);
Bram Moolenaardb9ff9a2021-12-01 17:38:01 +00002698 goto theend;
2699 }
2700 }
2701 }
2702 if (!did_check)
2703 generate_CHECKLEN(cctx, needed_list_len, semicolon);
Bram Moolenaardc234ca2020-11-28 18:52:33 +01002704 if (stacktype->tt_member != NULL)
2705 rhs_type = stacktype->tt_member;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002706 }
2707 }
2708
2709 /*
2710 * Loop over variables in "[var, var] = expr".
2711 * For "var = expr" and "let var: type" this is done only once.
2712 */
2713 if (var_count > 0)
2714 var_start = skipwhite(arg + 1); // skip over the "["
2715 else
2716 var_start = arg;
2717 for (var_idx = 0; var_idx == 0 || var_idx < var_count; var_idx++)
2718 {
Bram Moolenaar6977dba2021-07-04 22:48:12 +02002719 int instr_count = -1;
2720 int save_lnum;
Bram Moolenaar5cd64792021-12-25 18:23:24 +00002721 int skip_store = FALSE;
Bram Moolenaare88c6b72022-02-15 15:37:11 +00002722 type_T *inferred_type = NULL;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002723
Bram Moolenaarf93bbd02021-04-10 22:35:43 +02002724 if (var_start[0] == '_' && !eval_isnamec(var_start[1]))
2725 {
2726 // Ignore underscore in "[a, _, b] = list".
2727 if (var_count > 0)
2728 {
2729 var_start = skipwhite(var_start + 2);
2730 continue;
2731 }
2732 emsg(_(e_cannot_use_underscore_here));
2733 goto theend;
2734 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01002735 vim_free(lhs.lhs_name);
2736
2737 /*
2738 * Figure out the LHS type and other properties.
2739 */
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002740 if (compile_assign_lhs(var_start, &lhs, cmdidx,
Bram Moolenaar97f8c102022-04-02 19:43:57 +01002741 is_decl, heredoc, var_start > eap->cmd,
2742 oplen, cctx) == FAIL)
Bram Moolenaar752fc692021-01-04 21:57:11 +01002743 goto theend;
Bram Moolenaar81530e32021-07-28 21:25:49 +02002744 if (heredoc)
2745 {
2746 SOURCING_LNUM = start_lnum;
2747 if (lhs.lhs_has_type
Bram Moolenaarc6951a72022-12-29 20:56:24 +00002748 && need_type(&t_list_string, lhs.lhs_type, FALSE,
Bram Moolenaar81530e32021-07-28 21:25:49 +02002749 -1, 0, cctx, FALSE, FALSE) == FAIL)
2750 goto theend;
2751 }
2752 else
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002753 {
Bram Moolenaar9b68c822020-06-18 19:31:08 +02002754 if (cctx->ctx_skip == SKIP_YES)
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002755 {
Bram Moolenaar72abcf42020-06-18 18:26:24 +02002756 if (oplen > 0 && var_count == 0)
2757 {
2758 // skip over the "=" and the expression
2759 p = skipwhite(op + oplen);
Bram Moolenaar169502f2021-04-21 12:19:35 +02002760 (void)compile_expr0(&p, cctx);
Bram Moolenaar72abcf42020-06-18 18:26:24 +02002761 }
2762 }
2763 else if (oplen > 0)
2764 {
Bram Moolenaar334a8b42020-10-19 16:07:42 +02002765 int is_const = FALSE;
Bram Moolenaar7f764942020-12-02 15:11:18 +01002766 char_u *wp;
Bram Moolenaar72abcf42020-06-18 18:26:24 +02002767
Bram Moolenaar035bd1c2021-06-21 19:44:11 +02002768 // for "+=", "*=", "..=" etc. first load the current value
2769 if (*op != '='
2770 && compile_load_lhs_with_index(&lhs, var_start,
2771 cctx) == FAIL)
2772 goto theend;
2773
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002774 // For "var = expr" evaluate the expression.
2775 if (var_count == 0)
2776 {
2777 int r;
2778
Bram Moolenaarbdc0f1c2021-04-24 19:08:24 +02002779 // Compile the expression.
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002780 instr_count = instr->ga_len;
Bram Moolenaarbdc0f1c2021-04-24 19:08:24 +02002781 if (incdec)
Bram Moolenaar21e51222020-12-04 12:43:29 +01002782 {
Bram Moolenaarbdc0f1c2021-04-24 19:08:24 +02002783 r = generate_PUSHNR(cctx, 1);
2784 }
2785 else
2786 {
2787 // Temporarily hide the new local variable here, it is
2788 // not available to this expression.
2789 if (lhs.lhs_new_local)
2790 --cctx->ctx_locals.ga_len;
2791 wp = op + oplen;
2792 if (may_get_next_line_error(wp, &p, cctx) == FAIL)
2793 {
2794 if (lhs.lhs_new_local)
2795 ++cctx->ctx_locals.ga_len;
2796 goto theend;
2797 }
2798 r = compile_expr0_ext(&p, cctx, &is_const);
Bram Moolenaar752fc692021-01-04 21:57:11 +01002799 if (lhs.lhs_new_local)
Bram Moolenaar21e51222020-12-04 12:43:29 +01002800 ++cctx->ctx_locals.ga_len;
Bram Moolenaar21e51222020-12-04 12:43:29 +01002801 }
Yegappan Lakshmananc99e1822022-09-03 10:52:24 +01002802 if (r == FAIL)
2803 goto theend;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002804 }
Bram Moolenaar9af78762020-06-16 11:34:42 +02002805 else if (semicolon && var_idx == var_count - 1)
2806 {
2807 // For "[var; var] = expr" get the rest of the list
Bram Moolenaar4d5dfe22021-06-26 13:59:29 +02002808 did_generate_slice = TRUE;
Bram Moolenaar9af78762020-06-16 11:34:42 +02002809 if (generate_SLICE(cctx, var_count - 1) == FAIL)
2810 goto theend;
2811 }
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02002812 else
2813 {
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002814 // For "[var, var] = expr" get the "var_idx" item from the
2815 // list.
Bram Moolenaar035bd1c2021-06-21 19:44:11 +02002816 if (generate_GETITEM(cctx, var_idx, *op != '=') == FAIL)
Bram Moolenaar7f764942020-12-02 15:11:18 +01002817 goto theend;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002818 }
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02002819
Bram Moolenaar078a4612022-01-04 15:17:03 +00002820 rhs_type = cctx->ctx_type_stack.ga_len == 0 ? &t_void
2821 : get_type_on_stack(cctx, 0);
Ernie Rael9ed53752023-12-11 17:40:46 +01002822 if (check_type_is_value(rhs_type) == FAIL)
2823 goto theend;
Bram Moolenaar752fc692021-01-04 21:57:11 +01002824 if (lhs.lhs_lvar != NULL && (is_decl || !lhs.lhs_has_type))
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002825 {
Bram Moolenaardc234ca2020-11-28 18:52:33 +01002826 if ((rhs_type->tt_type == VAR_FUNC
2827 || rhs_type->tt_type == VAR_PARTIAL)
Bram Moolenaar3f327882021-03-17 20:56:38 +01002828 && !lhs.lhs_has_index
Bram Moolenaar752fc692021-01-04 21:57:11 +01002829 && var_wrong_func_name(lhs.lhs_name, TRUE))
Bram Moolenaar0f769812020-09-12 18:32:34 +02002830 goto theend;
2831
Bram Moolenaar752fc692021-01-04 21:57:11 +01002832 if (lhs.lhs_new_local && !lhs.lhs_has_type)
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02002833 {
Bram Moolenaardc234ca2020-11-28 18:52:33 +01002834 if (rhs_type->tt_type == VAR_VOID)
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002835 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02002836 emsg(_(e_cannot_use_void_value));
Bram Moolenaar72abcf42020-06-18 18:26:24 +02002837 goto theend;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002838 }
2839 else
2840 {
Bram Moolenaarfa103972022-09-29 19:14:42 +01002841 type_T *type;
2842
Bram Moolenaar04bdd572020-09-23 13:25:32 +02002843 // An empty list or dict has a &t_unknown member,
Bram Moolenaar72abcf42020-06-18 18:26:24 +02002844 // for a variable that implies &t_any.
Bram Moolenaardc234ca2020-11-28 18:52:33 +01002845 if (rhs_type == &t_list_empty)
Bram Moolenaarfa103972022-09-29 19:14:42 +01002846 type = &t_list_any;
Bram Moolenaardc234ca2020-11-28 18:52:33 +01002847 else if (rhs_type == &t_dict_empty)
Bram Moolenaarfa103972022-09-29 19:14:42 +01002848 type = &t_dict_any;
Bram Moolenaardc234ca2020-11-28 18:52:33 +01002849 else if (rhs_type == &t_unknown)
Bram Moolenaarfa103972022-09-29 19:14:42 +01002850 type = &t_any;
Bram Moolenaar72abcf42020-06-18 18:26:24 +02002851 else
Bram Moolenaare88c6b72022-02-15 15:37:11 +00002852 {
Bram Moolenaarfa103972022-09-29 19:14:42 +01002853 type = rhs_type;
Bram Moolenaare88c6b72022-02-15 15:37:11 +00002854 inferred_type = rhs_type;
2855 }
Bram Moolenaarfa103972022-09-29 19:14:42 +01002856 set_var_type(lhs.lhs_lvar, type, cctx);
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002857 }
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02002858 }
Bram Moolenaar93ad1472020-08-19 22:02:41 +02002859 else if (*op == '=')
Bram Moolenaar72abcf42020-06-18 18:26:24 +02002860 {
Bram Moolenaar752fc692021-01-04 21:57:11 +01002861 type_T *use_type = lhs.lhs_lvar->lv_type;
Bram Moolenaar4270d8b2021-08-07 16:30:42 +02002862 where_T where = WHERE_INIT;
Bram Moolenaar72abcf42020-06-18 18:26:24 +02002863
Bram Moolenaar77709b12021-04-03 21:01:01 +02002864 // Without operator check type here, otherwise below.
2865 // Use the line number of the assignment.
2866 SOURCING_LNUM = start_lnum;
LemonBoyc5d27442023-08-19 13:02:35 +02002867 if (var_count > 0)
2868 {
2869 where.wt_index = var_idx + 1;
2870 where.wt_kind = WT_VARIABLE;
2871 }
Bram Moolenaar4f0884d2021-08-11 21:49:23 +02002872 // If assigning to a list or dict member, use the
2873 // member type. Not for "list[:] =".
2874 if (lhs.lhs_has_index
2875 && !has_list_index(var_start + lhs.lhs_varlen,
2876 cctx))
Bram Moolenaar752fc692021-01-04 21:57:11 +01002877 use_type = lhs.lhs_member_type;
Bram Moolenaarc6951a72022-12-29 20:56:24 +00002878 if (need_type_where(rhs_type, use_type, FALSE, -1,
2879 where, cctx, FALSE, is_const) == FAIL)
Bram Moolenaar72abcf42020-06-18 18:26:24 +02002880 goto theend;
2881 }
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02002882 }
Bram Moolenaar74f4a962021-06-17 21:03:07 +02002883 else
2884 {
2885 type_T *lhs_type = lhs.lhs_member_type;
2886
2887 // Special case: assigning to @# can use a number or a
2888 // string.
Bram Moolenaaraf647e72021-08-05 19:01:17 +02002889 // Also: can assign a number to a float.
2890 if ((lhs_type == &t_number_or_string
2891 || lhs_type == &t_float)
2892 && rhs_type->tt_type == VAR_NUMBER)
Bram Moolenaar74f4a962021-06-17 21:03:07 +02002893 lhs_type = &t_number;
Bram Moolenaarc6951a72022-12-29 20:56:24 +00002894 if (*p != '=' && need_type(rhs_type, lhs_type, FALSE,
Bram Moolenaar351ead02021-01-16 16:07:01 +01002895 -1, 0, cctx, FALSE, FALSE) == FAIL)
Bram Moolenaarf39d9e92023-04-22 22:54:40 +01002896 goto theend;
Bram Moolenaar74f4a962021-06-17 21:03:07 +02002897 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002898 }
Bram Moolenaar30fd8202020-09-26 15:09:30 +02002899 else if (cmdidx == CMD_final)
2900 {
2901 emsg(_(e_final_requires_a_value));
2902 goto theend;
2903 }
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002904 else if (cmdidx == CMD_const)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002905 {
Bram Moolenaarbc4c5052020-08-13 22:47:35 +02002906 emsg(_(e_const_requires_a_value));
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002907 goto theend;
2908 }
Bram Moolenaardcb53be2021-12-09 14:23:43 +00002909 else if (!lhs.lhs_has_type || lhs.lhs_dest == dest_option
2910 || lhs.lhs_dest == dest_func_option)
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002911 {
Bram Moolenaarbc4c5052020-08-13 22:47:35 +02002912 emsg(_(e_type_or_initialization_required));
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002913 goto theend;
2914 }
2915 else
2916 {
2917 // variables are always initialized
Bram Moolenaar35578162021-08-02 19:10:38 +02002918 if (GA_GROW_FAILS(instr, 1))
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002919 goto theend;
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00002920 instr_count = instr->ga_len;
2921 int r = push_default_value(cctx, lhs.lhs_member_type->tt_type,
2922 lhs.lhs_dest == dest_local, &skip_store);
Bram Moolenaarc9af6172022-05-04 16:46:54 +01002923 if (r == FAIL)
2924 goto theend;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002925 }
2926 if (var_count == 0)
2927 end = p;
2928 }
2929
Bram Moolenaar72abcf42020-06-18 18:26:24 +02002930 // no need to parse more when skipping
Bram Moolenaar9b68c822020-06-18 19:31:08 +02002931 if (cctx->ctx_skip == SKIP_YES)
Bram Moolenaar72abcf42020-06-18 18:26:24 +02002932 break;
2933
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002934 if (oplen > 0 && *op != '=')
2935 {
Bram Moolenaar93ad1472020-08-19 22:02:41 +02002936 type_T *expected;
Bram Moolenaarc3160722021-08-02 21:12:05 +02002937 type_T *stacktype = NULL;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002938
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002939 if (*op == '.')
Bram Moolenaarf5d52c92021-07-31 22:51:10 +02002940 {
2941 if (may_generate_2STRING(-1, FALSE, cctx) == FAIL)
2942 goto theend;
2943 }
Bram Moolenaar93ad1472020-08-19 22:02:41 +02002944 else
Bram Moolenaarf5d52c92021-07-31 22:51:10 +02002945 {
Bram Moolenaar752fc692021-01-04 21:57:11 +01002946 expected = lhs.lhs_member_type;
Bram Moolenaar078a4612022-01-04 15:17:03 +00002947 stacktype = get_type_on_stack(cctx, 0);
Bram Moolenaarf5d52c92021-07-31 22:51:10 +02002948 if (
Bram Moolenaarf5d52c92021-07-31 22:51:10 +02002949 // If variable is float operation with number is OK.
Bram Moolenaar7bf9a072021-08-02 21:55:15 +02002950 !(expected == &t_float && (stacktype == &t_number
Bram Moolenaarc6951a72022-12-29 20:56:24 +00002951 || stacktype == &t_number_bool))
2952 && need_type(stacktype, expected, TRUE, -1, 0, cctx,
Bram Moolenaar334a8b42020-10-19 16:07:42 +02002953 FALSE, FALSE) == FAIL)
Bram Moolenaarf5d52c92021-07-31 22:51:10 +02002954 goto theend;
2955 }
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002956
2957 if (*op == '.')
Bram Moolenaardd29f1b2020-08-07 20:46:20 +02002958 {
LemonBoy372bcce2022-04-25 12:43:20 +01002959 if (generate_CONCAT(cctx, 2) == FAIL)
Bram Moolenaardd29f1b2020-08-07 20:46:20 +02002960 goto theend;
2961 }
2962 else if (*op == '+')
2963 {
2964 if (generate_add_instr(cctx,
Bram Moolenaar752fc692021-01-04 21:57:11 +01002965 operator_type(lhs.lhs_member_type, stacktype),
Bram Moolenaar07802042021-09-09 23:01:14 +02002966 lhs.lhs_member_type, stacktype,
2967 EXPR_APPEND) == FAIL)
Bram Moolenaardd29f1b2020-08-07 20:46:20 +02002968 goto theend;
2969 }
Bram Moolenaar93ad1472020-08-19 22:02:41 +02002970 else if (generate_two_op(cctx, op) == FAIL)
2971 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002972 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002973
Bram Moolenaar6977dba2021-07-04 22:48:12 +02002974 // Use the line number of the assignment for store instruction.
2975 save_lnum = cctx->ctx_lnum;
2976 cctx->ctx_lnum = start_lnum - 1;
2977
Bram Moolenaar752fc692021-01-04 21:57:11 +01002978 if (lhs.lhs_has_index)
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02002979 {
Bram Moolenaar752fc692021-01-04 21:57:11 +01002980 // Use the info in "lhs" to store the value at the index in the
Bram Moolenaar22363c62023-04-24 17:15:25 +01002981 // list, dict or object.
Bram Moolenaar752fc692021-01-04 21:57:11 +01002982 if (compile_assign_unlet(var_start, &lhs, TRUE, rhs_type, cctx)
2983 == FAIL)
Bram Moolenaar6977dba2021-07-04 22:48:12 +02002984 {
2985 cctx->ctx_lnum = save_lnum;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002986 goto theend;
Bram Moolenaar6977dba2021-07-04 22:48:12 +02002987 }
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02002988 }
2989 else
2990 {
Bram Moolenaar752fc692021-01-04 21:57:11 +01002991 if (is_decl && cmdidx == CMD_const && (lhs.lhs_dest == dest_script
Bram Moolenaard877a572021-04-01 19:42:48 +02002992 || lhs.lhs_dest == dest_global
Bram Moolenaar752fc692021-01-04 21:57:11 +01002993 || lhs.lhs_dest == dest_local))
Bram Moolenaar30fd8202020-09-26 15:09:30 +02002994 // ":const var": lock the value, but not referenced variables
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +02002995 generate_LOCKCONST(cctx);
2996
Bram Moolenaar10d6f182022-01-04 15:54:38 +00002997 if ((lhs.lhs_type->tt_type == VAR_DICT
Bram Moolenaar752fc692021-01-04 21:57:11 +01002998 || lhs.lhs_type->tt_type == VAR_LIST)
2999 && lhs.lhs_type->tt_member != NULL
Bram Moolenaare88c6b72022-02-15 15:37:11 +00003000 && lhs.lhs_type->tt_member != &t_any
Bram Moolenaar752fc692021-01-04 21:57:11 +01003001 && lhs.lhs_type->tt_member != &t_unknown)
Bram Moolenaaraa210a32021-01-02 15:41:03 +01003002 // Set the type in the list or dict, so that it can be checked,
Bram Moolenaar10d6f182022-01-04 15:54:38 +00003003 // also in legacy script.
Bram Moolenaar752fc692021-01-04 21:57:11 +01003004 generate_SETTYPE(cctx, lhs.lhs_type);
Bram Moolenaare88c6b72022-02-15 15:37:11 +00003005 else if (inferred_type != NULL
3006 && (inferred_type->tt_type == VAR_DICT
3007 || inferred_type->tt_type == VAR_LIST)
3008 && inferred_type->tt_member != NULL
3009 && inferred_type->tt_member != &t_unknown
3010 && inferred_type->tt_member != &t_any)
3011 // Set the type in the list or dict, so that it can be checked,
3012 // also in legacy script.
3013 generate_SETTYPE(cctx, inferred_type);
Bram Moolenaaraa210a32021-01-02 15:41:03 +01003014
Bram Moolenaar5cd64792021-12-25 18:23:24 +00003015 if (!skip_store && generate_store_lhs(cctx, &lhs,
3016 instr_count, is_decl) == FAIL)
Bram Moolenaar6977dba2021-07-04 22:48:12 +02003017 {
3018 cctx->ctx_lnum = save_lnum;
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02003019 goto theend;
Bram Moolenaar6977dba2021-07-04 22:48:12 +02003020 }
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02003021 }
Bram Moolenaar6977dba2021-07-04 22:48:12 +02003022 cctx->ctx_lnum = save_lnum;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02003023
3024 if (var_idx + 1 < var_count)
Bram Moolenaarab36e6a2021-11-30 16:14:49 +00003025 var_start = skipwhite(lhs.lhs_end + 1);
Bram Moolenaar65b0d162022-12-13 18:43:22 +00003026
3027 if (has_arg_is_set_prefix)
3028 {
3029 // set instruction index in JUMP_IF_ARG_SET to here
3030 isn_T *isn = ((isn_T *)instr->ga_data) + jump_instr_idx;
3031 isn->isn_arg.jumparg.jump_where = instr->ga_len;
3032 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003033 }
Bram Moolenaar47a519a2020-06-14 23:05:10 +02003034
Bram Moolenaar4d5dfe22021-06-26 13:59:29 +02003035 // For "[var, var] = expr" drop the "expr" value.
3036 // Also for "[var, var; _] = expr".
3037 if (var_count > 0 && (!semicolon || !did_generate_slice))
Bram Moolenaar9af78762020-06-16 11:34:42 +02003038 {
Bram Moolenaarec792292020-12-13 21:26:56 +01003039 if (generate_instr_drop(cctx, ISN_DROP, 1) == NULL)
Bram Moolenaar9af78762020-06-16 11:34:42 +02003040 goto theend;
3041 }
Bram Moolenaar47a519a2020-06-14 23:05:10 +02003042
Bram Moolenaarb2097502020-07-19 17:17:02 +02003043 ret = skipwhite(end);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003044
3045theend:
Bram Moolenaar752fc692021-01-04 21:57:11 +01003046 vim_free(lhs.lhs_name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003047 return ret;
3048}
3049
3050/*
Bram Moolenaar17126b12021-01-07 22:03:02 +01003051 * Check for an assignment at "eap->cmd", compile it if found.
3052 * Return NOTDONE if there is none, FAIL for failure, OK if done.
3053 */
3054 static int
3055may_compile_assignment(exarg_T *eap, char_u **line, cctx_T *cctx)
3056{
3057 char_u *pskip;
3058 char_u *p;
3059
3060 // Assuming the command starts with a variable or function name,
3061 // find what follows.
3062 // Skip over "var.member", "var[idx]" and the like.
3063 // Also "&opt = val", "$ENV = val" and "@r = val".
3064 pskip = (*eap->cmd == '&' || *eap->cmd == '$' || *eap->cmd == '@')
3065 ? eap->cmd + 1 : eap->cmd;
3066 p = to_name_end(pskip, TRUE);
3067 if (p > eap->cmd && *p != NUL)
3068 {
3069 char_u *var_end;
3070 int oplen;
3071 int heredoc;
3072
3073 if (eap->cmd[0] == '@')
3074 var_end = eap->cmd + 2;
3075 else
3076 var_end = find_name_end(pskip, NULL, NULL,
3077 FNE_CHECK_START | FNE_INCL_BR);
3078 oplen = assignment_len(skipwhite(var_end), &heredoc);
3079 if (oplen > 0)
3080 {
3081 size_t len = p - eap->cmd;
3082
3083 // Recognize an assignment if we recognize the variable
3084 // name:
Bram Moolenaar17126b12021-01-07 22:03:02 +01003085 // "&opt = expr"
3086 // "$ENV = expr"
3087 // "@r = expr"
Bram Moolenaar2e17fef2022-03-18 19:44:48 +00003088 // "g:var = expr"
3089 // "g:[key] = expr"
3090 // "local = expr" where "local" is a local var.
3091 // "script = expr" where "script" is a script-local var.
3092 // "import = expr" where "import" is an imported var
Bram Moolenaar17126b12021-01-07 22:03:02 +01003093 if (*eap->cmd == '&'
3094 || *eap->cmd == '$'
3095 || *eap->cmd == '@'
3096 || ((len) > 2 && eap->cmd[1] == ':')
Bram Moolenaar2e17fef2022-03-18 19:44:48 +00003097 || STRNCMP(eap->cmd, "g:[", 3) == 0
Bram Moolenaare0890d62021-02-17 14:52:14 +01003098 || variable_exists(eap->cmd, len, cctx))
Bram Moolenaar17126b12021-01-07 22:03:02 +01003099 {
3100 *line = compile_assignment(eap->cmd, eap, CMD_SIZE, cctx);
3101 if (*line == NULL || *line == eap->cmd)
3102 return FAIL;
3103 return OK;
3104 }
3105 }
3106 }
3107
Bram Moolenaar65b0d162022-12-13 18:43:22 +00003108 // might be "[var, var] = expr" or "ifargisset this.member = expr"
3109 if (*eap->cmd == '[' || STRNCMP(eap->cmd, "ifargisset ", 11) == 0)
Bram Moolenaar17126b12021-01-07 22:03:02 +01003110 {
Bram Moolenaar17126b12021-01-07 22:03:02 +01003111 *line = compile_assignment(eap->cmd, eap, CMD_SIZE, cctx);
3112 if (*line == NULL)
3113 return FAIL;
3114 if (*line != eap->cmd)
3115 return OK;
3116 }
3117 return NOTDONE;
3118}
3119
Bram Moolenaar9a015112021-12-31 14:06:45 +00003120/*
3121 * Check if arguments of "ufunc" shadow variables in "cctx".
3122 * Return OK or FAIL.
3123 */
3124 static int
3125check_args_shadowing(ufunc_T *ufunc, cctx_T *cctx)
3126{
3127 int i;
3128 char_u *arg;
3129 int r = OK;
3130
3131 // Make sure arguments are not found when compiling a second time.
3132 ufunc->uf_args_visible = 0;
3133
3134 // Check for arguments shadowing variables from the context.
3135 for (i = 0; i < ufunc->uf_args.ga_len; ++i)
3136 {
3137 arg = ((char_u **)(ufunc->uf_args.ga_data))[i];
Bram Moolenaardce24412022-02-08 20:35:30 +00003138 if (check_defined(arg, STRLEN(arg), cctx, NULL, TRUE) == FAIL)
Bram Moolenaar9a015112021-12-31 14:06:45 +00003139 {
3140 r = FAIL;
3141 break;
3142 }
3143 }
3144 ufunc->uf_args_visible = ufunc->uf_args.ga_len;
3145 return r;
3146}
3147
Bram Moolenaarfcb86b02022-10-07 22:46:24 +01003148#ifdef HAS_MESSAGE_WINDOW
Bram Moolenaar139575d2022-03-15 19:29:30 +00003149/*
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003150 * Get a count before a command. Can only be a number.
3151 * Returns zero if there is no count.
3152 * Returns -1 if there is something wrong.
3153 */
3154 static long
3155get_cmd_count(char_u *line, exarg_T *eap)
3156{
3157 char_u *p;
3158
3159 // skip over colons and white space
3160 for (p = line; *p == ':' || VIM_ISWHITE(*p); ++p)
3161 ;
Keith Thompson184f71c2024-01-04 21:19:04 +01003162 if (!SAFE_isdigit(*p))
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003163 {
Bram Moolenaar2435adf2022-10-21 12:05:46 +01003164 // The command or modifiers must be following. Assume a lower case
3165 // character means there is a modifier.
3166 if (p < eap->cmd && !vim_islower(*p))
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003167 {
3168 emsg(_(e_invalid_range));
3169 return -1;
3170 }
3171 return 0;
3172 }
3173 return atol((char *)p);
3174}
Bram Moolenaarfcb86b02022-10-07 22:46:24 +01003175#endif
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003176
3177/*
Bram Moolenaar139575d2022-03-15 19:29:30 +00003178 * Get the compilation type that should be used for "ufunc".
3179 * Keep in sync with INSTRUCTIONS().
3180 */
3181 compiletype_T
3182get_compile_type(ufunc_T *ufunc)
3183{
3184 // Update uf_has_breakpoint if needed.
3185 update_has_breakpoint(ufunc);
3186
3187 if (debug_break_level > 0 || may_break_in_function(ufunc))
3188 return CT_DEBUG;
3189#ifdef FEAT_PROFILE
3190 if (do_profiling == PROF_YES)
3191 {
Ernie Rael21d32122023-09-02 15:09:18 +02003192 if (!ufunc->uf_profiling && has_profiling(FALSE, ufunc->uf_name, NULL,
3193 &ufunc->uf_hash))
Bram Moolenaar139575d2022-03-15 19:29:30 +00003194 func_do_profile(ufunc);
3195 if (ufunc->uf_profiling)
3196 return CT_PROFILE;
3197 }
3198#endif
3199 return CT_NONE;
3200}
3201
Bram Moolenaar7b829262021-10-13 15:04:34 +01003202
3203/*
Bram Moolenaar09689a02020-05-09 22:50:08 +02003204 * Add a function to the list of :def functions.
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003205 * This sets "ufunc->uf_dfunc_idx" but the function isn't compiled yet.
Bram Moolenaar09689a02020-05-09 22:50:08 +02003206 */
Bram Moolenaar822ba242020-05-24 23:00:18 +02003207 static int
Bram Moolenaar09689a02020-05-09 22:50:08 +02003208add_def_function(ufunc_T *ufunc)
3209{
3210 dfunc_T *dfunc;
3211
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003212 if (def_functions.ga_len == 0)
3213 {
3214 // The first position is not used, so that a zero uf_dfunc_idx means it
3215 // wasn't set.
Bram Moolenaar35578162021-08-02 19:10:38 +02003216 if (GA_GROW_FAILS(&def_functions, 1))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003217 return FAIL;
3218 ++def_functions.ga_len;
3219 }
3220
Bram Moolenaar09689a02020-05-09 22:50:08 +02003221 // Add the function to "def_functions".
Bram Moolenaar35578162021-08-02 19:10:38 +02003222 if (GA_GROW_FAILS(&def_functions, 1))
Bram Moolenaar09689a02020-05-09 22:50:08 +02003223 return FAIL;
3224 dfunc = ((dfunc_T *)def_functions.ga_data) + def_functions.ga_len;
3225 CLEAR_POINTER(dfunc);
3226 dfunc->df_idx = def_functions.ga_len;
3227 ufunc->uf_dfunc_idx = dfunc->df_idx;
3228 dfunc->df_ufunc = ufunc;
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01003229 dfunc->df_name = vim_strsave(ufunc->uf_name);
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02003230 ga_init2(&dfunc->df_var_names, sizeof(char_u *), 10);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01003231 ++dfunc->df_refcount;
Bram Moolenaar09689a02020-05-09 22:50:08 +02003232 ++def_functions.ga_len;
3233 return OK;
3234}
3235
3236/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003237 * After ex_function() has collected all the function lines: parse and compile
3238 * the lines into instructions.
3239 * Adds the function to "def_functions".
Bram Moolenaar9e68c322020-12-25 12:38:04 +01003240 * When "check_return_type" is set then set ufunc->uf_ret_type to the type of
3241 * the return statement (used for lambda). When uf_ret_type is already set
3242 * then check that it matches.
Bram Moolenaarb2049902021-01-24 12:53:53 +01003243 * When "profiling" is true add ISN_PROF_START instructions.
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +02003244 * "outer_cctx" is set for a nested function.
Bram Moolenaar05afcee2020-03-31 23:32:31 +02003245 * This can be used recursively through compile_lambda(), which may reallocate
3246 * "def_functions".
Bram Moolenaar822ba242020-05-24 23:00:18 +02003247 * Returns OK or FAIL.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003248 */
Bram Moolenaar822ba242020-05-24 23:00:18 +02003249 int
Bram Moolenaarb2049902021-01-24 12:53:53 +01003250compile_def_function(
Bram Moolenaare99d4222021-06-13 14:01:26 +02003251 ufunc_T *ufunc,
3252 int check_return_type,
3253 compiletype_T compile_type,
3254 cctx_T *outer_cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003255{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003256 char_u *line = NULL;
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00003257 garray_T lines_to_free;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003258 char_u *p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003259 char *errormsg = NULL; // error message
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003260 cctx_T cctx;
3261 garray_T *instr;
Bram Moolenaard66960b2020-10-30 20:46:26 +01003262 int did_emsg_before = did_emsg;
Bram Moolenaar599410c2021-04-10 14:03:43 +02003263 int did_emsg_silent_before = did_emsg_silent;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003264 int ret = FAIL;
3265 sctx_T save_current_sctx = current_sctx;
Bram Moolenaarf4e8cdd2020-10-12 22:07:13 +02003266 int save_estack_compiling = estack_compiling;
Bram Moolenaardc4c2302021-04-25 13:54:42 +02003267 int save_cmod_flags = cmdmod.cmod_flags;
Bram Moolenaar25e0f582020-05-25 22:36:50 +02003268 int do_estack_push;
Bram Moolenaar6c4bfe42020-07-23 18:26:30 +02003269 int new_def_function = FALSE;
Bram Moolenaarf002a412021-01-24 13:34:18 +01003270#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01003271 int prof_lnum = -1;
Bram Moolenaarf002a412021-01-24 13:34:18 +01003272#endif
Bram Moolenaare99d4222021-06-13 14:01:26 +02003273 int debug_lnum = -1;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003274
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00003275 // allocated lines are freed at the end
3276 ga_init2(&lines_to_free, sizeof(char_u *), 50);
3277
Bram Moolenaar25e0f582020-05-25 22:36:50 +02003278 // When using a function that was compiled before: Free old instructions.
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01003279 // The index is reused. Otherwise add a new entry in "def_functions".
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003280 if (ufunc->uf_dfunc_idx > 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003281 {
Bram Moolenaar09689a02020-05-09 22:50:08 +02003282 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
3283 + ufunc->uf_dfunc_idx;
Bram Moolenaar3b814af2021-06-15 10:22:17 +02003284 isn_T *instr_dest = NULL;
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02003285
3286 switch (compile_type)
3287 {
3288 case CT_PROFILE:
3289#ifdef FEAT_PROFILE
3290 instr_dest = dfunc->df_instr_prof; break;
3291#endif
3292 case CT_NONE: instr_dest = dfunc->df_instr; break;
3293 case CT_DEBUG: instr_dest = dfunc->df_instr_debug; break;
3294 }
3295 if (instr_dest != NULL)
3296 // Was compiled in this mode before: Free old instructions.
3297 delete_def_function_contents(dfunc, FALSE);
3298 ga_clear_strings(&dfunc->df_var_names);
Bram Moolenaar1d84f762022-09-03 21:35:53 +01003299 dfunc->df_defer_var_idx = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003300 }
Bram Moolenaar6c4bfe42020-07-23 18:26:30 +02003301 else
3302 {
3303 if (add_def_function(ufunc) == FAIL)
3304 return FAIL;
3305 new_def_function = TRUE;
3306 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003307
Bram Moolenaar96923b72022-03-15 15:57:04 +00003308 if ((ufunc->uf_flags & FC_CLOSURE) && outer_cctx == NULL)
3309 {
3310 semsg(_(e_compiling_closure_without_context_str),
3311 printable_func_name(ufunc));
3312 return FAIL;
3313 }
3314
Bram Moolenaar985116a2020-07-12 17:31:09 +02003315 ufunc->uf_def_status = UF_COMPILING;
3316
Bram Moolenaara80faa82020-04-12 19:37:17 +02003317 CLEAR_FIELD(cctx);
Bram Moolenaarb2049902021-01-24 12:53:53 +01003318
Bram Moolenaare99d4222021-06-13 14:01:26 +02003319 cctx.ctx_compile_type = compile_type;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003320 cctx.ctx_ufunc = ufunc;
3321 cctx.ctx_lnum = -1;
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +02003322 cctx.ctx_outer = outer_cctx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003323 ga_init2(&cctx.ctx_locals, sizeof(lvar_T), 10);
Bram Moolenaar078a4612022-01-04 15:17:03 +00003324 // Each entry on the type stack consists of two type pointers.
3325 ga_init2(&cctx.ctx_type_stack, sizeof(type2_T), 50);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003326 cctx.ctx_type_list = &ufunc->uf_type_list;
3327 ga_init2(&cctx.ctx_instr, sizeof(isn_T), 50);
3328 instr = &cctx.ctx_instr;
3329
Bram Moolenaar25e0f582020-05-25 22:36:50 +02003330 // Set the context to the function, it may be compiled when called from
3331 // another script. Set the script version to the most modern one.
3332 // The line number will be set in next_line_from_context().
3333 current_sctx = ufunc->uf_script_ctx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003334 current_sctx.sc_version = SCRIPT_VERSION_VIM9;
3335
Bram Moolenaardc4c2302021-04-25 13:54:42 +02003336 // Don't use the flag from ":legacy" here.
3337 cmdmod.cmod_flags &= ~CMOD_LEGACY;
3338
Bram Moolenaar25e0f582020-05-25 22:36:50 +02003339 // Make sure error messages are OK.
3340 do_estack_push = !estack_top_is_ufunc(ufunc, 1);
3341 if (do_estack_push)
3342 estack_push_ufunc(ufunc, 1);
Bram Moolenaarf4e8cdd2020-10-12 22:07:13 +02003343 estack_compiling = TRUE;
Bram Moolenaar25e0f582020-05-25 22:36:50 +02003344
Bram Moolenaar9a015112021-12-31 14:06:45 +00003345 if (check_args_shadowing(ufunc, &cctx) == FAIL)
3346 goto erret;
3347
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003348 // For an object method and constructor "this" is the first local variable.
Bram Moolenaar574950d2023-01-03 19:08:50 +00003349 if (ufunc->uf_flags & (FC_OBJECT|FC_NEW))
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003350 {
3351 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
3352 + ufunc->uf_dfunc_idx;
3353 if (GA_GROW_FAILS(&dfunc->df_var_names, 1))
3354 goto erret;
3355 ((char_u **)dfunc->df_var_names.ga_data)[0] =
3356 vim_strsave((char_u *)"this");
3357 ++dfunc->df_var_names.ga_len;
3358
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00003359 // In the constructor allocate memory for the object and initialize the
3360 // object members.
Yegappan Lakshmanan1db15142023-09-19 20:34:05 +02003361 if (IS_CONSTRUCTOR_METHOD(ufunc))
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00003362 {
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003363 generate_CONSTRUCT(&cctx, ufunc->uf_class);
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00003364
3365 for (int i = 0; i < ufunc->uf_class->class_obj_member_count; ++i)
3366 {
Bram Moolenaard505d172022-12-18 21:42:55 +00003367 ocmember_T *m = &ufunc->uf_class->class_obj_members[i];
3368 if (m->ocm_init != NULL)
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00003369 {
Bram Moolenaard505d172022-12-18 21:42:55 +00003370 char_u *expr = m->ocm_init;
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00003371 if (compile_expr0(&expr, &cctx) == FAIL)
3372 goto erret;
Bram Moolenaard505d172022-12-18 21:42:55 +00003373 if (!ends_excmd2(m->ocm_init, expr))
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00003374 {
3375 semsg(_(e_trailing_characters_str), expr);
3376 goto erret;
3377 }
Yegappan Lakshmanan618e47d2023-08-22 21:29:28 +02003378
3379 type_T *type = get_type_on_stack(&cctx, 0);
Yegappan Lakshmananfe7b20a2023-10-04 19:47:52 +02003380 if (m->ocm_type->tt_type == VAR_ANY
Yegappan Lakshmanane5437c52023-12-16 14:11:19 +01003381 && !(m->ocm_flags & OCMFLAG_HAS_TYPE)
Yegappan Lakshmananfe7b20a2023-10-04 19:47:52 +02003382 && type->tt_type != VAR_SPECIAL)
3383 {
3384 // If the member variable type is not yet set, then use
3385 // the initialization expression type.
3386 m->ocm_type = type;
3387 }
3388 else if (m->ocm_type->tt_type != type->tt_type)
Yegappan Lakshmanan618e47d2023-08-22 21:29:28 +02003389 {
3390 // The type of the member initialization expression is
3391 // determined at run time. Add a runtime type check.
3392 where_T where = WHERE_INIT;
3393 where.wt_kind = WT_MEMBER;
3394 where.wt_func_name = (char *)m->ocm_name;
3395 if (need_type_where(type, m->ocm_type, FALSE, -1,
3396 where, &cctx, FALSE, FALSE) == FAIL)
3397 goto erret;
3398 }
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00003399 }
3400 else
Bram Moolenaard505d172022-12-18 21:42:55 +00003401 push_default_value(&cctx, m->ocm_type->tt_type,
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00003402 FALSE, NULL);
3403 generate_STORE_THIS(&cctx, i);
3404 }
3405 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003406 }
3407
Bram Moolenaar170fcfc2020-02-06 17:51:35 +01003408 if (ufunc->uf_def_args.ga_len > 0)
3409 {
3410 int count = ufunc->uf_def_args.ga_len;
Bram Moolenaar49cf7cc2020-04-07 22:45:00 +02003411 int first_def_arg = ufunc->uf_args.ga_len - count;
Bram Moolenaar170fcfc2020-02-06 17:51:35 +01003412 int i;
Bram Moolenaar170fcfc2020-02-06 17:51:35 +01003413 int off = STACK_FRAME_SIZE + (ufunc->uf_va_name != NULL ? 1 : 0);
Bram Moolenaarb8070e32020-07-23 20:56:04 +02003414 int did_set_arg_type = FALSE;
Bram Moolenaar170fcfc2020-02-06 17:51:35 +01003415
3416 // Produce instructions for the default values of optional arguments.
Bram Moolenaar12bce952021-03-11 20:04:04 +01003417 SOURCING_LNUM = 0; // line number unknown
Bram Moolenaar170fcfc2020-02-06 17:51:35 +01003418 for (i = 0; i < count; ++i)
3419 {
Bram Moolenaar65b0d162022-12-13 18:43:22 +00003420 char_u *arg = ((char_u **)(ufunc->uf_def_args.ga_data))[i];
3421 if (STRCMP(arg, "v:none") == 0)
3422 // "arg = v:none" means the argument is optional without
3423 // setting a value when the argument is missing.
3424 continue;
3425
Bram Moolenaar49cf7cc2020-04-07 22:45:00 +02003426 type_T *val_type;
3427 int arg_idx = first_def_arg + i;
Bram Moolenaar7a3fe3e2021-07-22 14:58:47 +02003428 where_T where = WHERE_INIT;
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +02003429 int jump_instr_idx = instr->ga_len;
3430 isn_T *isn;
3431
3432 // Use a JUMP_IF_ARG_SET instruction to skip if the value was given.
Bram Moolenaar65b0d162022-12-13 18:43:22 +00003433 if (generate_JUMP_IF_ARG(&cctx, ISN_JUMP_IF_ARG_SET,
3434 i - count - off) == FAIL)
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +02003435 goto erret;
Bram Moolenaar12bce952021-03-11 20:04:04 +01003436
3437 // Make sure later arguments are not found.
Bram Moolenaare28d9b32021-07-03 18:56:53 +02003438 ufunc->uf_args_visible = arg_idx;
Bram Moolenaar49cf7cc2020-04-07 22:45:00 +02003439
Bram Moolenaar65b0d162022-12-13 18:43:22 +00003440 int r = compile_expr0(&arg, &cctx);
Bram Moolenaar12bce952021-03-11 20:04:04 +01003441 if (r == FAIL)
Bram Moolenaar49cf7cc2020-04-07 22:45:00 +02003442 goto erret;
3443
3444 // If no type specified use the type of the default value.
3445 // Otherwise check that the default value type matches the
3446 // specified type.
Bram Moolenaar078a4612022-01-04 15:17:03 +00003447 val_type = get_type_on_stack(&cctx, 0);
Bram Moolenaarf785aa12021-02-11 21:19:34 +01003448 where.wt_index = arg_idx + 1;
LemonBoyc5d27442023-08-19 13:02:35 +02003449 where.wt_kind = WT_ARGUMENT;
Bram Moolenaar49cf7cc2020-04-07 22:45:00 +02003450 if (ufunc->uf_arg_types[arg_idx] == &t_unknown)
Bram Moolenaarb8070e32020-07-23 20:56:04 +02003451 {
3452 did_set_arg_type = TRUE;
Bram Moolenaar49cf7cc2020-04-07 22:45:00 +02003453 ufunc->uf_arg_types[arg_idx] = val_type;
Bram Moolenaarb8070e32020-07-23 20:56:04 +02003454 }
Bram Moolenaarfa46ead2021-12-22 13:18:39 +00003455 else if (need_type_where(val_type, ufunc->uf_arg_types[arg_idx],
Bram Moolenaarc6951a72022-12-29 20:56:24 +00003456 FALSE, -1, where, &cctx, FALSE, FALSE) == FAIL)
Bram Moolenaar49cf7cc2020-04-07 22:45:00 +02003457 goto erret;
Bram Moolenaar49cf7cc2020-04-07 22:45:00 +02003458
3459 if (generate_STORE(&cctx, ISN_STORE, i - count - off, NULL) == FAIL)
Bram Moolenaar170fcfc2020-02-06 17:51:35 +01003460 goto erret;
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +02003461
3462 // set instruction index in JUMP_IF_ARG_SET to here
3463 isn = ((isn_T *)instr->ga_data) + jump_instr_idx;
3464 isn->isn_arg.jumparg.jump_where = instr->ga_len;
Bram Moolenaar170fcfc2020-02-06 17:51:35 +01003465 }
Bram Moolenaarb8070e32020-07-23 20:56:04 +02003466
3467 if (did_set_arg_type)
3468 set_function_type(ufunc);
Bram Moolenaar170fcfc2020-02-06 17:51:35 +01003469 }
Bram Moolenaare28d9b32021-07-03 18:56:53 +02003470 ufunc->uf_args_visible = ufunc->uf_args.ga_len;
Bram Moolenaar170fcfc2020-02-06 17:51:35 +01003471
Bram Moolenaarb8bebd02023-01-30 20:24:23 +00003472 // Compiling a function in an interface is done to get the function type.
3473 // No code is actually compiled.
3474 if (ufunc->uf_class != NULL
3475 && (ufunc->uf_class->class_flags & CLASS_INTERFACE))
3476 {
3477 ufunc->uf_def_status = UF_NOT_COMPILED;
3478 ret = OK;
3479 goto erret;
3480 }
3481
Bram Moolenaar170fcfc2020-02-06 17:51:35 +01003482 /*
3483 * Loop over all the lines of the function and generate instructions.
3484 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003485 for (;;)
3486 {
Bram Moolenaar2dd0a2c2020-08-08 15:10:27 +02003487 exarg_T ea;
Bram Moolenaar2dd0a2c2020-08-08 15:10:27 +02003488 int starts_with_colon = FALSE;
3489 char_u *cmd;
Bram Moolenaar02194d22020-10-24 23:08:38 +02003490 cmdmod_T local_cmdmod;
Bram Moolenaar5b1c8fe2020-02-21 18:42:43 +01003491
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003492 // Bail out on the first error to avoid a flood of errors and report
3493 // the right line number when inside try/catch.
Bram Moolenaard66960b2020-10-30 20:46:26 +01003494 if (did_emsg_before != did_emsg)
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003495 goto erret;
3496
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003497 if (line != NULL && *line == '|')
3498 // the line continues after a '|'
3499 ++line;
Bram Moolenaara3b7fdc2020-06-21 14:12:17 +02003500 else if (line != NULL && *skipwhite(line) != NUL
Bram Moolenaar7a092242020-04-16 22:10:49 +02003501 && !(*line == '#' && (line == cctx.ctx_line_start
3502 || VIM_ISWHITE(line[-1]))))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003503 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00003504 semsg(_(e_trailing_characters_str), line);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003505 goto erret;
3506 }
Bram Moolenaar4b3e1962021-03-18 21:37:55 +01003507 else if (line != NULL && vim9_bad_comment(skipwhite(line)))
3508 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003509 else
3510 {
Bram Moolenaar23c55272020-06-21 16:58:13 +02003511 line = next_line_from_context(&cctx, FALSE);
Bram Moolenaar4fdae992020-04-12 16:38:57 +02003512 if (cctx.ctx_lnum >= ufunc->uf_lines.ga_len)
Bram Moolenaarb2049902021-01-24 12:53:53 +01003513 {
Bram Moolenaarcb711ab2020-04-16 13:00:29 +02003514 // beyond the last line
Bram Moolenaarf002a412021-01-24 13:34:18 +01003515#ifdef FEAT_PROFILE
Bram Moolenaarced68a02021-01-24 17:53:47 +01003516 if (cctx.ctx_skip != SKIP_YES)
3517 may_generate_prof_end(&cctx, prof_lnum);
Bram Moolenaarf002a412021-01-24 13:34:18 +01003518#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003519 break;
Bram Moolenaarb2049902021-01-24 12:53:53 +01003520 }
Bram Moolenaarf62d7392021-04-14 12:40:00 +02003521 // Make a copy, splitting off nextcmd and removing trailing spaces
3522 // may change it.
3523 if (line != NULL)
3524 {
3525 line = vim_strsave(line);
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00003526 if (ga_add_string(&lines_to_free, line) == FAIL)
3527 goto erret;
Bram Moolenaarf62d7392021-04-14 12:40:00 +02003528 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003529 }
3530
Bram Moolenaara80faa82020-04-12 19:37:17 +02003531 CLEAR_FIELD(ea);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003532 ea.cmdlinep = &line;
3533 ea.cmd = skipwhite(line);
Bram Moolenaar97f8c102022-04-02 19:43:57 +01003534 ea.skip = cctx.ctx_skip == SKIP_YES;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003535
Bram Moolenaarb2049902021-01-24 12:53:53 +01003536 if (*ea.cmd == '#')
3537 {
Bram Moolenaarad6d9cc2022-08-08 21:43:11 +01003538 // "#" starts a comment, but "#{" is an error
3539 if (vim9_bad_comment(ea.cmd))
3540 goto erret;
Bram Moolenaarb2049902021-01-24 12:53:53 +01003541 line = (char_u *)"";
3542 continue;
3543 }
3544
Bram Moolenaarf002a412021-01-24 13:34:18 +01003545#ifdef FEAT_PROFILE
Bram Moolenaare99d4222021-06-13 14:01:26 +02003546 if (cctx.ctx_compile_type == CT_PROFILE && cctx.ctx_lnum != prof_lnum
3547 && cctx.ctx_skip != SKIP_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01003548 {
3549 may_generate_prof_end(&cctx, prof_lnum);
3550
3551 prof_lnum = cctx.ctx_lnum;
3552 generate_instr(&cctx, ISN_PROF_START);
3553 }
Bram Moolenaarf002a412021-01-24 13:34:18 +01003554#endif
Bram Moolenaare99d4222021-06-13 14:01:26 +02003555 if (cctx.ctx_compile_type == CT_DEBUG && cctx.ctx_lnum != debug_lnum
3556 && cctx.ctx_skip != SKIP_YES)
3557 {
3558 debug_lnum = cctx.ctx_lnum;
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02003559 generate_instr_debug(&cctx);
Bram Moolenaare99d4222021-06-13 14:01:26 +02003560 }
Bram Moolenaar8cec9272021-06-23 20:20:53 +02003561 cctx.ctx_prev_lnum = cctx.ctx_lnum + 1;
Bram Moolenaarb2049902021-01-24 12:53:53 +01003562
Bram Moolenaarcb711ab2020-04-16 13:00:29 +02003563 // Some things can be recognized by the first character.
3564 switch (*ea.cmd)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003565 {
Bram Moolenaarcb711ab2020-04-16 13:00:29 +02003566 case '}':
3567 {
3568 // "}" ends a block scope
3569 scopetype_T stype = cctx.ctx_scope == NULL
3570 ? NO_SCOPE : cctx.ctx_scope->se_type;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003571
Bram Moolenaarcb711ab2020-04-16 13:00:29 +02003572 if (stype == BLOCK_SCOPE)
3573 {
3574 compile_endblock(&cctx);
3575 line = ea.cmd;
3576 }
3577 else
3578 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003579 emsg(_(e_using_rcurly_outside_if_block_scope));
Bram Moolenaarcb711ab2020-04-16 13:00:29 +02003580 goto erret;
3581 }
3582 if (line != NULL)
3583 line = skipwhite(ea.cmd + 1);
3584 continue;
3585 }
3586
3587 case '{':
3588 // "{" starts a block scope
3589 // "{'a': 1}->func() is something else
3590 if (ends_excmd(*skipwhite(ea.cmd + 1)))
3591 {
3592 line = compile_block(ea.cmd, &cctx);
3593 continue;
3594 }
3595 break;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003596 }
3597
3598 /*
3599 * COMMAND MODIFIERS
3600 */
Bram Moolenaar02194d22020-10-24 23:08:38 +02003601 cctx.ctx_has_cmdmod = FALSE;
Bram Moolenaare1004402020-10-24 20:49:43 +02003602 if (parse_command_modifiers(&ea, &errormsg, &local_cmdmod, FALSE)
3603 == FAIL)
Bram Moolenaarbc510062022-02-14 21:19:04 +00003604 goto erret;
Bram Moolenaare1004402020-10-24 20:49:43 +02003605 generate_cmdmods(&cctx, &local_cmdmod);
3606 undo_cmdmod(&local_cmdmod);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003607
Bram Moolenaare88c8e82020-11-01 17:03:37 +01003608 // Check if there was a colon after the last command modifier or before
3609 // the current position.
3610 for (p = ea.cmd; p >= line; --p)
3611 {
3612 if (*p == ':')
3613 starts_with_colon = TRUE;
3614 if (p < ea.cmd && !VIM_ISWHITE(*p))
3615 break;
3616 }
3617
Bram Moolenaarce024c32021-06-26 13:00:49 +02003618 // Skip ":call" to get to the function name, unless using :legacy
Bram Moolenaar575f24b2020-08-12 14:21:11 +02003619 p = ea.cmd;
Bram Moolenaarce024c32021-06-26 13:00:49 +02003620 if (!(local_cmdmod.cmod_flags & CMOD_LEGACY))
Bram Moolenaar575f24b2020-08-12 14:21:11 +02003621 {
Bram Moolenaarce024c32021-06-26 13:00:49 +02003622 if (checkforcmd(&ea.cmd, "call", 3))
3623 {
3624 if (*ea.cmd == '(')
3625 // not for "call()"
3626 ea.cmd = p;
3627 else
3628 ea.cmd = skipwhite(ea.cmd);
3629 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003630
Bram Moolenaarce024c32021-06-26 13:00:49 +02003631 if (!starts_with_colon)
3632 {
3633 int assign;
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02003634
Bram Moolenaarce024c32021-06-26 13:00:49 +02003635 // Check for assignment after command modifiers.
3636 assign = may_compile_assignment(&ea, &line, &cctx);
3637 if (assign == OK)
3638 goto nextline;
3639 if (assign == FAIL)
3640 goto erret;
3641 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003642 }
3643
3644 /*
3645 * COMMAND after range
Bram Moolenaar3d48e252020-07-15 14:15:52 +02003646 * 'text'->func() should not be confused with 'a mark
Bram Moolenaarc1e6c7b2022-02-20 18:26:46 +00003647 * 0z1234->func() should not be confused with a zero line number
Bram Moolenaarbdc0f1c2021-04-24 19:08:24 +02003648 * "++nr" and "--nr" are eval commands
Bram Moolenaar5ca5cc62021-08-24 21:56:03 +02003649 * in "$ENV->func()" the "$" is not a range
Bram Moolenaar31d99482022-05-26 22:24:43 +01003650 * "123->func()" is a method call
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003651 */
Bram Moolenaardf069ee2020-06-22 23:02:51 +02003652 cmd = ea.cmd;
Bram Moolenaarb579f6e2021-12-04 11:57:00 +00003653 if ((*cmd != '$' || starts_with_colon)
Bram Moolenaarc1e6c7b2022-02-20 18:26:46 +00003654 && (starts_with_colon
3655 || !(*cmd == '\''
3656 || (cmd[0] == '0' && cmd[1] == 'z')
3657 || (cmd[0] != NUL && cmd[0] == cmd[1]
Bram Moolenaar31d99482022-05-26 22:24:43 +01003658 && (*cmd == '+' || *cmd == '-'))
3659 || number_method(cmd))))
Bram Moolenaardf069ee2020-06-22 23:02:51 +02003660 {
Bram Moolenaar3bd8de42020-09-14 16:37:34 +02003661 ea.cmd = skip_range(ea.cmd, TRUE, NULL);
Bram Moolenaar5d72ce62020-08-20 23:04:06 +02003662 if (ea.cmd > cmd)
Bram Moolenaar3d48e252020-07-15 14:15:52 +02003663 {
Bram Moolenaarb579f6e2021-12-04 11:57:00 +00003664 if (!starts_with_colon
3665 && !(local_cmdmod.cmod_flags & CMOD_LEGACY))
Bram Moolenaar5d72ce62020-08-20 23:04:06 +02003666 {
Bram Moolenaar6e2c2c52020-12-25 19:25:45 +01003667 semsg(_(e_colon_required_before_range_str), cmd);
Bram Moolenaar5d72ce62020-08-20 23:04:06 +02003668 goto erret;
3669 }
Bram Moolenaarada1d872021-02-20 08:16:51 +01003670 ea.addr_count = 1;
Bram Moolenaar5d72ce62020-08-20 23:04:06 +02003671 if (ends_excmd2(line, ea.cmd))
3672 {
3673 // A range without a command: jump to the line.
Bram Moolenaare4eed8c2021-12-01 15:22:56 +00003674 generate_EXEC(&cctx, ISN_EXECRANGE,
Bram Moolenaarb579f6e2021-12-04 11:57:00 +00003675 vim_strnsave(cmd, ea.cmd - cmd));
Bram Moolenaare4eed8c2021-12-01 15:22:56 +00003676 line = ea.cmd;
Bram Moolenaar5d72ce62020-08-20 23:04:06 +02003677 goto nextline;
3678 }
Bram Moolenaar3d48e252020-07-15 14:15:52 +02003679 }
Bram Moolenaardf069ee2020-06-22 23:02:51 +02003680 }
Bram Moolenaar47bc9c32021-07-17 21:24:56 +02003681 p = find_ex_command(&ea, NULL,
3682 starts_with_colon || (local_cmdmod.cmod_flags & CMOD_LEGACY)
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003683 ? NULL : item_exists, &cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003684
Bram Moolenaard1510ee2021-01-04 16:15:58 +01003685 if (p == NULL)
3686 {
3687 if (cctx.ctx_skip != SKIP_YES)
Bram Moolenaarbed34f02022-01-19 20:48:37 +00003688 semsg(_(e_ambiguous_use_of_user_defined_command_str), ea.cmd);
Bram Moolenaard1510ee2021-01-04 16:15:58 +01003689 goto erret;
3690 }
3691
Bram Moolenaar96cf4ba2021-04-24 14:15:41 +02003692 // When using ":legacy cmd" always use compile_exec().
3693 if (local_cmdmod.cmod_flags & CMOD_LEGACY)
Bram Moolenaar3b1373b2021-05-17 00:01:42 +02003694 {
3695 char_u *start = ea.cmd;
3696
Bram Moolenaarc3cb1c92021-06-02 16:47:53 +02003697 switch (ea.cmdidx)
3698 {
3699 case CMD_if:
3700 case CMD_elseif:
3701 case CMD_else:
3702 case CMD_endif:
3703 case CMD_for:
3704 case CMD_endfor:
3705 case CMD_continue:
3706 case CMD_break:
3707 case CMD_while:
3708 case CMD_endwhile:
3709 case CMD_try:
3710 case CMD_catch:
3711 case CMD_finally:
3712 case CMD_endtry:
3713 semsg(_(e_cannot_use_legacy_with_command_str), ea.cmd);
3714 goto erret;
3715 default: break;
3716 }
3717
Bram Moolenaar3b1373b2021-05-17 00:01:42 +02003718 // ":legacy return expr" needs to be handled differently.
3719 if (checkforcmd(&start, "return", 4))
3720 ea.cmdidx = CMD_return;
3721 else
3722 ea.cmdidx = CMD_legacy;
3723 }
Bram Moolenaar96cf4ba2021-04-24 14:15:41 +02003724
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003725 if (p == ea.cmd && ea.cmdidx != CMD_SIZE)
3726 {
Bram Moolenaar97f8c102022-04-02 19:43:57 +01003727 // "eval" is used for "val->func()" and "var" for "var = val", then
3728 // "p" is equal to "ea.cmd" for a valid command.
3729 if (ea.cmdidx == CMD_eval || ea.cmdidx == CMD_var)
3730 ;
3731 else if (cctx.ctx_skip == SKIP_YES)
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003732 {
3733 line += STRLEN(line);
Bram Moolenaarf665e972020-12-05 19:17:16 +01003734 goto nextline;
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003735 }
Bram Moolenaar97f8c102022-04-02 19:43:57 +01003736 else
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003737 {
Bram Moolenaar52c124d2020-12-20 21:43:35 +01003738 semsg(_(e_command_not_recognized_str), ea.cmd);
Bram Moolenaar007f9d62020-07-06 23:04:49 +02003739 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003740 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003741 }
3742
Bram Moolenaara2c00282023-05-14 22:05:15 +01003743 if ((cctx.ctx_had_return || cctx.ctx_had_throw)
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003744 && ea.cmdidx != CMD_elseif
3745 && ea.cmdidx != CMD_else
Bram Moolenaarefd88552020-06-18 20:50:10 +02003746 && ea.cmdidx != CMD_endif
3747 && ea.cmdidx != CMD_endfor
3748 && ea.cmdidx != CMD_endwhile
3749 && ea.cmdidx != CMD_catch
3750 && ea.cmdidx != CMD_finally
Bram Moolenaar9d383f32023-05-14 21:38:12 +01003751 && ea.cmdidx != CMD_endtry
3752 && !ignore_unreachable_code_for_testing)
Bram Moolenaarefd88552020-06-18 20:50:10 +02003753 {
Bram Moolenaara2c00282023-05-14 22:05:15 +01003754 semsg(_(e_unreachable_code_after_str),
3755 cctx.ctx_had_return ? "return" : "throw");
Bram Moolenaar3988f642020-08-27 22:43:03 +02003756 goto erret;
Bram Moolenaarefd88552020-06-18 20:50:10 +02003757 }
Bram Moolenaara2c00282023-05-14 22:05:15 +01003758 cctx.ctx_had_throw = FALSE;
Bram Moolenaarefd88552020-06-18 20:50:10 +02003759
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +02003760 p = skipwhite(p);
3761 if (ea.cmdidx != CMD_SIZE
3762 && ea.cmdidx != CMD_write && ea.cmdidx != CMD_read)
3763 {
Bram Moolenaar9b123d82020-09-14 22:39:11 +02003764 if (ea.cmdidx >= 0)
3765 ea.argt = excmd_get_argt(ea.cmdidx);
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +02003766 if ((ea.argt & EX_BANG) && *p == '!')
3767 {
3768 ea.forceit = TRUE;
3769 p = skipwhite(p + 1);
3770 }
Bram Moolenaar09d94212022-05-05 15:20:03 +01003771 if ((ea.argt & EX_RANGE) == 0 && ea.addr_count > 0)
3772 {
3773 emsg(_(e_no_range_allowed));
3774 goto erret;
3775 }
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +02003776 }
3777
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003778 switch (ea.cmdidx)
3779 {
3780 case CMD_def:
Bram Moolenaar38453522021-11-28 22:00:12 +00003781 case CMD_function:
Bram Moolenaar04b12692020-05-04 23:24:44 +02003782 ea.arg = p;
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00003783 line = compile_nested_function(&ea, &cctx, &lines_to_free);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003784 break;
3785
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003786 case CMD_return:
Bram Moolenaar3b1373b2021-05-17 00:01:42 +02003787 line = compile_return(p, check_return_type,
3788 local_cmdmod.cmod_flags & CMOD_LEGACY, &cctx);
Bram Moolenaarefd88552020-06-18 20:50:10 +02003789 cctx.ctx_had_return = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003790 break;
3791
3792 case CMD_let:
Bram Moolenaarc58f5452020-10-21 20:58:52 +02003793 emsg(_(e_cannot_use_let_in_vim9_script));
3794 break;
Bram Moolenaar30fd8202020-09-26 15:09:30 +02003795 case CMD_var:
3796 case CMD_final:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003797 case CMD_const:
Bram Moolenaarbdc0f1c2021-04-24 19:08:24 +02003798 case CMD_increment:
3799 case CMD_decrement:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003800 line = compile_assignment(p, &ea, ea.cmdidx, &cctx);
Bram Moolenaar47a519a2020-06-14 23:05:10 +02003801 if (line == p)
Bram Moolenaar8b716f52022-02-15 21:17:56 +00003802 {
3803 emsg(_(e_invalid_assignment));
Bram Moolenaar47a519a2020-06-14 23:05:10 +02003804 line = NULL;
Bram Moolenaar8b716f52022-02-15 21:17:56 +00003805 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003806 break;
3807
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02003808 case CMD_unlet:
3809 case CMD_unlockvar:
3810 case CMD_lockvar:
3811 line = compile_unletlock(p, &ea, &cctx);
3812 break;
3813
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003814 case CMD_import:
Bram Moolenaar4db572e2021-07-18 18:21:38 +02003815 emsg(_(e_import_can_only_be_used_in_script));
3816 line = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003817 break;
3818
3819 case CMD_if:
3820 line = compile_if(p, &cctx);
3821 break;
3822 case CMD_elseif:
3823 line = compile_elseif(p, &cctx);
Bram Moolenaarefd88552020-06-18 20:50:10 +02003824 cctx.ctx_had_return = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003825 break;
3826 case CMD_else:
3827 line = compile_else(p, &cctx);
Bram Moolenaarefd88552020-06-18 20:50:10 +02003828 cctx.ctx_had_return = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003829 break;
3830 case CMD_endif:
3831 line = compile_endif(p, &cctx);
3832 break;
3833
3834 case CMD_while:
3835 line = compile_while(p, &cctx);
3836 break;
3837 case CMD_endwhile:
3838 line = compile_endwhile(p, &cctx);
Bram Moolenaarefd88552020-06-18 20:50:10 +02003839 cctx.ctx_had_return = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003840 break;
3841
3842 case CMD_for:
3843 line = compile_for(p, &cctx);
3844 break;
3845 case CMD_endfor:
3846 line = compile_endfor(p, &cctx);
Bram Moolenaarefd88552020-06-18 20:50:10 +02003847 cctx.ctx_had_return = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003848 break;
3849 case CMD_continue:
3850 line = compile_continue(p, &cctx);
3851 break;
3852 case CMD_break:
3853 line = compile_break(p, &cctx);
3854 break;
3855
3856 case CMD_try:
3857 line = compile_try(p, &cctx);
3858 break;
3859 case CMD_catch:
3860 line = compile_catch(p, &cctx);
Bram Moolenaarefd88552020-06-18 20:50:10 +02003861 cctx.ctx_had_return = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003862 break;
3863 case CMD_finally:
3864 line = compile_finally(p, &cctx);
Bram Moolenaarefd88552020-06-18 20:50:10 +02003865 cctx.ctx_had_return = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003866 break;
3867 case CMD_endtry:
3868 line = compile_endtry(p, &cctx);
3869 break;
3870 case CMD_throw:
3871 line = compile_throw(p, &cctx);
Bram Moolenaara2c00282023-05-14 22:05:15 +01003872 cctx.ctx_had_throw = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003873 break;
3874
Bram Moolenaar007f9d62020-07-06 23:04:49 +02003875 case CMD_eval:
Bram Moolenaarc3235272021-07-10 19:42:03 +02003876 line = compile_eval(p, &cctx);
Bram Moolenaar007f9d62020-07-06 23:04:49 +02003877 break;
3878
Bram Moolenaar1d84f762022-09-03 21:35:53 +01003879 case CMD_defer:
3880 line = compile_defer(p, &cctx);
3881 break;
3882
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003883#ifdef HAS_MESSAGE_WINDOW
3884 case CMD_echowindow:
3885 {
3886 long cmd_count = get_cmd_count(line, &ea);
Bram Moolenaar2eae3d22022-10-07 15:09:27 +01003887 if (cmd_count < 0)
3888 line = NULL;
3889 else
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003890 line = compile_mult_expr(p, ea.cmdidx,
3891 cmd_count, &cctx);
3892 }
3893 break;
3894#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003895 case CMD_echo:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003896 case CMD_echon:
Bram Moolenaar7de62622021-08-07 15:05:47 +02003897 case CMD_echoconsole:
Bram Moolenaar7d7ad7b2022-09-01 16:00:53 +01003898 case CMD_echoerr:
3899 case CMD_echomsg:
Bram Moolenaar7d7ad7b2022-09-01 16:00:53 +01003900 case CMD_execute:
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003901 line = compile_mult_expr(p, ea.cmdidx, 0, &cctx);
Bram Moolenaarad39c092020-02-26 18:23:43 +01003902 break;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003903
Bram Moolenaarc3516f72020-09-08 22:45:35 +02003904 case CMD_put:
3905 ea.cmd = cmd;
3906 line = compile_put(p, &ea, &cctx);
3907 break;
3908
Bram Moolenaar4c137212021-04-19 16:48:48 +02003909 case CMD_substitute:
Bram Moolenaar7b829262021-10-13 15:04:34 +01003910 if (check_global_and_subst(ea.cmd, p) == FAIL)
3911 goto erret;
Bram Moolenaar4c137212021-04-19 16:48:48 +02003912 if (cctx.ctx_skip == SKIP_YES)
3913 line = (char_u *)"";
3914 else
3915 {
3916 ea.arg = p;
3917 line = compile_substitute(line, &ea, &cctx);
3918 }
3919 break;
3920
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02003921 case CMD_redir:
3922 ea.arg = p;
3923 line = compile_redir(line, &ea, &cctx);
3924 break;
3925
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02003926 case CMD_cexpr:
3927 case CMD_lexpr:
3928 case CMD_caddexpr:
3929 case CMD_laddexpr:
3930 case CMD_cgetexpr:
3931 case CMD_lgetexpr:
Bram Moolenaarb7c97812021-05-05 22:51:39 +02003932#ifdef FEAT_QUICKFIX
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02003933 ea.arg = p;
3934 line = compile_cexpr(line, &ea, &cctx);
Bram Moolenaarb7c97812021-05-05 22:51:39 +02003935#else
3936 ex_ni(&ea);
3937 line = NULL;
3938#endif
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02003939 break;
3940
Bram Moolenaarae616492020-07-28 20:07:27 +02003941 case CMD_append:
3942 case CMD_change:
3943 case CMD_insert:
Bram Moolenaar10b94212021-02-19 21:42:57 +01003944 case CMD_k:
Bram Moolenaarf5a48012020-08-01 17:00:03 +02003945 case CMD_t:
Bram Moolenaarae616492020-07-28 20:07:27 +02003946 case CMD_xit:
3947 not_in_vim9(&ea);
3948 goto erret;
3949
Bram Moolenaar002262f2020-07-08 17:47:57 +02003950 case CMD_SIZE:
Bram Moolenaar3988f642020-08-27 22:43:03 +02003951 if (cctx.ctx_skip != SKIP_YES)
3952 {
3953 semsg(_(e_invalid_command_str), ea.cmd);
3954 goto erret;
3955 }
3956 // We don't check for a next command here.
3957 line = (char_u *)"";
3958 break;
Bram Moolenaar002262f2020-07-08 17:47:57 +02003959
Bram Moolenaar20677332021-06-06 17:02:53 +02003960 case CMD_lua:
3961 case CMD_mzscheme:
3962 case CMD_perl:
3963 case CMD_py3:
3964 case CMD_python3:
3965 case CMD_python:
3966 case CMD_pythonx:
3967 case CMD_ruby:
3968 case CMD_tcl:
3969 ea.arg = p;
3970 if (vim_strchr(line, '\n') == NULL)
Bram Moolenaar5163fcc2020-08-27 23:37:09 +02003971 line = compile_exec(line, &ea, &cctx);
Bram Moolenaar20677332021-06-06 17:02:53 +02003972 else
3973 // heredoc lines have been concatenated with NL
3974 // characters in get_function_body()
3975 line = compile_script(line, &cctx);
3976 break;
3977
Bram Moolenaar107f7322022-02-06 17:30:41 +00003978 case CMD_vim9script:
Bram Moolenaar8cbf2492022-02-06 20:28:13 +00003979 if (cctx.ctx_skip != SKIP_YES)
3980 {
3981 emsg(_(e_vim9script_can_only_be_used_in_script));
3982 goto erret;
3983 }
3984 line = (char_u *)"";
3985 break;
Bram Moolenaar107f7322022-02-06 17:30:41 +00003986
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02003987 case CMD_type:
3988 emsg(_(e_type_can_only_be_used_in_script));
3989 goto erret;
3990 break;
3991
Bram Moolenaar7b829262021-10-13 15:04:34 +01003992 case CMD_global:
3993 if (check_global_and_subst(ea.cmd, p) == FAIL)
3994 goto erret;
3995 // FALLTHROUGH
Bram Moolenaar20677332021-06-06 17:02:53 +02003996 default:
3997 // Not recognized, execute with do_cmdline_cmd().
3998 ea.arg = p;
3999 line = compile_exec(line, &ea, &cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004000 break;
4001 }
Bram Moolenaar5d72ce62020-08-20 23:04:06 +02004002nextline:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004003 if (line == NULL)
4004 goto erret;
Bram Moolenaar585fea72020-04-02 22:33:21 +02004005 line = skipwhite(line);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004006
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +02004007 // Undo any command modifiers.
Bram Moolenaar02194d22020-10-24 23:08:38 +02004008 generate_undo_cmdmods(&cctx);
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +02004009
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004010 if (cctx.ctx_type_stack.ga_len < 0)
4011 {
4012 iemsg("Type stack underflow");
4013 goto erret;
4014 }
Bram Moolenaarb8bebd02023-01-30 20:24:23 +00004015 } // END of the loop over all the function body lines.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004016
4017 if (cctx.ctx_scope != NULL)
4018 {
4019 if (cctx.ctx_scope->se_type == IF_SCOPE)
Bram Moolenaar1a992222021-12-31 17:25:48 +00004020 emsg(_(e_missing_endif));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004021 else if (cctx.ctx_scope->se_type == WHILE_SCOPE)
Bram Moolenaar1a992222021-12-31 17:25:48 +00004022 emsg(_(e_missing_endwhile));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004023 else if (cctx.ctx_scope->se_type == FOR_SCOPE)
Bram Moolenaar1a992222021-12-31 17:25:48 +00004024 emsg(_(e_missing_endfor));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004025 else
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004026 emsg(_(e_missing_rcurly));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004027 goto erret;
4028 }
4029
Bram Moolenaara2c00282023-05-14 22:05:15 +01004030 // TODO: if a function ends in "throw" but there was a return elsewhere we
4031 // should not assume the return type is "void".
4032 if (!cctx.ctx_had_return && !cctx.ctx_had_throw)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004033 {
Bram Moolenaare6174fd2021-06-12 18:30:56 +02004034 if (ufunc->uf_ret_type->tt_type == VAR_UNKNOWN)
4035 ufunc->uf_ret_type = &t_void;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004036 else if (ufunc->uf_ret_type->tt_type != VAR_VOID
Yegappan Lakshmanan1db15142023-09-19 20:34:05 +02004037 && !IS_CONSTRUCTOR_METHOD(ufunc))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004038 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004039 emsg(_(e_missing_return_statement));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004040 goto erret;
4041 }
4042
Bram Moolenaarf57b43c2021-06-15 22:13:27 +02004043 // Return void if there is no return at the end.
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004044 // For a constructor return the object.
Yegappan Lakshmanan1db15142023-09-19 20:34:05 +02004045 if (IS_CONSTRUCTOR_METHOD(ufunc))
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00004046 {
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004047 generate_instr(&cctx, ISN_RETURN_OBJECT);
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00004048 ufunc->uf_ret_type = &ufunc->uf_class->class_object_type;
4049 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004050 else
4051 generate_instr(&cctx, ISN_RETURN_VOID);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004052 }
4053
Bram Moolenaar599410c2021-04-10 14:03:43 +02004054 // When compiled with ":silent!" and there was an error don't consider the
4055 // function compiled.
4056 if (emsg_silent == 0 || did_emsg_silent == did_emsg_silent_before)
Bram Moolenaar05afcee2020-03-31 23:32:31 +02004057 {
4058 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
4059 + ufunc->uf_dfunc_idx;
4060 dfunc->df_deleted = FALSE;
Bram Moolenaar4aab88d2020-12-24 21:56:41 +01004061 dfunc->df_script_seq = current_sctx.sc_seq;
Bram Moolenaarf002a412021-01-24 13:34:18 +01004062#ifdef FEAT_PROFILE
Bram Moolenaare99d4222021-06-13 14:01:26 +02004063 if (cctx.ctx_compile_type == CT_PROFILE)
Bram Moolenaarb2049902021-01-24 12:53:53 +01004064 {
4065 dfunc->df_instr_prof = instr->ga_data;
4066 dfunc->df_instr_prof_count = instr->ga_len;
4067 }
4068 else
Bram Moolenaarf002a412021-01-24 13:34:18 +01004069#endif
Bram Moolenaare99d4222021-06-13 14:01:26 +02004070 if (cctx.ctx_compile_type == CT_DEBUG)
4071 {
4072 dfunc->df_instr_debug = instr->ga_data;
4073 dfunc->df_instr_debug_count = instr->ga_len;
4074 }
4075 else
Bram Moolenaarb2049902021-01-24 12:53:53 +01004076 {
4077 dfunc->df_instr = instr->ga_data;
4078 dfunc->df_instr_count = instr->ga_len;
4079 }
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02004080 dfunc->df_varcount = dfunc->df_var_names.ga_len;
Bram Moolenaar148ce7a2020-09-23 21:57:23 +02004081 dfunc->df_has_closure = cctx.ctx_has_closure;
Bram Moolenaarb46c0832022-09-15 17:19:37 +01004082
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +02004083 if (cctx.ctx_outer_used)
Bram Moolenaarb46c0832022-09-15 17:19:37 +01004084 {
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +02004085 ufunc->uf_flags |= FC_CLOSURE;
Bram Moolenaarb46c0832022-09-15 17:19:37 +01004086 if (outer_cctx != NULL)
4087 ++outer_cctx->ctx_closure_count;
4088 }
4089
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004090 ufunc->uf_def_status = UF_COMPILED;
Bram Moolenaar05afcee2020-03-31 23:32:31 +02004091 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004092
4093 ret = OK;
4094
4095erret:
Bram Moolenaar599410c2021-04-10 14:03:43 +02004096 if (ufunc->uf_def_status == UF_COMPILING)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004097 {
Bram Moolenaar05afcee2020-03-31 23:32:31 +02004098 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
4099 + ufunc->uf_dfunc_idx;
Bram Moolenaar20431c92020-03-20 18:39:46 +01004100
Bram Moolenaarcaf1a2f2021-06-15 11:27:21 +02004101 // Compiling aborted, free the generated instructions.
Bram Moolenaar8238f082021-04-20 21:10:48 +02004102 clear_instr_ga(instr);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01004103 VIM_CLEAR(dfunc->df_name);
Bram Moolenaarcaf1a2f2021-06-15 11:27:21 +02004104 ga_clear_strings(&dfunc->df_var_names);
Bram Moolenaar20431c92020-03-20 18:39:46 +01004105
Bram Moolenaar6c4bfe42020-07-23 18:26:30 +02004106 // If using the last entry in the table and it was added above, we
4107 // might as well remove it.
4108 if (!dfunc->df_deleted && new_def_function
Bram Moolenaar45a15082020-05-25 00:28:33 +02004109 && ufunc->uf_dfunc_idx == def_functions.ga_len - 1)
Bram Moolenaar6c4bfe42020-07-23 18:26:30 +02004110 {
Bram Moolenaar20431c92020-03-20 18:39:46 +01004111 --def_functions.ga_len;
Bram Moolenaar6c4bfe42020-07-23 18:26:30 +02004112 ufunc->uf_dfunc_idx = 0;
4113 }
Bram Moolenaar701cc6c2021-04-10 13:33:48 +02004114 ufunc->uf_def_status = UF_COMPILE_ERROR;
Bram Moolenaar20431c92020-03-20 18:39:46 +01004115
Bram Moolenaar3cca2992020-04-02 22:57:36 +02004116 while (cctx.ctx_scope != NULL)
4117 drop_scope(&cctx);
4118
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004119 if (errormsg != NULL)
4120 emsg(errormsg);
Bram Moolenaard66960b2020-10-30 20:46:26 +01004121 else if (did_emsg == did_emsg_before)
Bram Moolenaare13bdec2020-10-16 23:16:47 +02004122 emsg(_(e_compiling_def_function_failed));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004123 }
4124
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004125 if (cctx.ctx_redir_lhs.lhs_name != NULL)
4126 {
4127 if (ret == OK)
4128 {
4129 emsg(_(e_missing_redir_end));
4130 ret = FAIL;
4131 }
4132 vim_free(cctx.ctx_redir_lhs.lhs_name);
Bram Moolenaar753bcf82021-04-21 14:24:24 +02004133 vim_free(cctx.ctx_redir_lhs.lhs_whole);
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004134 }
4135
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004136 current_sctx = save_current_sctx;
Bram Moolenaarf4e8cdd2020-10-12 22:07:13 +02004137 estack_compiling = save_estack_compiling;
Bram Moolenaardc4c2302021-04-25 13:54:42 +02004138 cmdmod.cmod_flags = save_cmod_flags;
Bram Moolenaar25e0f582020-05-25 22:36:50 +02004139 if (do_estack_push)
4140 estack_pop();
4141
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004142 ga_clear_strings(&lines_to_free);
Bram Moolenaarb84a3812020-05-01 15:44:29 +02004143 free_locals(&cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004144 ga_clear(&cctx.ctx_type_stack);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004145 return ret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004146}
4147
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004148 void
4149set_function_type(ufunc_T *ufunc)
4150{
4151 int varargs = ufunc->uf_va_name != NULL;
4152 int argcount = ufunc->uf_args.ga_len;
4153
4154 // Create a type for the function, with the return type and any
4155 // argument types.
4156 // A vararg is included in uf_args.ga_len but not in uf_arg_types.
4157 // The type is included in "tt_args".
4158 if (argcount > 0 || varargs)
4159 {
Bram Moolenaar18062fc2021-03-05 21:35:47 +01004160 if (ufunc->uf_type_list.ga_itemsize == 0)
4161 ga_init2(&ufunc->uf_type_list, sizeof(type_T *), 10);
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004162 ufunc->uf_func_type = alloc_func_type(ufunc->uf_ret_type,
4163 argcount, &ufunc->uf_type_list);
4164 // Add argument types to the function type.
4165 if (func_type_add_arg_types(ufunc->uf_func_type,
4166 argcount + varargs,
4167 &ufunc->uf_type_list) == FAIL)
4168 return;
4169 ufunc->uf_func_type->tt_argcount = argcount + varargs;
4170 ufunc->uf_func_type->tt_min_argcount =
4171 argcount - ufunc->uf_def_args.ga_len;
4172 if (ufunc->uf_arg_types == NULL)
4173 {
4174 int i;
4175
4176 // lambda does not have argument types.
4177 for (i = 0; i < argcount; ++i)
4178 ufunc->uf_func_type->tt_args[i] = &t_any;
4179 }
4180 else
4181 mch_memmove(ufunc->uf_func_type->tt_args,
4182 ufunc->uf_arg_types, sizeof(type_T *) * argcount);
4183 if (varargs)
4184 {
4185 ufunc->uf_func_type->tt_args[argcount] =
Bram Moolenaar2a389082021-04-09 20:24:31 +02004186 ufunc->uf_va_type == NULL ? &t_list_any : ufunc->uf_va_type;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004187 ufunc->uf_func_type->tt_flags = TTFLAG_VARARGS;
4188 }
4189 }
4190 else
4191 // No arguments, can use a predefined type.
4192 ufunc->uf_func_type = get_func_type(ufunc->uf_ret_type,
4193 argcount, &ufunc->uf_type_list);
4194}
4195
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004196/*
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01004197 * Free all instructions for "dfunc" except df_name.
Bram Moolenaar20431c92020-03-20 18:39:46 +01004198 */
4199 static void
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004200delete_def_function_contents(dfunc_T *dfunc, int mark_deleted)
Bram Moolenaar20431c92020-03-20 18:39:46 +01004201{
4202 int idx;
4203
Bram Moolenaard505d172022-12-18 21:42:55 +00004204 // In same cases the instructions may refer to a class in which the
4205 // function is defined and unreferencing the class may call back here
4206 // recursively. Set the df_delete_busy to avoid problems.
4207 if (dfunc->df_delete_busy)
4208 return;
4209 dfunc->df_delete_busy = TRUE;
4210
Bram Moolenaar20431c92020-03-20 18:39:46 +01004211 ga_clear(&dfunc->df_def_args_isn);
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02004212 ga_clear_strings(&dfunc->df_var_names);
Bram Moolenaar20431c92020-03-20 18:39:46 +01004213
4214 if (dfunc->df_instr != NULL)
4215 {
4216 for (idx = 0; idx < dfunc->df_instr_count; ++idx)
4217 delete_instr(dfunc->df_instr + idx);
4218 VIM_CLEAR(dfunc->df_instr);
4219 }
Bram Moolenaarc2dec4c2021-06-13 15:39:00 +02004220 if (dfunc->df_instr_debug != NULL)
4221 {
4222 for (idx = 0; idx < dfunc->df_instr_debug_count; ++idx)
4223 delete_instr(dfunc->df_instr_debug + idx);
4224 VIM_CLEAR(dfunc->df_instr_debug);
Bram Moolenaarc2dec4c2021-06-13 15:39:00 +02004225 }
Bram Moolenaarc05fe072021-01-24 21:30:48 +01004226#ifdef FEAT_PROFILE
4227 if (dfunc->df_instr_prof != NULL)
4228 {
4229 for (idx = 0; idx < dfunc->df_instr_prof_count; ++idx)
4230 delete_instr(dfunc->df_instr_prof + idx);
4231 VIM_CLEAR(dfunc->df_instr_prof);
Bram Moolenaarc05fe072021-01-24 21:30:48 +01004232 }
4233#endif
Bram Moolenaar20431c92020-03-20 18:39:46 +01004234
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004235 if (mark_deleted)
4236 dfunc->df_deleted = TRUE;
4237 if (dfunc->df_ufunc != NULL)
4238 dfunc->df_ufunc->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaard505d172022-12-18 21:42:55 +00004239
4240 dfunc->df_delete_busy = FALSE;
Bram Moolenaar20431c92020-03-20 18:39:46 +01004241}
4242
4243/*
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004244 * When a user function is deleted, clear the contents of any associated def
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01004245 * function, unless another user function still uses it.
4246 * The position in def_functions can be re-used.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004247 */
4248 void
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01004249unlink_def_function(ufunc_T *ufunc)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004250{
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00004251 if (ufunc->uf_dfunc_idx <= 0)
4252 return;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004253
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00004254 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
4255 + ufunc->uf_dfunc_idx;
4256
4257 if (--dfunc->df_refcount <= 0)
4258 delete_def_function_contents(dfunc, TRUE);
4259 ufunc->uf_def_status = UF_NOT_COMPILED;
4260 ufunc->uf_dfunc_idx = 0;
4261 if (dfunc->df_ufunc == ufunc)
4262 dfunc->df_ufunc = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004263}
4264
Bram Moolenaarfdeab652020-09-19 15:16:50 +02004265/*
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01004266 * Used when a user function refers to an existing dfunc.
Bram Moolenaarfdeab652020-09-19 15:16:50 +02004267 */
4268 void
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01004269link_def_function(ufunc_T *ufunc)
Bram Moolenaarfdeab652020-09-19 15:16:50 +02004270{
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00004271 if (ufunc->uf_dfunc_idx <= 0)
4272 return;
Bram Moolenaarfdeab652020-09-19 15:16:50 +02004273
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00004274 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
4275 + ufunc->uf_dfunc_idx;
4276
4277 ++dfunc->df_refcount;
Bram Moolenaarfdeab652020-09-19 15:16:50 +02004278}
4279
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004280#if defined(EXITFREE) || defined(PROTO)
Bram Moolenaar20431c92020-03-20 18:39:46 +01004281/*
4282 * Free all functions defined with ":def".
4283 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004284 void
4285free_def_functions(void)
4286{
Bram Moolenaar20431c92020-03-20 18:39:46 +01004287 int idx;
4288
4289 for (idx = 0; idx < def_functions.ga_len; ++idx)
4290 {
4291 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data) + idx;
4292
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004293 delete_def_function_contents(dfunc, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01004294 vim_free(dfunc->df_name);
Bram Moolenaar20431c92020-03-20 18:39:46 +01004295 }
4296
4297 ga_clear(&def_functions);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004298}
4299#endif
4300
4301
4302#endif // FEAT_EVAL