blob: 8f67d8a8f6212a338d071778959cf441ab3ae431 [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"
Yegappan Lakshmanand990bf02024-03-22 19:56:17 +01002288 lvar_T *lvar = lhs->lhs_lvar;
2289 int rc;
2290
2291 if (lvar->lv_from_outer > 0)
2292 rc = generate_LOADOUTER(cctx, lvar->lv_idx,
2293 lvar->lv_from_outer, lvar->lv_loop_depth,
2294 lvar->lv_loop_idx, type);
2295 else
2296 rc = generate_LOAD(cctx, ISN_LOAD, lvar->lv_idx, NULL, type);
2297
2298 if (rc == FAIL)
Bram Moolenaar22363c62023-04-24 17:15:25 +01002299 return FAIL;
2300 }
2301 else
2302 {
2303 // load object variable or argument
2304 if (compile_load_lhs(lhs, var_start, lhs->lhs_type, cctx) == FAIL)
2305 return FAIL;
2306 }
Bram Moolenaar29ac5df2023-01-16 19:43:47 +00002307 if (cl->class_flags & CLASS_INTERFACE)
Yegappan Lakshmanan5a05d372023-09-29 19:43:11 +02002308 return generate_GET_ITF_MEMBER(cctx, cl, lhs->lhs_member_idx, type);
2309 return generate_GET_OBJ_MEMBER(cctx, lhs->lhs_member_idx, type);
Bram Moolenaar4cae8452023-01-15 15:51:48 +00002310 }
Yegappan Lakshmanan1ea42882023-10-11 21:43:52 +02002311 else if (lhs->lhs_type->tt_type == VAR_CLASS)
2312 {
2313 // "<classname>.value": load class variable "classname.value"
Yegappan Lakshmananff6f0d52023-12-21 16:46:18 +01002314 char_u *dot = vim_strchr(var_start, '.');
2315 if (dot == NULL)
2316 {
2317 check_type_is_value(lhs->lhs_type);
2318 return FAIL;
2319 }
Yegappan Lakshmanan1ea42882023-10-11 21:43:52 +02002320
2321 class_T *cl = lhs->lhs_type->tt_class;
2322 ocmember_T *m = class_member_lookup(cl, dot + 1,
2323 lhs->lhs_end - dot - 1,
2324 &lhs->lhs_member_idx);
2325 if (m == NULL)
2326 return FAIL;
2327
2328 return generate_CLASSMEMBER(cctx, TRUE, cl, lhs->lhs_member_idx);
2329 }
Bram Moolenaar4cae8452023-01-15 15:51:48 +00002330
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02002331 if (compile_load_lhs(lhs, var_start, NULL, cctx) == FAIL)
2332 return FAIL;
Bram Moolenaara369c3d2021-04-21 16:00:10 +02002333
2334 if (lhs->lhs_has_index)
2335 {
2336 int range = FALSE;
2337
2338 // Get member from list or dict. First compile the
2339 // index value.
2340 if (compile_assign_index(var_start, lhs, &range, cctx) == FAIL)
2341 return FAIL;
2342 if (range)
2343 {
2344 semsg(_(e_cannot_use_range_with_assignment_operator_str),
2345 var_start);
2346 return FAIL;
2347 }
2348
2349 // Get the member.
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02002350 if (compile_member(FALSE, NULL, cctx) == FAIL)
Bram Moolenaara369c3d2021-04-21 16:00:10 +02002351 return FAIL;
2352 }
2353 return OK;
2354}
2355
2356/*
Bram Moolenaare42939a2021-04-05 17:11:17 +02002357 * Assignment to a list or dict member, or ":unlet" for the item, using the
2358 * information in "lhs".
2359 * Returns OK or FAIL.
2360 */
Bram Moolenaardc7c3662021-12-20 15:04:29 +00002361 int
Bram Moolenaare42939a2021-04-05 17:11:17 +02002362compile_assign_unlet(
2363 char_u *var_start,
2364 lhs_T *lhs,
2365 int is_assign,
2366 type_T *rhs_type,
2367 cctx_T *cctx)
2368{
Bram Moolenaare42939a2021-04-05 17:11:17 +02002369 vartype_T dest_type;
Bram Moolenaare42939a2021-04-05 17:11:17 +02002370 int range = FALSE;
2371
Bram Moolenaar68452172021-04-12 21:21:02 +02002372 if (compile_assign_index(var_start, lhs, &range, cctx) == FAIL)
Bram Moolenaar752fc692021-01-04 21:57:11 +01002373 return FAIL;
Bram Moolenaar4f0884d2021-08-11 21:49:23 +02002374 if (is_assign && range
2375 && lhs->lhs_type->tt_type != VAR_LIST
2376 && lhs->lhs_type != &t_blob
2377 && lhs->lhs_type != &t_any)
Bram Moolenaar68452172021-04-12 21:21:02 +02002378 {
2379 semsg(_(e_cannot_use_range_with_assignment_str), var_start);
2380 return FAIL;
2381 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01002382
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002383 if (lhs->lhs_type == NULL || lhs->lhs_type == &t_any)
Bram Moolenaar752fc692021-01-04 21:57:11 +01002384 {
2385 // Index on variable of unknown type: check at runtime.
2386 dest_type = VAR_ANY;
2387 }
2388 else
2389 {
2390 dest_type = lhs->lhs_type->tt_type;
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002391 if (dest_type == VAR_DICT && range)
2392 {
zeertzjq276410e2023-05-07 21:59:33 +01002393 emsg(_(e_cannot_use_range_with_dictionary));
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002394 return FAIL;
2395 }
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02002396 if (dest_type == VAR_DICT
2397 && may_generate_2STRING(-1, FALSE, cctx) == FAIL)
Bram Moolenaar752fc692021-01-04 21:57:11 +01002398 return FAIL;
Bram Moolenaar51e93322021-04-17 20:44:56 +02002399 if (dest_type == VAR_LIST || dest_type == VAR_BLOB)
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002400 {
Bram Moolenaar51e93322021-04-17 20:44:56 +02002401 type_T *type;
2402
2403 if (range)
2404 {
Bram Moolenaar078a4612022-01-04 15:17:03 +00002405 type = get_type_on_stack(cctx, 1);
Bram Moolenaarc6951a72022-12-29 20:56:24 +00002406 if (need_type(type, &t_number, FALSE,
Bram Moolenaar2995e5c2022-03-18 21:41:47 +00002407 -2, 0, cctx, FALSE, FALSE) == FAIL)
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002408 return FAIL;
Bram Moolenaar51e93322021-04-17 20:44:56 +02002409 }
Bram Moolenaar078a4612022-01-04 15:17:03 +00002410 type = get_type_on_stack(cctx, 0);
Bram Moolenaar53ba6ca2022-03-10 19:23:28 +00002411 if ((dest_type != VAR_BLOB && type->tt_type != VAR_SPECIAL)
Bram Moolenaarc6951a72022-12-29 20:56:24 +00002412 && need_type(type, &t_number, FALSE,
Bram Moolenaar51e93322021-04-17 20:44:56 +02002413 -1, 0, cctx, FALSE, FALSE) == FAIL)
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002414 return FAIL;
2415 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01002416 }
2417
Bram Moolenaar4875d6a2022-08-17 15:55:51 +01002418 if (cctx->ctx_skip == SKIP_YES)
2419 return OK;
2420
Bram Moolenaar22363c62023-04-24 17:15:25 +01002421 // Load the dict, list or object. On the stack we then have:
Bram Moolenaar752fc692021-01-04 21:57:11 +01002422 // - value (for assignment, not for :unlet)
2423 // - index
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002424 // - for [a : b] second index
Bram Moolenaar752fc692021-01-04 21:57:11 +01002425 // - variable
Bram Moolenaarb9c0cd82021-04-05 20:51:00 +02002426 if (compile_load_lhs(lhs, var_start, rhs_type, cctx) == FAIL)
2427 return FAIL;
Bram Moolenaar752fc692021-01-04 21:57:11 +01002428
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002429 if (dest_type == VAR_LIST
2430 || dest_type == VAR_DICT
2431 || dest_type == VAR_BLOB
2432 || dest_type == VAR_CLASS
2433 || dest_type == VAR_OBJECT
2434 || dest_type == VAR_ANY)
Bram Moolenaar752fc692021-01-04 21:57:11 +01002435 {
2436 if (is_assign)
2437 {
Bram Moolenaar68452172021-04-12 21:21:02 +02002438 if (range)
2439 {
2440 if (generate_instr_drop(cctx, ISN_STORERANGE, 4) == NULL)
2441 return FAIL;
2442 }
2443 else
2444 {
2445 isn_T *isn = generate_instr_drop(cctx, ISN_STOREINDEX, 3);
Bram Moolenaar752fc692021-01-04 21:57:11 +01002446
Bram Moolenaar68452172021-04-12 21:21:02 +02002447 if (isn == NULL)
2448 return FAIL;
Bram Moolenaarf7d1c6e2023-01-16 20:47:57 +00002449 isn->isn_arg.storeindex.si_vartype = dest_type;
2450 isn->isn_arg.storeindex.si_class = NULL;
2451
2452 if (dest_type == VAR_OBJECT)
2453 {
Bram Moolenaarb1e32ac2023-02-21 12:38:51 +00002454 class_T *cl = lhs->lhs_type->tt_class;
Bram Moolenaarf7d1c6e2023-01-16 20:47:57 +00002455
2456 if (cl->class_flags & CLASS_INTERFACE)
2457 {
2458 // "this.value": load "this" object and get the value
2459 // at index for an object or class member get the type
2460 // of the member
2461 isn->isn_arg.storeindex.si_class = cl;
2462 ++cl->class_refcount;
2463 }
2464 }
Bram Moolenaar68452172021-04-12 21:21:02 +02002465 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01002466 }
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01002467 else if (range)
2468 {
2469 if (generate_instr_drop(cctx, ISN_UNLETRANGE, 3) == NULL)
2470 return FAIL;
2471 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01002472 else
2473 {
2474 if (generate_instr_drop(cctx, ISN_UNLETINDEX, 2) == NULL)
2475 return FAIL;
2476 }
2477 }
2478 else
2479 {
2480 emsg(_(e_indexable_type_required));
2481 return FAIL;
2482 }
2483
2484 return OK;
2485}
2486
Bram Moolenaar4b8a0652020-12-01 16:30:44 +01002487/*
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00002488 * Generate an instruction to push the default value for "vartype".
2489 * if "dest_local" is TRUE then for some types no instruction is generated.
2490 * "skip_store" is set to TRUE if no PUSH instruction is generated.
2491 * Returns OK or FAIL.
2492 */
2493 static int
2494push_default_value(
2495 cctx_T *cctx,
2496 vartype_T vartype,
2497 int dest_is_local,
2498 int *skip_store)
2499{
2500 int r = OK;
2501
2502 switch (vartype)
2503 {
2504 case VAR_BOOL:
2505 r = generate_PUSHBOOL(cctx, VVAL_FALSE);
2506 break;
2507 case VAR_FLOAT:
2508 r = generate_PUSHF(cctx, 0.0);
2509 break;
2510 case VAR_STRING:
2511 r = generate_PUSHS(cctx, NULL);
2512 break;
2513 case VAR_BLOB:
2514 r = generate_PUSHBLOB(cctx, blob_alloc());
2515 break;
2516 case VAR_FUNC:
2517 r = generate_PUSHFUNC(cctx, NULL, &t_func_void, TRUE);
2518 break;
2519 case VAR_LIST:
2520 r = generate_NEWLIST(cctx, 0, FALSE);
2521 break;
2522 case VAR_DICT:
2523 r = generate_NEWDICT(cctx, 0, FALSE);
2524 break;
2525 case VAR_JOB:
2526 r = generate_PUSHJOB(cctx);
2527 break;
2528 case VAR_CHANNEL:
2529 r = generate_PUSHCHANNEL(cctx);
2530 break;
Ernie Rael5c018be2023-08-27 18:40:26 +02002531 case VAR_OBJECT:
2532 r = generate_PUSHOBJ(cctx);
2533 break;
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00002534 case VAR_NUMBER:
2535 case VAR_UNKNOWN:
2536 case VAR_ANY:
2537 case VAR_PARTIAL:
2538 case VAR_VOID:
2539 case VAR_INSTR:
2540 case VAR_CLASS:
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02002541 case VAR_TYPEALIAS:
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00002542 case VAR_SPECIAL: // cannot happen
2543 // This is skipped for local variables, they are always
2544 // initialized to zero. But in a "for" or "while" loop
2545 // the value may have been changed.
2546 if (dest_is_local && !inside_loop_scope(cctx))
2547 *skip_store = TRUE;
2548 else
2549 r = generate_PUSHNR(cctx, 0);
2550 break;
2551 }
2552 return r;
2553}
2554
2555/*
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002556 * Compile declaration and assignment:
Bram Moolenaar30fd8202020-09-26 15:09:30 +02002557 * "let name"
2558 * "var name = expr"
2559 * "final name = expr"
2560 * "const name = expr"
2561 * "name = expr"
2562 * "arg" points to "name".
Bram Moolenaarbdc0f1c2021-04-24 19:08:24 +02002563 * "++arg" and "--arg"
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002564 * Return NULL for an error.
2565 * Return "arg" if it does not look like a variable list.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002566 */
2567 static char_u *
Bram Moolenaar65b0d162022-12-13 18:43:22 +00002568compile_assignment(
2569 char_u *arg_start,
2570 exarg_T *eap,
2571 cmdidx_T cmdidx,
2572 cctx_T *cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002573{
Bram Moolenaar65b0d162022-12-13 18:43:22 +00002574 char_u *arg = arg_start;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002575 char_u *var_start;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002576 char_u *p;
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02002577 char_u *end = arg;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002578 char_u *ret = NULL;
2579 int var_count = 0;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002580 int var_idx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002581 int semicolon = 0;
Bram Moolenaar4d5dfe22021-06-26 13:59:29 +02002582 int did_generate_slice = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002583 garray_T *instr = &cctx->ctx_instr;
Bram Moolenaar65b0d162022-12-13 18:43:22 +00002584 int jump_instr_idx = instr->ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002585 char_u *op;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002586 int oplen = 0;
2587 int heredoc = FALSE;
Bram Moolenaarbdc0f1c2021-04-24 19:08:24 +02002588 int incdec = FALSE;
Bram Moolenaardc234ca2020-11-28 18:52:33 +01002589 type_T *rhs_type = &t_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002590 char_u *sp;
Bram Moolenaar752fc692021-01-04 21:57:11 +01002591 int is_decl = is_decl_command(cmdidx);
2592 lhs_T lhs;
Bram Moolenaarf593fc82022-12-14 13:50:02 +00002593 CLEAR_FIELD(lhs);
Bram Moolenaar77709b12021-04-03 21:01:01 +02002594 long start_lnum = SOURCING_LNUM;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002595
Bram Moolenaar6acf7572023-01-01 19:53:30 +00002596 int has_arg_is_set_prefix = STRNCMP(arg, "ifargisset ", 11) == 0;
Bram Moolenaar65b0d162022-12-13 18:43:22 +00002597 if (has_arg_is_set_prefix)
2598 {
2599 arg += 11;
2600 int def_idx = getdigits(&arg);
2601 arg = skipwhite(arg);
2602
2603 // Use a JUMP_IF_ARG_NOT_SET instruction to skip if the value was not
2604 // given and the default value is "v:none".
2605 int off = STACK_FRAME_SIZE + (cctx->ctx_ufunc->uf_va_name != NULL
2606 ? 1 : 0);
2607 int count = cctx->ctx_ufunc->uf_def_args.ga_len;
2608 if (generate_JUMP_IF_ARG(cctx, ISN_JUMP_IF_ARG_NOT_SET,
2609 def_idx - count - off) == FAIL)
2610 goto theend;
2611 }
2612
Bram Moolenaare1d12112022-03-05 11:37:48 +00002613 // Skip over the "varname" or "[varname, varname]" to get to any "=".
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002614 p = skip_var_list(arg, TRUE, &var_count, &semicolon, TRUE);
2615 if (p == NULL)
2616 return *arg == '[' ? arg : NULL;
2617
Bram Moolenaarbdc0f1c2021-04-24 19:08:24 +02002618 if (eap->cmdidx == CMD_increment || eap->cmdidx == CMD_decrement)
2619 {
Bram Moolenaar22480d12021-06-25 21:31:09 +02002620 if (VIM_ISWHITE(eap->cmd[2]))
2621 {
2622 semsg(_(e_no_white_space_allowed_after_str_str),
2623 eap->cmdidx == CMD_increment ? "++" : "--", eap->cmd);
2624 return NULL;
2625 }
Bram Moolenaarbdc0f1c2021-04-24 19:08:24 +02002626 op = (char_u *)(eap->cmdidx == CMD_increment ? "+=" : "-=");
2627 oplen = 2;
2628 incdec = TRUE;
2629 }
Bram Moolenaar70d87692022-05-07 10:03:27 +01002630 else
2631 {
2632 sp = p;
2633 p = skipwhite(p);
2634 op = p;
2635 oplen = assignment_len(p, &heredoc);
2636
2637 if (var_count > 0 && oplen == 0)
2638 // can be something like "[1, 2]->func()"
2639 return arg;
2640
2641 if (oplen > 0 && (!VIM_ISWHITE(*sp) || !IS_WHITE_OR_NUL(op[oplen])))
2642 {
2643 error_white_both(op, oplen);
2644 return NULL;
2645 }
2646 }
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02002647
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002648 if (heredoc)
2649 {
2650 list_T *l;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002651
2652 // [let] varname =<< [trim] {end}
Zoltan Arpadffy6fdb6282023-12-19 20:53:07 +01002653 eap->ea_getline = exarg_getline;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002654 eap->cookie = cctx;
Yegappan Lakshmanan1fc6ea92022-04-21 23:30:15 +01002655 l = heredoc_get(eap, op + 3, FALSE, TRUE);
Bram Moolenaarc0e29012020-09-27 14:22:48 +02002656 if (l == NULL)
2657 return NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002658
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002659 list_free(l);
2660 p += STRLEN(p);
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002661 end = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002662 }
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002663 else if (var_count > 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002664 {
Bram Moolenaar004d9b02020-11-30 21:40:03 +01002665 char_u *wp;
2666
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002667 // for "[var, var] = expr" evaluate the expression here, loop over the
2668 // list of variables below.
Bram Moolenaar004d9b02020-11-30 21:40:03 +01002669 // A line break may follow the "=".
Bram Moolenaard25ec2c2020-03-30 21:05:45 +02002670
Bram Moolenaar004d9b02020-11-30 21:40:03 +01002671 wp = op + oplen;
Bram Moolenaar8ff16e02020-12-07 21:49:52 +01002672 if (may_get_next_line_error(wp, &p, cctx) == FAIL)
Bram Moolenaar004d9b02020-11-30 21:40:03 +01002673 return FAIL;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002674 if (compile_expr0(&p, cctx) == FAIL)
2675 return NULL;
2676 end = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002677
Bram Moolenaar9b68c822020-06-18 19:31:08 +02002678 if (cctx->ctx_skip != SKIP_YES)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002679 {
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02002680 type_T *stacktype;
Bram Moolenaardb9ff9a2021-12-01 17:38:01 +00002681 int needed_list_len;
2682 int did_check = FALSE;
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02002683
Bram Moolenaar078a4612022-01-04 15:17:03 +00002684 stacktype = cctx->ctx_type_stack.ga_len == 0 ? &t_void
2685 : get_type_on_stack(cctx, 0);
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002686 if (stacktype->tt_type == VAR_VOID)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002687 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02002688 emsg(_(e_cannot_use_void_value));
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002689 goto theend;
2690 }
Bram Moolenaarc6951a72022-12-29 20:56:24 +00002691 if (need_type(stacktype, &t_list_any, FALSE, -1, 0, cctx,
Bram Moolenaar334a8b42020-10-19 16:07:42 +02002692 FALSE, FALSE) == FAIL)
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002693 goto theend;
Bram Moolenaardb9ff9a2021-12-01 17:38:01 +00002694 // If a constant list was used we can check the length right here.
2695 needed_list_len = semicolon ? var_count - 1 : var_count;
2696 if (instr->ga_len > 0)
2697 {
2698 isn_T *isn = ((isn_T *)instr->ga_data) + instr->ga_len - 1;
2699
2700 if (isn->isn_type == ISN_NEWLIST)
2701 {
2702 did_check = TRUE;
2703 if (semicolon ? isn->isn_arg.number < needed_list_len
2704 : isn->isn_arg.number != needed_list_len)
2705 {
2706 semsg(_(e_expected_nr_items_but_got_nr),
Bram Moolenaarf60a6342022-01-15 14:16:37 +00002707 needed_list_len, (int)isn->isn_arg.number);
Bram Moolenaardb9ff9a2021-12-01 17:38:01 +00002708 goto theend;
2709 }
2710 }
2711 }
2712 if (!did_check)
2713 generate_CHECKLEN(cctx, needed_list_len, semicolon);
Bram Moolenaardc234ca2020-11-28 18:52:33 +01002714 if (stacktype->tt_member != NULL)
2715 rhs_type = stacktype->tt_member;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002716 }
2717 }
2718
2719 /*
2720 * Loop over variables in "[var, var] = expr".
2721 * For "var = expr" and "let var: type" this is done only once.
2722 */
2723 if (var_count > 0)
2724 var_start = skipwhite(arg + 1); // skip over the "["
2725 else
2726 var_start = arg;
2727 for (var_idx = 0; var_idx == 0 || var_idx < var_count; var_idx++)
2728 {
Bram Moolenaar6977dba2021-07-04 22:48:12 +02002729 int instr_count = -1;
2730 int save_lnum;
Bram Moolenaar5cd64792021-12-25 18:23:24 +00002731 int skip_store = FALSE;
Bram Moolenaare88c6b72022-02-15 15:37:11 +00002732 type_T *inferred_type = NULL;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002733
Bram Moolenaarf93bbd02021-04-10 22:35:43 +02002734 if (var_start[0] == '_' && !eval_isnamec(var_start[1]))
2735 {
2736 // Ignore underscore in "[a, _, b] = list".
2737 if (var_count > 0)
2738 {
2739 var_start = skipwhite(var_start + 2);
2740 continue;
2741 }
2742 emsg(_(e_cannot_use_underscore_here));
2743 goto theend;
2744 }
Bram Moolenaar752fc692021-01-04 21:57:11 +01002745 vim_free(lhs.lhs_name);
2746
2747 /*
2748 * Figure out the LHS type and other properties.
2749 */
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02002750 if (compile_assign_lhs(var_start, &lhs, cmdidx,
Bram Moolenaar97f8c102022-04-02 19:43:57 +01002751 is_decl, heredoc, var_start > eap->cmd,
2752 oplen, cctx) == FAIL)
Bram Moolenaar752fc692021-01-04 21:57:11 +01002753 goto theend;
Bram Moolenaar81530e32021-07-28 21:25:49 +02002754 if (heredoc)
2755 {
2756 SOURCING_LNUM = start_lnum;
2757 if (lhs.lhs_has_type
Bram Moolenaarc6951a72022-12-29 20:56:24 +00002758 && need_type(&t_list_string, lhs.lhs_type, FALSE,
Bram Moolenaar81530e32021-07-28 21:25:49 +02002759 -1, 0, cctx, FALSE, FALSE) == FAIL)
2760 goto theend;
2761 }
2762 else
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002763 {
Bram Moolenaar9b68c822020-06-18 19:31:08 +02002764 if (cctx->ctx_skip == SKIP_YES)
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002765 {
Bram Moolenaar72abcf42020-06-18 18:26:24 +02002766 if (oplen > 0 && var_count == 0)
2767 {
2768 // skip over the "=" and the expression
2769 p = skipwhite(op + oplen);
Bram Moolenaar169502f2021-04-21 12:19:35 +02002770 (void)compile_expr0(&p, cctx);
Bram Moolenaar72abcf42020-06-18 18:26:24 +02002771 }
2772 }
2773 else if (oplen > 0)
2774 {
Bram Moolenaar334a8b42020-10-19 16:07:42 +02002775 int is_const = FALSE;
Bram Moolenaar7f764942020-12-02 15:11:18 +01002776 char_u *wp;
Bram Moolenaar72abcf42020-06-18 18:26:24 +02002777
Bram Moolenaar035bd1c2021-06-21 19:44:11 +02002778 // for "+=", "*=", "..=" etc. first load the current value
2779 if (*op != '='
2780 && compile_load_lhs_with_index(&lhs, var_start,
2781 cctx) == FAIL)
2782 goto theend;
2783
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002784 // For "var = expr" evaluate the expression.
2785 if (var_count == 0)
2786 {
2787 int r;
2788
Bram Moolenaarbdc0f1c2021-04-24 19:08:24 +02002789 // Compile the expression.
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002790 instr_count = instr->ga_len;
Bram Moolenaarbdc0f1c2021-04-24 19:08:24 +02002791 if (incdec)
Bram Moolenaar21e51222020-12-04 12:43:29 +01002792 {
Bram Moolenaarbdc0f1c2021-04-24 19:08:24 +02002793 r = generate_PUSHNR(cctx, 1);
2794 }
2795 else
2796 {
2797 // Temporarily hide the new local variable here, it is
2798 // not available to this expression.
2799 if (lhs.lhs_new_local)
2800 --cctx->ctx_locals.ga_len;
2801 wp = op + oplen;
2802 if (may_get_next_line_error(wp, &p, cctx) == FAIL)
2803 {
2804 if (lhs.lhs_new_local)
2805 ++cctx->ctx_locals.ga_len;
2806 goto theend;
2807 }
2808 r = compile_expr0_ext(&p, cctx, &is_const);
Bram Moolenaar752fc692021-01-04 21:57:11 +01002809 if (lhs.lhs_new_local)
Bram Moolenaar21e51222020-12-04 12:43:29 +01002810 ++cctx->ctx_locals.ga_len;
Bram Moolenaar21e51222020-12-04 12:43:29 +01002811 }
Yegappan Lakshmananc99e1822022-09-03 10:52:24 +01002812 if (r == FAIL)
2813 goto theend;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002814 }
Bram Moolenaar9af78762020-06-16 11:34:42 +02002815 else if (semicolon && var_idx == var_count - 1)
2816 {
2817 // For "[var; var] = expr" get the rest of the list
Bram Moolenaar4d5dfe22021-06-26 13:59:29 +02002818 did_generate_slice = TRUE;
Bram Moolenaar9af78762020-06-16 11:34:42 +02002819 if (generate_SLICE(cctx, var_count - 1) == FAIL)
2820 goto theend;
2821 }
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02002822 else
2823 {
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002824 // For "[var, var] = expr" get the "var_idx" item from the
2825 // list.
Bram Moolenaar035bd1c2021-06-21 19:44:11 +02002826 if (generate_GETITEM(cctx, var_idx, *op != '=') == FAIL)
Bram Moolenaar7f764942020-12-02 15:11:18 +01002827 goto theend;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002828 }
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02002829
Bram Moolenaar078a4612022-01-04 15:17:03 +00002830 rhs_type = cctx->ctx_type_stack.ga_len == 0 ? &t_void
2831 : get_type_on_stack(cctx, 0);
Ernie Rael9ed53752023-12-11 17:40:46 +01002832 if (check_type_is_value(rhs_type) == FAIL)
2833 goto theend;
Bram Moolenaar752fc692021-01-04 21:57:11 +01002834 if (lhs.lhs_lvar != NULL && (is_decl || !lhs.lhs_has_type))
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002835 {
Bram Moolenaardc234ca2020-11-28 18:52:33 +01002836 if ((rhs_type->tt_type == VAR_FUNC
2837 || rhs_type->tt_type == VAR_PARTIAL)
Bram Moolenaar3f327882021-03-17 20:56:38 +01002838 && !lhs.lhs_has_index
Bram Moolenaar752fc692021-01-04 21:57:11 +01002839 && var_wrong_func_name(lhs.lhs_name, TRUE))
Bram Moolenaar0f769812020-09-12 18:32:34 +02002840 goto theend;
2841
Bram Moolenaar752fc692021-01-04 21:57:11 +01002842 if (lhs.lhs_new_local && !lhs.lhs_has_type)
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02002843 {
Bram Moolenaardc234ca2020-11-28 18:52:33 +01002844 if (rhs_type->tt_type == VAR_VOID)
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002845 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02002846 emsg(_(e_cannot_use_void_value));
Bram Moolenaar72abcf42020-06-18 18:26:24 +02002847 goto theend;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002848 }
2849 else
2850 {
Bram Moolenaarfa103972022-09-29 19:14:42 +01002851 type_T *type;
2852
Bram Moolenaar04bdd572020-09-23 13:25:32 +02002853 // An empty list or dict has a &t_unknown member,
Bram Moolenaar72abcf42020-06-18 18:26:24 +02002854 // for a variable that implies &t_any.
Bram Moolenaardc234ca2020-11-28 18:52:33 +01002855 if (rhs_type == &t_list_empty)
Bram Moolenaarfa103972022-09-29 19:14:42 +01002856 type = &t_list_any;
Bram Moolenaardc234ca2020-11-28 18:52:33 +01002857 else if (rhs_type == &t_dict_empty)
Bram Moolenaarfa103972022-09-29 19:14:42 +01002858 type = &t_dict_any;
Bram Moolenaardc234ca2020-11-28 18:52:33 +01002859 else if (rhs_type == &t_unknown)
Bram Moolenaarfa103972022-09-29 19:14:42 +01002860 type = &t_any;
Bram Moolenaar72abcf42020-06-18 18:26:24 +02002861 else
Bram Moolenaare88c6b72022-02-15 15:37:11 +00002862 {
Bram Moolenaarfa103972022-09-29 19:14:42 +01002863 type = rhs_type;
Bram Moolenaare88c6b72022-02-15 15:37:11 +00002864 inferred_type = rhs_type;
2865 }
Bram Moolenaarfa103972022-09-29 19:14:42 +01002866 set_var_type(lhs.lhs_lvar, type, cctx);
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002867 }
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02002868 }
Bram Moolenaar93ad1472020-08-19 22:02:41 +02002869 else if (*op == '=')
Bram Moolenaar72abcf42020-06-18 18:26:24 +02002870 {
Bram Moolenaar752fc692021-01-04 21:57:11 +01002871 type_T *use_type = lhs.lhs_lvar->lv_type;
Bram Moolenaar4270d8b2021-08-07 16:30:42 +02002872 where_T where = WHERE_INIT;
Bram Moolenaar72abcf42020-06-18 18:26:24 +02002873
Bram Moolenaar77709b12021-04-03 21:01:01 +02002874 // Without operator check type here, otherwise below.
2875 // Use the line number of the assignment.
2876 SOURCING_LNUM = start_lnum;
LemonBoyc5d27442023-08-19 13:02:35 +02002877 if (var_count > 0)
2878 {
2879 where.wt_index = var_idx + 1;
2880 where.wt_kind = WT_VARIABLE;
2881 }
Bram Moolenaar4f0884d2021-08-11 21:49:23 +02002882 // If assigning to a list or dict member, use the
2883 // member type. Not for "list[:] =".
2884 if (lhs.lhs_has_index
2885 && !has_list_index(var_start + lhs.lhs_varlen,
2886 cctx))
Bram Moolenaar752fc692021-01-04 21:57:11 +01002887 use_type = lhs.lhs_member_type;
Bram Moolenaarc6951a72022-12-29 20:56:24 +00002888 if (need_type_where(rhs_type, use_type, FALSE, -1,
2889 where, cctx, FALSE, is_const) == FAIL)
Bram Moolenaar72abcf42020-06-18 18:26:24 +02002890 goto theend;
2891 }
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02002892 }
Bram Moolenaar74f4a962021-06-17 21:03:07 +02002893 else
2894 {
2895 type_T *lhs_type = lhs.lhs_member_type;
2896
2897 // Special case: assigning to @# can use a number or a
2898 // string.
Bram Moolenaaraf647e72021-08-05 19:01:17 +02002899 // Also: can assign a number to a float.
2900 if ((lhs_type == &t_number_or_string
2901 || lhs_type == &t_float)
2902 && rhs_type->tt_type == VAR_NUMBER)
Bram Moolenaar74f4a962021-06-17 21:03:07 +02002903 lhs_type = &t_number;
Bram Moolenaarc6951a72022-12-29 20:56:24 +00002904 if (*p != '=' && need_type(rhs_type, lhs_type, FALSE,
Bram Moolenaar351ead02021-01-16 16:07:01 +01002905 -1, 0, cctx, FALSE, FALSE) == FAIL)
Bram Moolenaarf39d9e92023-04-22 22:54:40 +01002906 goto theend;
Bram Moolenaar74f4a962021-06-17 21:03:07 +02002907 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002908 }
Bram Moolenaar30fd8202020-09-26 15:09:30 +02002909 else if (cmdidx == CMD_final)
2910 {
2911 emsg(_(e_final_requires_a_value));
2912 goto theend;
2913 }
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002914 else if (cmdidx == CMD_const)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002915 {
Bram Moolenaarbc4c5052020-08-13 22:47:35 +02002916 emsg(_(e_const_requires_a_value));
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002917 goto theend;
2918 }
Bram Moolenaardcb53be2021-12-09 14:23:43 +00002919 else if (!lhs.lhs_has_type || lhs.lhs_dest == dest_option
2920 || lhs.lhs_dest == dest_func_option)
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002921 {
Bram Moolenaarbc4c5052020-08-13 22:47:35 +02002922 emsg(_(e_type_or_initialization_required));
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002923 goto theend;
2924 }
2925 else
2926 {
2927 // variables are always initialized
Bram Moolenaar35578162021-08-02 19:10:38 +02002928 if (GA_GROW_FAILS(instr, 1))
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002929 goto theend;
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00002930 instr_count = instr->ga_len;
2931 int r = push_default_value(cctx, lhs.lhs_member_type->tt_type,
2932 lhs.lhs_dest == dest_local, &skip_store);
Bram Moolenaarc9af6172022-05-04 16:46:54 +01002933 if (r == FAIL)
2934 goto theend;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002935 }
2936 if (var_count == 0)
2937 end = p;
2938 }
2939
Bram Moolenaar72abcf42020-06-18 18:26:24 +02002940 // no need to parse more when skipping
Bram Moolenaar9b68c822020-06-18 19:31:08 +02002941 if (cctx->ctx_skip == SKIP_YES)
Bram Moolenaar72abcf42020-06-18 18:26:24 +02002942 break;
2943
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002944 if (oplen > 0 && *op != '=')
2945 {
Bram Moolenaar93ad1472020-08-19 22:02:41 +02002946 type_T *expected;
Bram Moolenaarc3160722021-08-02 21:12:05 +02002947 type_T *stacktype = NULL;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002948
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002949 if (*op == '.')
Bram Moolenaarf5d52c92021-07-31 22:51:10 +02002950 {
2951 if (may_generate_2STRING(-1, FALSE, cctx) == FAIL)
2952 goto theend;
2953 }
Bram Moolenaar93ad1472020-08-19 22:02:41 +02002954 else
Bram Moolenaarf5d52c92021-07-31 22:51:10 +02002955 {
Bram Moolenaar752fc692021-01-04 21:57:11 +01002956 expected = lhs.lhs_member_type;
Bram Moolenaar078a4612022-01-04 15:17:03 +00002957 stacktype = get_type_on_stack(cctx, 0);
Bram Moolenaarf5d52c92021-07-31 22:51:10 +02002958 if (
Bram Moolenaarf5d52c92021-07-31 22:51:10 +02002959 // If variable is float operation with number is OK.
Bram Moolenaar7bf9a072021-08-02 21:55:15 +02002960 !(expected == &t_float && (stacktype == &t_number
Bram Moolenaarc6951a72022-12-29 20:56:24 +00002961 || stacktype == &t_number_bool))
2962 && need_type(stacktype, expected, TRUE, -1, 0, cctx,
Bram Moolenaar334a8b42020-10-19 16:07:42 +02002963 FALSE, FALSE) == FAIL)
Bram Moolenaarf5d52c92021-07-31 22:51:10 +02002964 goto theend;
2965 }
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002966
2967 if (*op == '.')
Bram Moolenaardd29f1b2020-08-07 20:46:20 +02002968 {
LemonBoy372bcce2022-04-25 12:43:20 +01002969 if (generate_CONCAT(cctx, 2) == FAIL)
Bram Moolenaardd29f1b2020-08-07 20:46:20 +02002970 goto theend;
2971 }
2972 else if (*op == '+')
2973 {
2974 if (generate_add_instr(cctx,
Bram Moolenaar752fc692021-01-04 21:57:11 +01002975 operator_type(lhs.lhs_member_type, stacktype),
Bram Moolenaar07802042021-09-09 23:01:14 +02002976 lhs.lhs_member_type, stacktype,
2977 EXPR_APPEND) == FAIL)
Bram Moolenaardd29f1b2020-08-07 20:46:20 +02002978 goto theend;
2979 }
Bram Moolenaar93ad1472020-08-19 22:02:41 +02002980 else if (generate_two_op(cctx, op) == FAIL)
2981 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002982 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002983
Bram Moolenaar6977dba2021-07-04 22:48:12 +02002984 // Use the line number of the assignment for store instruction.
2985 save_lnum = cctx->ctx_lnum;
2986 cctx->ctx_lnum = start_lnum - 1;
2987
Bram Moolenaar752fc692021-01-04 21:57:11 +01002988 if (lhs.lhs_has_index)
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02002989 {
Bram Moolenaar752fc692021-01-04 21:57:11 +01002990 // Use the info in "lhs" to store the value at the index in the
Bram Moolenaar22363c62023-04-24 17:15:25 +01002991 // list, dict or object.
Bram Moolenaar752fc692021-01-04 21:57:11 +01002992 if (compile_assign_unlet(var_start, &lhs, TRUE, rhs_type, cctx)
2993 == FAIL)
Bram Moolenaar6977dba2021-07-04 22:48:12 +02002994 {
2995 cctx->ctx_lnum = save_lnum;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02002996 goto theend;
Bram Moolenaar6977dba2021-07-04 22:48:12 +02002997 }
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02002998 }
2999 else
3000 {
Bram Moolenaar752fc692021-01-04 21:57:11 +01003001 if (is_decl && cmdidx == CMD_const && (lhs.lhs_dest == dest_script
Bram Moolenaard877a572021-04-01 19:42:48 +02003002 || lhs.lhs_dest == dest_global
Bram Moolenaar752fc692021-01-04 21:57:11 +01003003 || lhs.lhs_dest == dest_local))
Bram Moolenaar30fd8202020-09-26 15:09:30 +02003004 // ":const var": lock the value, but not referenced variables
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +02003005 generate_LOCKCONST(cctx);
3006
Bram Moolenaar10d6f182022-01-04 15:54:38 +00003007 if ((lhs.lhs_type->tt_type == VAR_DICT
Bram Moolenaar752fc692021-01-04 21:57:11 +01003008 || lhs.lhs_type->tt_type == VAR_LIST)
3009 && lhs.lhs_type->tt_member != NULL
Bram Moolenaare88c6b72022-02-15 15:37:11 +00003010 && lhs.lhs_type->tt_member != &t_any
Bram Moolenaar752fc692021-01-04 21:57:11 +01003011 && lhs.lhs_type->tt_member != &t_unknown)
Bram Moolenaaraa210a32021-01-02 15:41:03 +01003012 // Set the type in the list or dict, so that it can be checked,
Bram Moolenaar10d6f182022-01-04 15:54:38 +00003013 // also in legacy script.
Bram Moolenaar752fc692021-01-04 21:57:11 +01003014 generate_SETTYPE(cctx, lhs.lhs_type);
Bram Moolenaare88c6b72022-02-15 15:37:11 +00003015 else if (inferred_type != NULL
3016 && (inferred_type->tt_type == VAR_DICT
3017 || inferred_type->tt_type == VAR_LIST)
3018 && inferred_type->tt_member != NULL
3019 && inferred_type->tt_member != &t_unknown
3020 && inferred_type->tt_member != &t_any)
3021 // Set the type in the list or dict, so that it can be checked,
3022 // also in legacy script.
3023 generate_SETTYPE(cctx, inferred_type);
Bram Moolenaaraa210a32021-01-02 15:41:03 +01003024
Bram Moolenaar5cd64792021-12-25 18:23:24 +00003025 if (!skip_store && generate_store_lhs(cctx, &lhs,
3026 instr_count, is_decl) == FAIL)
Bram Moolenaar6977dba2021-07-04 22:48:12 +02003027 {
3028 cctx->ctx_lnum = save_lnum;
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02003029 goto theend;
Bram Moolenaar6977dba2021-07-04 22:48:12 +02003030 }
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02003031 }
Bram Moolenaar6977dba2021-07-04 22:48:12 +02003032 cctx->ctx_lnum = save_lnum;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02003033
3034 if (var_idx + 1 < var_count)
Bram Moolenaarab36e6a2021-11-30 16:14:49 +00003035 var_start = skipwhite(lhs.lhs_end + 1);
Bram Moolenaar65b0d162022-12-13 18:43:22 +00003036
3037 if (has_arg_is_set_prefix)
3038 {
3039 // set instruction index in JUMP_IF_ARG_SET to here
3040 isn_T *isn = ((isn_T *)instr->ga_data) + jump_instr_idx;
3041 isn->isn_arg.jumparg.jump_where = instr->ga_len;
3042 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003043 }
Bram Moolenaar47a519a2020-06-14 23:05:10 +02003044
Bram Moolenaar4d5dfe22021-06-26 13:59:29 +02003045 // For "[var, var] = expr" drop the "expr" value.
3046 // Also for "[var, var; _] = expr".
3047 if (var_count > 0 && (!semicolon || !did_generate_slice))
Bram Moolenaar9af78762020-06-16 11:34:42 +02003048 {
Bram Moolenaarec792292020-12-13 21:26:56 +01003049 if (generate_instr_drop(cctx, ISN_DROP, 1) == NULL)
Bram Moolenaar9af78762020-06-16 11:34:42 +02003050 goto theend;
3051 }
Bram Moolenaar47a519a2020-06-14 23:05:10 +02003052
Bram Moolenaarb2097502020-07-19 17:17:02 +02003053 ret = skipwhite(end);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003054
3055theend:
Bram Moolenaar752fc692021-01-04 21:57:11 +01003056 vim_free(lhs.lhs_name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003057 return ret;
3058}
3059
3060/*
Bram Moolenaar17126b12021-01-07 22:03:02 +01003061 * Check for an assignment at "eap->cmd", compile it if found.
3062 * Return NOTDONE if there is none, FAIL for failure, OK if done.
3063 */
3064 static int
3065may_compile_assignment(exarg_T *eap, char_u **line, cctx_T *cctx)
3066{
3067 char_u *pskip;
3068 char_u *p;
3069
3070 // Assuming the command starts with a variable or function name,
3071 // find what follows.
3072 // Skip over "var.member", "var[idx]" and the like.
3073 // Also "&opt = val", "$ENV = val" and "@r = val".
3074 pskip = (*eap->cmd == '&' || *eap->cmd == '$' || *eap->cmd == '@')
3075 ? eap->cmd + 1 : eap->cmd;
3076 p = to_name_end(pskip, TRUE);
3077 if (p > eap->cmd && *p != NUL)
3078 {
3079 char_u *var_end;
3080 int oplen;
3081 int heredoc;
3082
3083 if (eap->cmd[0] == '@')
3084 var_end = eap->cmd + 2;
3085 else
3086 var_end = find_name_end(pskip, NULL, NULL,
3087 FNE_CHECK_START | FNE_INCL_BR);
3088 oplen = assignment_len(skipwhite(var_end), &heredoc);
3089 if (oplen > 0)
3090 {
3091 size_t len = p - eap->cmd;
3092
3093 // Recognize an assignment if we recognize the variable
3094 // name:
Bram Moolenaar17126b12021-01-07 22:03:02 +01003095 // "&opt = expr"
3096 // "$ENV = expr"
3097 // "@r = expr"
Bram Moolenaar2e17fef2022-03-18 19:44:48 +00003098 // "g:var = expr"
3099 // "g:[key] = expr"
3100 // "local = expr" where "local" is a local var.
3101 // "script = expr" where "script" is a script-local var.
3102 // "import = expr" where "import" is an imported var
Bram Moolenaar17126b12021-01-07 22:03:02 +01003103 if (*eap->cmd == '&'
3104 || *eap->cmd == '$'
3105 || *eap->cmd == '@'
3106 || ((len) > 2 && eap->cmd[1] == ':')
Bram Moolenaar2e17fef2022-03-18 19:44:48 +00003107 || STRNCMP(eap->cmd, "g:[", 3) == 0
Bram Moolenaare0890d62021-02-17 14:52:14 +01003108 || variable_exists(eap->cmd, len, cctx))
Bram Moolenaar17126b12021-01-07 22:03:02 +01003109 {
3110 *line = compile_assignment(eap->cmd, eap, CMD_SIZE, cctx);
3111 if (*line == NULL || *line == eap->cmd)
3112 return FAIL;
3113 return OK;
3114 }
3115 }
3116 }
3117
Bram Moolenaar65b0d162022-12-13 18:43:22 +00003118 // might be "[var, var] = expr" or "ifargisset this.member = expr"
3119 if (*eap->cmd == '[' || STRNCMP(eap->cmd, "ifargisset ", 11) == 0)
Bram Moolenaar17126b12021-01-07 22:03:02 +01003120 {
Bram Moolenaar17126b12021-01-07 22:03:02 +01003121 *line = compile_assignment(eap->cmd, eap, CMD_SIZE, cctx);
3122 if (*line == NULL)
3123 return FAIL;
3124 if (*line != eap->cmd)
3125 return OK;
3126 }
3127 return NOTDONE;
3128}
3129
Bram Moolenaar9a015112021-12-31 14:06:45 +00003130/*
3131 * Check if arguments of "ufunc" shadow variables in "cctx".
3132 * Return OK or FAIL.
3133 */
3134 static int
3135check_args_shadowing(ufunc_T *ufunc, cctx_T *cctx)
3136{
3137 int i;
3138 char_u *arg;
3139 int r = OK;
3140
3141 // Make sure arguments are not found when compiling a second time.
3142 ufunc->uf_args_visible = 0;
3143
3144 // Check for arguments shadowing variables from the context.
3145 for (i = 0; i < ufunc->uf_args.ga_len; ++i)
3146 {
3147 arg = ((char_u **)(ufunc->uf_args.ga_data))[i];
Bram Moolenaardce24412022-02-08 20:35:30 +00003148 if (check_defined(arg, STRLEN(arg), cctx, NULL, TRUE) == FAIL)
Bram Moolenaar9a015112021-12-31 14:06:45 +00003149 {
3150 r = FAIL;
3151 break;
3152 }
3153 }
3154 ufunc->uf_args_visible = ufunc->uf_args.ga_len;
3155 return r;
3156}
3157
Bram Moolenaarfcb86b02022-10-07 22:46:24 +01003158#ifdef HAS_MESSAGE_WINDOW
Bram Moolenaar139575d2022-03-15 19:29:30 +00003159/*
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003160 * Get a count before a command. Can only be a number.
3161 * Returns zero if there is no count.
3162 * Returns -1 if there is something wrong.
3163 */
3164 static long
3165get_cmd_count(char_u *line, exarg_T *eap)
3166{
3167 char_u *p;
3168
3169 // skip over colons and white space
3170 for (p = line; *p == ':' || VIM_ISWHITE(*p); ++p)
3171 ;
Keith Thompson184f71c2024-01-04 21:19:04 +01003172 if (!SAFE_isdigit(*p))
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003173 {
Bram Moolenaar2435adf2022-10-21 12:05:46 +01003174 // The command or modifiers must be following. Assume a lower case
3175 // character means there is a modifier.
3176 if (p < eap->cmd && !vim_islower(*p))
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003177 {
3178 emsg(_(e_invalid_range));
3179 return -1;
3180 }
3181 return 0;
3182 }
3183 return atol((char *)p);
3184}
Bram Moolenaarfcb86b02022-10-07 22:46:24 +01003185#endif
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003186
3187/*
Bram Moolenaar139575d2022-03-15 19:29:30 +00003188 * Get the compilation type that should be used for "ufunc".
3189 * Keep in sync with INSTRUCTIONS().
3190 */
3191 compiletype_T
3192get_compile_type(ufunc_T *ufunc)
3193{
3194 // Update uf_has_breakpoint if needed.
3195 update_has_breakpoint(ufunc);
3196
3197 if (debug_break_level > 0 || may_break_in_function(ufunc))
3198 return CT_DEBUG;
3199#ifdef FEAT_PROFILE
3200 if (do_profiling == PROF_YES)
3201 {
Ernie Rael21d32122023-09-02 15:09:18 +02003202 if (!ufunc->uf_profiling && has_profiling(FALSE, ufunc->uf_name, NULL,
3203 &ufunc->uf_hash))
Bram Moolenaar139575d2022-03-15 19:29:30 +00003204 func_do_profile(ufunc);
3205 if (ufunc->uf_profiling)
3206 return CT_PROFILE;
3207 }
3208#endif
3209 return CT_NONE;
3210}
3211
Bram Moolenaar7b829262021-10-13 15:04:34 +01003212
3213/*
Bram Moolenaar09689a02020-05-09 22:50:08 +02003214 * Add a function to the list of :def functions.
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003215 * This sets "ufunc->uf_dfunc_idx" but the function isn't compiled yet.
Bram Moolenaar09689a02020-05-09 22:50:08 +02003216 */
Bram Moolenaar822ba242020-05-24 23:00:18 +02003217 static int
Bram Moolenaar09689a02020-05-09 22:50:08 +02003218add_def_function(ufunc_T *ufunc)
3219{
3220 dfunc_T *dfunc;
3221
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003222 if (def_functions.ga_len == 0)
3223 {
3224 // The first position is not used, so that a zero uf_dfunc_idx means it
3225 // wasn't set.
Bram Moolenaar35578162021-08-02 19:10:38 +02003226 if (GA_GROW_FAILS(&def_functions, 1))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003227 return FAIL;
3228 ++def_functions.ga_len;
3229 }
3230
Bram Moolenaar09689a02020-05-09 22:50:08 +02003231 // Add the function to "def_functions".
Bram Moolenaar35578162021-08-02 19:10:38 +02003232 if (GA_GROW_FAILS(&def_functions, 1))
Bram Moolenaar09689a02020-05-09 22:50:08 +02003233 return FAIL;
3234 dfunc = ((dfunc_T *)def_functions.ga_data) + def_functions.ga_len;
3235 CLEAR_POINTER(dfunc);
3236 dfunc->df_idx = def_functions.ga_len;
3237 ufunc->uf_dfunc_idx = dfunc->df_idx;
3238 dfunc->df_ufunc = ufunc;
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01003239 dfunc->df_name = vim_strsave(ufunc->uf_name);
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02003240 ga_init2(&dfunc->df_var_names, sizeof(char_u *), 10);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01003241 ++dfunc->df_refcount;
Bram Moolenaar09689a02020-05-09 22:50:08 +02003242 ++def_functions.ga_len;
3243 return OK;
3244}
3245
3246/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003247 * After ex_function() has collected all the function lines: parse and compile
3248 * the lines into instructions.
3249 * Adds the function to "def_functions".
Bram Moolenaar9e68c322020-12-25 12:38:04 +01003250 * When "check_return_type" is set then set ufunc->uf_ret_type to the type of
3251 * the return statement (used for lambda). When uf_ret_type is already set
3252 * then check that it matches.
Bram Moolenaarb2049902021-01-24 12:53:53 +01003253 * When "profiling" is true add ISN_PROF_START instructions.
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +02003254 * "outer_cctx" is set for a nested function.
Bram Moolenaar05afcee2020-03-31 23:32:31 +02003255 * This can be used recursively through compile_lambda(), which may reallocate
3256 * "def_functions".
Bram Moolenaar822ba242020-05-24 23:00:18 +02003257 * Returns OK or FAIL.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003258 */
Bram Moolenaar822ba242020-05-24 23:00:18 +02003259 int
Bram Moolenaarb2049902021-01-24 12:53:53 +01003260compile_def_function(
Bram Moolenaare99d4222021-06-13 14:01:26 +02003261 ufunc_T *ufunc,
3262 int check_return_type,
3263 compiletype_T compile_type,
3264 cctx_T *outer_cctx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003265{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003266 char_u *line = NULL;
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00003267 garray_T lines_to_free;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003268 char_u *p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003269 char *errormsg = NULL; // error message
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003270 cctx_T cctx;
3271 garray_T *instr;
Bram Moolenaard66960b2020-10-30 20:46:26 +01003272 int did_emsg_before = did_emsg;
Bram Moolenaar599410c2021-04-10 14:03:43 +02003273 int did_emsg_silent_before = did_emsg_silent;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003274 int ret = FAIL;
3275 sctx_T save_current_sctx = current_sctx;
Bram Moolenaarf4e8cdd2020-10-12 22:07:13 +02003276 int save_estack_compiling = estack_compiling;
Bram Moolenaardc4c2302021-04-25 13:54:42 +02003277 int save_cmod_flags = cmdmod.cmod_flags;
Bram Moolenaar25e0f582020-05-25 22:36:50 +02003278 int do_estack_push;
Bram Moolenaar6c4bfe42020-07-23 18:26:30 +02003279 int new_def_function = FALSE;
Bram Moolenaarf002a412021-01-24 13:34:18 +01003280#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01003281 int prof_lnum = -1;
Bram Moolenaarf002a412021-01-24 13:34:18 +01003282#endif
Bram Moolenaare99d4222021-06-13 14:01:26 +02003283 int debug_lnum = -1;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003284
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00003285 // allocated lines are freed at the end
3286 ga_init2(&lines_to_free, sizeof(char_u *), 50);
3287
Bram Moolenaar25e0f582020-05-25 22:36:50 +02003288 // When using a function that was compiled before: Free old instructions.
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01003289 // The index is reused. Otherwise add a new entry in "def_functions".
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003290 if (ufunc->uf_dfunc_idx > 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003291 {
Bram Moolenaar09689a02020-05-09 22:50:08 +02003292 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
3293 + ufunc->uf_dfunc_idx;
Bram Moolenaar3b814af2021-06-15 10:22:17 +02003294 isn_T *instr_dest = NULL;
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02003295
3296 switch (compile_type)
3297 {
3298 case CT_PROFILE:
3299#ifdef FEAT_PROFILE
3300 instr_dest = dfunc->df_instr_prof; break;
3301#endif
3302 case CT_NONE: instr_dest = dfunc->df_instr; break;
3303 case CT_DEBUG: instr_dest = dfunc->df_instr_debug; break;
3304 }
3305 if (instr_dest != NULL)
3306 // Was compiled in this mode before: Free old instructions.
3307 delete_def_function_contents(dfunc, FALSE);
3308 ga_clear_strings(&dfunc->df_var_names);
Bram Moolenaar1d84f762022-09-03 21:35:53 +01003309 dfunc->df_defer_var_idx = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003310 }
Bram Moolenaar6c4bfe42020-07-23 18:26:30 +02003311 else
3312 {
3313 if (add_def_function(ufunc) == FAIL)
3314 return FAIL;
3315 new_def_function = TRUE;
3316 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003317
Bram Moolenaar96923b72022-03-15 15:57:04 +00003318 if ((ufunc->uf_flags & FC_CLOSURE) && outer_cctx == NULL)
3319 {
3320 semsg(_(e_compiling_closure_without_context_str),
3321 printable_func_name(ufunc));
3322 return FAIL;
3323 }
3324
Bram Moolenaar985116a2020-07-12 17:31:09 +02003325 ufunc->uf_def_status = UF_COMPILING;
3326
Bram Moolenaara80faa82020-04-12 19:37:17 +02003327 CLEAR_FIELD(cctx);
Bram Moolenaarb2049902021-01-24 12:53:53 +01003328
Bram Moolenaare99d4222021-06-13 14:01:26 +02003329 cctx.ctx_compile_type = compile_type;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003330 cctx.ctx_ufunc = ufunc;
3331 cctx.ctx_lnum = -1;
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +02003332 cctx.ctx_outer = outer_cctx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003333 ga_init2(&cctx.ctx_locals, sizeof(lvar_T), 10);
Bram Moolenaar078a4612022-01-04 15:17:03 +00003334 // Each entry on the type stack consists of two type pointers.
3335 ga_init2(&cctx.ctx_type_stack, sizeof(type2_T), 50);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003336 cctx.ctx_type_list = &ufunc->uf_type_list;
3337 ga_init2(&cctx.ctx_instr, sizeof(isn_T), 50);
3338 instr = &cctx.ctx_instr;
3339
Bram Moolenaar25e0f582020-05-25 22:36:50 +02003340 // Set the context to the function, it may be compiled when called from
3341 // another script. Set the script version to the most modern one.
3342 // The line number will be set in next_line_from_context().
3343 current_sctx = ufunc->uf_script_ctx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003344 current_sctx.sc_version = SCRIPT_VERSION_VIM9;
3345
Bram Moolenaardc4c2302021-04-25 13:54:42 +02003346 // Don't use the flag from ":legacy" here.
3347 cmdmod.cmod_flags &= ~CMOD_LEGACY;
3348
Bram Moolenaar25e0f582020-05-25 22:36:50 +02003349 // Make sure error messages are OK.
3350 do_estack_push = !estack_top_is_ufunc(ufunc, 1);
3351 if (do_estack_push)
3352 estack_push_ufunc(ufunc, 1);
Bram Moolenaarf4e8cdd2020-10-12 22:07:13 +02003353 estack_compiling = TRUE;
Bram Moolenaar25e0f582020-05-25 22:36:50 +02003354
Bram Moolenaar9a015112021-12-31 14:06:45 +00003355 if (check_args_shadowing(ufunc, &cctx) == FAIL)
3356 goto erret;
3357
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003358 // For an object method and constructor "this" is the first local variable.
Bram Moolenaar574950d2023-01-03 19:08:50 +00003359 if (ufunc->uf_flags & (FC_OBJECT|FC_NEW))
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003360 {
3361 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
3362 + ufunc->uf_dfunc_idx;
3363 if (GA_GROW_FAILS(&dfunc->df_var_names, 1))
3364 goto erret;
3365 ((char_u **)dfunc->df_var_names.ga_data)[0] =
3366 vim_strsave((char_u *)"this");
3367 ++dfunc->df_var_names.ga_len;
3368
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00003369 // In the constructor allocate memory for the object and initialize the
3370 // object members.
Yegappan Lakshmanan1db15142023-09-19 20:34:05 +02003371 if (IS_CONSTRUCTOR_METHOD(ufunc))
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00003372 {
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003373 generate_CONSTRUCT(&cctx, ufunc->uf_class);
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00003374
3375 for (int i = 0; i < ufunc->uf_class->class_obj_member_count; ++i)
3376 {
Bram Moolenaard505d172022-12-18 21:42:55 +00003377 ocmember_T *m = &ufunc->uf_class->class_obj_members[i];
3378 if (m->ocm_init != NULL)
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00003379 {
Bram Moolenaard505d172022-12-18 21:42:55 +00003380 char_u *expr = m->ocm_init;
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00003381 if (compile_expr0(&expr, &cctx) == FAIL)
3382 goto erret;
Bram Moolenaard505d172022-12-18 21:42:55 +00003383 if (!ends_excmd2(m->ocm_init, expr))
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00003384 {
3385 semsg(_(e_trailing_characters_str), expr);
3386 goto erret;
3387 }
Yegappan Lakshmanan618e47d2023-08-22 21:29:28 +02003388
3389 type_T *type = get_type_on_stack(&cctx, 0);
Yegappan Lakshmananfe7b20a2023-10-04 19:47:52 +02003390 if (m->ocm_type->tt_type == VAR_ANY
Yegappan Lakshmanane5437c52023-12-16 14:11:19 +01003391 && !(m->ocm_flags & OCMFLAG_HAS_TYPE)
Yegappan Lakshmananfe7b20a2023-10-04 19:47:52 +02003392 && type->tt_type != VAR_SPECIAL)
3393 {
3394 // If the member variable type is not yet set, then use
3395 // the initialization expression type.
3396 m->ocm_type = type;
3397 }
3398 else if (m->ocm_type->tt_type != type->tt_type)
Yegappan Lakshmanan618e47d2023-08-22 21:29:28 +02003399 {
3400 // The type of the member initialization expression is
3401 // determined at run time. Add a runtime type check.
3402 where_T where = WHERE_INIT;
3403 where.wt_kind = WT_MEMBER;
3404 where.wt_func_name = (char *)m->ocm_name;
3405 if (need_type_where(type, m->ocm_type, FALSE, -1,
3406 where, &cctx, FALSE, FALSE) == FAIL)
3407 goto erret;
3408 }
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00003409 }
3410 else
Bram Moolenaard505d172022-12-18 21:42:55 +00003411 push_default_value(&cctx, m->ocm_type->tt_type,
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00003412 FALSE, NULL);
3413 generate_STORE_THIS(&cctx, i);
3414 }
3415 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003416 }
3417
Bram Moolenaar170fcfc2020-02-06 17:51:35 +01003418 if (ufunc->uf_def_args.ga_len > 0)
3419 {
3420 int count = ufunc->uf_def_args.ga_len;
Bram Moolenaar49cf7cc2020-04-07 22:45:00 +02003421 int first_def_arg = ufunc->uf_args.ga_len - count;
Bram Moolenaar170fcfc2020-02-06 17:51:35 +01003422 int i;
Bram Moolenaar170fcfc2020-02-06 17:51:35 +01003423 int off = STACK_FRAME_SIZE + (ufunc->uf_va_name != NULL ? 1 : 0);
Bram Moolenaarb8070e32020-07-23 20:56:04 +02003424 int did_set_arg_type = FALSE;
Bram Moolenaar170fcfc2020-02-06 17:51:35 +01003425
3426 // Produce instructions for the default values of optional arguments.
Bram Moolenaar12bce952021-03-11 20:04:04 +01003427 SOURCING_LNUM = 0; // line number unknown
Bram Moolenaar170fcfc2020-02-06 17:51:35 +01003428 for (i = 0; i < count; ++i)
3429 {
Bram Moolenaar65b0d162022-12-13 18:43:22 +00003430 char_u *arg = ((char_u **)(ufunc->uf_def_args.ga_data))[i];
3431 if (STRCMP(arg, "v:none") == 0)
3432 // "arg = v:none" means the argument is optional without
3433 // setting a value when the argument is missing.
3434 continue;
3435
Bram Moolenaar49cf7cc2020-04-07 22:45:00 +02003436 type_T *val_type;
3437 int arg_idx = first_def_arg + i;
Bram Moolenaar7a3fe3e2021-07-22 14:58:47 +02003438 where_T where = WHERE_INIT;
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +02003439 int jump_instr_idx = instr->ga_len;
3440 isn_T *isn;
3441
3442 // Use a JUMP_IF_ARG_SET instruction to skip if the value was given.
Bram Moolenaar65b0d162022-12-13 18:43:22 +00003443 if (generate_JUMP_IF_ARG(&cctx, ISN_JUMP_IF_ARG_SET,
3444 i - count - off) == FAIL)
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +02003445 goto erret;
Bram Moolenaar12bce952021-03-11 20:04:04 +01003446
3447 // Make sure later arguments are not found.
Bram Moolenaare28d9b32021-07-03 18:56:53 +02003448 ufunc->uf_args_visible = arg_idx;
Bram Moolenaar49cf7cc2020-04-07 22:45:00 +02003449
Bram Moolenaar65b0d162022-12-13 18:43:22 +00003450 int r = compile_expr0(&arg, &cctx);
Bram Moolenaar12bce952021-03-11 20:04:04 +01003451 if (r == FAIL)
Bram Moolenaar49cf7cc2020-04-07 22:45:00 +02003452 goto erret;
3453
3454 // If no type specified use the type of the default value.
3455 // Otherwise check that the default value type matches the
3456 // specified type.
Bram Moolenaar078a4612022-01-04 15:17:03 +00003457 val_type = get_type_on_stack(&cctx, 0);
Bram Moolenaarf785aa12021-02-11 21:19:34 +01003458 where.wt_index = arg_idx + 1;
LemonBoyc5d27442023-08-19 13:02:35 +02003459 where.wt_kind = WT_ARGUMENT;
Bram Moolenaar49cf7cc2020-04-07 22:45:00 +02003460 if (ufunc->uf_arg_types[arg_idx] == &t_unknown)
Bram Moolenaarb8070e32020-07-23 20:56:04 +02003461 {
3462 did_set_arg_type = TRUE;
Bram Moolenaar49cf7cc2020-04-07 22:45:00 +02003463 ufunc->uf_arg_types[arg_idx] = val_type;
Bram Moolenaarb8070e32020-07-23 20:56:04 +02003464 }
Bram Moolenaarfa46ead2021-12-22 13:18:39 +00003465 else if (need_type_where(val_type, ufunc->uf_arg_types[arg_idx],
Bram Moolenaarc6951a72022-12-29 20:56:24 +00003466 FALSE, -1, where, &cctx, FALSE, FALSE) == FAIL)
Bram Moolenaar49cf7cc2020-04-07 22:45:00 +02003467 goto erret;
Bram Moolenaar49cf7cc2020-04-07 22:45:00 +02003468
3469 if (generate_STORE(&cctx, ISN_STORE, i - count - off, NULL) == FAIL)
Bram Moolenaar170fcfc2020-02-06 17:51:35 +01003470 goto erret;
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +02003471
3472 // set instruction index in JUMP_IF_ARG_SET to here
3473 isn = ((isn_T *)instr->ga_data) + jump_instr_idx;
3474 isn->isn_arg.jumparg.jump_where = instr->ga_len;
Bram Moolenaar170fcfc2020-02-06 17:51:35 +01003475 }
Bram Moolenaarb8070e32020-07-23 20:56:04 +02003476
3477 if (did_set_arg_type)
3478 set_function_type(ufunc);
Bram Moolenaar170fcfc2020-02-06 17:51:35 +01003479 }
Bram Moolenaare28d9b32021-07-03 18:56:53 +02003480 ufunc->uf_args_visible = ufunc->uf_args.ga_len;
Bram Moolenaar170fcfc2020-02-06 17:51:35 +01003481
Bram Moolenaarb8bebd02023-01-30 20:24:23 +00003482 // Compiling a function in an interface is done to get the function type.
3483 // No code is actually compiled.
3484 if (ufunc->uf_class != NULL
3485 && (ufunc->uf_class->class_flags & CLASS_INTERFACE))
3486 {
3487 ufunc->uf_def_status = UF_NOT_COMPILED;
3488 ret = OK;
3489 goto erret;
3490 }
3491
Bram Moolenaar170fcfc2020-02-06 17:51:35 +01003492 /*
3493 * Loop over all the lines of the function and generate instructions.
3494 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003495 for (;;)
3496 {
Bram Moolenaar2dd0a2c2020-08-08 15:10:27 +02003497 exarg_T ea;
Bram Moolenaar2dd0a2c2020-08-08 15:10:27 +02003498 int starts_with_colon = FALSE;
3499 char_u *cmd;
Bram Moolenaar02194d22020-10-24 23:08:38 +02003500 cmdmod_T local_cmdmod;
Bram Moolenaar5b1c8fe2020-02-21 18:42:43 +01003501
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003502 // Bail out on the first error to avoid a flood of errors and report
3503 // the right line number when inside try/catch.
Bram Moolenaard66960b2020-10-30 20:46:26 +01003504 if (did_emsg_before != did_emsg)
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003505 goto erret;
3506
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003507 if (line != NULL && *line == '|')
3508 // the line continues after a '|'
3509 ++line;
Bram Moolenaara3b7fdc2020-06-21 14:12:17 +02003510 else if (line != NULL && *skipwhite(line) != NUL
Bram Moolenaar7a092242020-04-16 22:10:49 +02003511 && !(*line == '#' && (line == cctx.ctx_line_start
3512 || VIM_ISWHITE(line[-1]))))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003513 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00003514 semsg(_(e_trailing_characters_str), line);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003515 goto erret;
3516 }
Bram Moolenaar4b3e1962021-03-18 21:37:55 +01003517 else if (line != NULL && vim9_bad_comment(skipwhite(line)))
3518 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003519 else
3520 {
Bram Moolenaar23c55272020-06-21 16:58:13 +02003521 line = next_line_from_context(&cctx, FALSE);
Bram Moolenaar4fdae992020-04-12 16:38:57 +02003522 if (cctx.ctx_lnum >= ufunc->uf_lines.ga_len)
Bram Moolenaarb2049902021-01-24 12:53:53 +01003523 {
Bram Moolenaarcb711ab2020-04-16 13:00:29 +02003524 // beyond the last line
Bram Moolenaarf002a412021-01-24 13:34:18 +01003525#ifdef FEAT_PROFILE
Bram Moolenaarced68a02021-01-24 17:53:47 +01003526 if (cctx.ctx_skip != SKIP_YES)
3527 may_generate_prof_end(&cctx, prof_lnum);
Bram Moolenaarf002a412021-01-24 13:34:18 +01003528#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003529 break;
Bram Moolenaarb2049902021-01-24 12:53:53 +01003530 }
Bram Moolenaarf62d7392021-04-14 12:40:00 +02003531 // Make a copy, splitting off nextcmd and removing trailing spaces
3532 // may change it.
3533 if (line != NULL)
3534 {
3535 line = vim_strsave(line);
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00003536 if (ga_add_string(&lines_to_free, line) == FAIL)
3537 goto erret;
Bram Moolenaarf62d7392021-04-14 12:40:00 +02003538 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003539 }
3540
Bram Moolenaara80faa82020-04-12 19:37:17 +02003541 CLEAR_FIELD(ea);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003542 ea.cmdlinep = &line;
3543 ea.cmd = skipwhite(line);
Bram Moolenaar97f8c102022-04-02 19:43:57 +01003544 ea.skip = cctx.ctx_skip == SKIP_YES;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003545
Bram Moolenaarb2049902021-01-24 12:53:53 +01003546 if (*ea.cmd == '#')
3547 {
Bram Moolenaarad6d9cc2022-08-08 21:43:11 +01003548 // "#" starts a comment, but "#{" is an error
3549 if (vim9_bad_comment(ea.cmd))
3550 goto erret;
Bram Moolenaarb2049902021-01-24 12:53:53 +01003551 line = (char_u *)"";
3552 continue;
3553 }
3554
Bram Moolenaarf002a412021-01-24 13:34:18 +01003555#ifdef FEAT_PROFILE
Bram Moolenaare99d4222021-06-13 14:01:26 +02003556 if (cctx.ctx_compile_type == CT_PROFILE && cctx.ctx_lnum != prof_lnum
3557 && cctx.ctx_skip != SKIP_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01003558 {
3559 may_generate_prof_end(&cctx, prof_lnum);
3560
3561 prof_lnum = cctx.ctx_lnum;
3562 generate_instr(&cctx, ISN_PROF_START);
3563 }
Bram Moolenaarf002a412021-01-24 13:34:18 +01003564#endif
Bram Moolenaare99d4222021-06-13 14:01:26 +02003565 if (cctx.ctx_compile_type == CT_DEBUG && cctx.ctx_lnum != debug_lnum
3566 && cctx.ctx_skip != SKIP_YES)
3567 {
3568 debug_lnum = cctx.ctx_lnum;
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02003569 generate_instr_debug(&cctx);
Bram Moolenaare99d4222021-06-13 14:01:26 +02003570 }
Bram Moolenaar8cec9272021-06-23 20:20:53 +02003571 cctx.ctx_prev_lnum = cctx.ctx_lnum + 1;
Bram Moolenaarb2049902021-01-24 12:53:53 +01003572
Bram Moolenaarcb711ab2020-04-16 13:00:29 +02003573 // Some things can be recognized by the first character.
3574 switch (*ea.cmd)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003575 {
Bram Moolenaarcb711ab2020-04-16 13:00:29 +02003576 case '}':
3577 {
3578 // "}" ends a block scope
3579 scopetype_T stype = cctx.ctx_scope == NULL
3580 ? NO_SCOPE : cctx.ctx_scope->se_type;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003581
Bram Moolenaarcb711ab2020-04-16 13:00:29 +02003582 if (stype == BLOCK_SCOPE)
3583 {
3584 compile_endblock(&cctx);
3585 line = ea.cmd;
3586 }
3587 else
3588 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003589 emsg(_(e_using_rcurly_outside_if_block_scope));
Bram Moolenaarcb711ab2020-04-16 13:00:29 +02003590 goto erret;
3591 }
3592 if (line != NULL)
3593 line = skipwhite(ea.cmd + 1);
3594 continue;
3595 }
3596
3597 case '{':
3598 // "{" starts a block scope
3599 // "{'a': 1}->func() is something else
3600 if (ends_excmd(*skipwhite(ea.cmd + 1)))
3601 {
3602 line = compile_block(ea.cmd, &cctx);
3603 continue;
3604 }
3605 break;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003606 }
3607
3608 /*
3609 * COMMAND MODIFIERS
3610 */
Bram Moolenaar02194d22020-10-24 23:08:38 +02003611 cctx.ctx_has_cmdmod = FALSE;
Bram Moolenaare1004402020-10-24 20:49:43 +02003612 if (parse_command_modifiers(&ea, &errormsg, &local_cmdmod, FALSE)
3613 == FAIL)
Bram Moolenaarbc510062022-02-14 21:19:04 +00003614 goto erret;
Bram Moolenaare1004402020-10-24 20:49:43 +02003615 generate_cmdmods(&cctx, &local_cmdmod);
3616 undo_cmdmod(&local_cmdmod);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003617
Bram Moolenaare88c8e82020-11-01 17:03:37 +01003618 // Check if there was a colon after the last command modifier or before
3619 // the current position.
3620 for (p = ea.cmd; p >= line; --p)
3621 {
3622 if (*p == ':')
3623 starts_with_colon = TRUE;
3624 if (p < ea.cmd && !VIM_ISWHITE(*p))
3625 break;
3626 }
3627
Bram Moolenaarce024c32021-06-26 13:00:49 +02003628 // Skip ":call" to get to the function name, unless using :legacy
Bram Moolenaar575f24b2020-08-12 14:21:11 +02003629 p = ea.cmd;
Bram Moolenaarce024c32021-06-26 13:00:49 +02003630 if (!(local_cmdmod.cmod_flags & CMOD_LEGACY))
Bram Moolenaar575f24b2020-08-12 14:21:11 +02003631 {
Bram Moolenaarce024c32021-06-26 13:00:49 +02003632 if (checkforcmd(&ea.cmd, "call", 3))
3633 {
3634 if (*ea.cmd == '(')
3635 // not for "call()"
3636 ea.cmd = p;
3637 else
3638 ea.cmd = skipwhite(ea.cmd);
3639 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003640
Bram Moolenaarce024c32021-06-26 13:00:49 +02003641 if (!starts_with_colon)
3642 {
3643 int assign;
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02003644
Bram Moolenaarce024c32021-06-26 13:00:49 +02003645 // Check for assignment after command modifiers.
3646 assign = may_compile_assignment(&ea, &line, &cctx);
3647 if (assign == OK)
3648 goto nextline;
3649 if (assign == FAIL)
3650 goto erret;
3651 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003652 }
3653
3654 /*
3655 * COMMAND after range
Bram Moolenaar3d48e252020-07-15 14:15:52 +02003656 * 'text'->func() should not be confused with 'a mark
Bram Moolenaarc1e6c7b2022-02-20 18:26:46 +00003657 * 0z1234->func() should not be confused with a zero line number
Bram Moolenaarbdc0f1c2021-04-24 19:08:24 +02003658 * "++nr" and "--nr" are eval commands
Bram Moolenaar5ca5cc62021-08-24 21:56:03 +02003659 * in "$ENV->func()" the "$" is not a range
Bram Moolenaar31d99482022-05-26 22:24:43 +01003660 * "123->func()" is a method call
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003661 */
Bram Moolenaardf069ee2020-06-22 23:02:51 +02003662 cmd = ea.cmd;
Bram Moolenaarb579f6e2021-12-04 11:57:00 +00003663 if ((*cmd != '$' || starts_with_colon)
Bram Moolenaarc1e6c7b2022-02-20 18:26:46 +00003664 && (starts_with_colon
3665 || !(*cmd == '\''
3666 || (cmd[0] == '0' && cmd[1] == 'z')
3667 || (cmd[0] != NUL && cmd[0] == cmd[1]
Bram Moolenaar31d99482022-05-26 22:24:43 +01003668 && (*cmd == '+' || *cmd == '-'))
3669 || number_method(cmd))))
Bram Moolenaardf069ee2020-06-22 23:02:51 +02003670 {
Bram Moolenaar3bd8de42020-09-14 16:37:34 +02003671 ea.cmd = skip_range(ea.cmd, TRUE, NULL);
Bram Moolenaar5d72ce62020-08-20 23:04:06 +02003672 if (ea.cmd > cmd)
Bram Moolenaar3d48e252020-07-15 14:15:52 +02003673 {
Bram Moolenaarb579f6e2021-12-04 11:57:00 +00003674 if (!starts_with_colon
3675 && !(local_cmdmod.cmod_flags & CMOD_LEGACY))
Bram Moolenaar5d72ce62020-08-20 23:04:06 +02003676 {
Bram Moolenaar6e2c2c52020-12-25 19:25:45 +01003677 semsg(_(e_colon_required_before_range_str), cmd);
Bram Moolenaar5d72ce62020-08-20 23:04:06 +02003678 goto erret;
3679 }
Bram Moolenaarada1d872021-02-20 08:16:51 +01003680 ea.addr_count = 1;
Bram Moolenaar5d72ce62020-08-20 23:04:06 +02003681 if (ends_excmd2(line, ea.cmd))
3682 {
3683 // A range without a command: jump to the line.
Bram Moolenaare4eed8c2021-12-01 15:22:56 +00003684 generate_EXEC(&cctx, ISN_EXECRANGE,
Bram Moolenaarb579f6e2021-12-04 11:57:00 +00003685 vim_strnsave(cmd, ea.cmd - cmd));
Bram Moolenaare4eed8c2021-12-01 15:22:56 +00003686 line = ea.cmd;
Bram Moolenaar5d72ce62020-08-20 23:04:06 +02003687 goto nextline;
3688 }
Bram Moolenaar3d48e252020-07-15 14:15:52 +02003689 }
Bram Moolenaardf069ee2020-06-22 23:02:51 +02003690 }
Bram Moolenaar47bc9c32021-07-17 21:24:56 +02003691 p = find_ex_command(&ea, NULL,
3692 starts_with_colon || (local_cmdmod.cmod_flags & CMOD_LEGACY)
Bram Moolenaar77b10ff2021-03-14 13:21:35 +01003693 ? NULL : item_exists, &cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003694
Bram Moolenaard1510ee2021-01-04 16:15:58 +01003695 if (p == NULL)
3696 {
3697 if (cctx.ctx_skip != SKIP_YES)
Bram Moolenaarbed34f02022-01-19 20:48:37 +00003698 semsg(_(e_ambiguous_use_of_user_defined_command_str), ea.cmd);
Bram Moolenaard1510ee2021-01-04 16:15:58 +01003699 goto erret;
3700 }
3701
Bram Moolenaar96cf4ba2021-04-24 14:15:41 +02003702 // When using ":legacy cmd" always use compile_exec().
3703 if (local_cmdmod.cmod_flags & CMOD_LEGACY)
Bram Moolenaar3b1373b2021-05-17 00:01:42 +02003704 {
3705 char_u *start = ea.cmd;
3706
Bram Moolenaarc3cb1c92021-06-02 16:47:53 +02003707 switch (ea.cmdidx)
3708 {
3709 case CMD_if:
3710 case CMD_elseif:
3711 case CMD_else:
3712 case CMD_endif:
3713 case CMD_for:
3714 case CMD_endfor:
3715 case CMD_continue:
3716 case CMD_break:
3717 case CMD_while:
3718 case CMD_endwhile:
3719 case CMD_try:
3720 case CMD_catch:
3721 case CMD_finally:
3722 case CMD_endtry:
3723 semsg(_(e_cannot_use_legacy_with_command_str), ea.cmd);
3724 goto erret;
3725 default: break;
3726 }
3727
Bram Moolenaar3b1373b2021-05-17 00:01:42 +02003728 // ":legacy return expr" needs to be handled differently.
3729 if (checkforcmd(&start, "return", 4))
3730 ea.cmdidx = CMD_return;
3731 else
3732 ea.cmdidx = CMD_legacy;
3733 }
Bram Moolenaar96cf4ba2021-04-24 14:15:41 +02003734
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003735 if (p == ea.cmd && ea.cmdidx != CMD_SIZE)
3736 {
Bram Moolenaar97f8c102022-04-02 19:43:57 +01003737 // "eval" is used for "val->func()" and "var" for "var = val", then
3738 // "p" is equal to "ea.cmd" for a valid command.
3739 if (ea.cmdidx == CMD_eval || ea.cmdidx == CMD_var)
3740 ;
3741 else if (cctx.ctx_skip == SKIP_YES)
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003742 {
3743 line += STRLEN(line);
Bram Moolenaarf665e972020-12-05 19:17:16 +01003744 goto nextline;
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003745 }
Bram Moolenaar97f8c102022-04-02 19:43:57 +01003746 else
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003747 {
Bram Moolenaar52c124d2020-12-20 21:43:35 +01003748 semsg(_(e_command_not_recognized_str), ea.cmd);
Bram Moolenaar007f9d62020-07-06 23:04:49 +02003749 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003750 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003751 }
3752
Bram Moolenaara2c00282023-05-14 22:05:15 +01003753 if ((cctx.ctx_had_return || cctx.ctx_had_throw)
Bram Moolenaara259d8d2020-01-31 20:10:50 +01003754 && ea.cmdidx != CMD_elseif
3755 && ea.cmdidx != CMD_else
Bram Moolenaarefd88552020-06-18 20:50:10 +02003756 && ea.cmdidx != CMD_endif
3757 && ea.cmdidx != CMD_endfor
3758 && ea.cmdidx != CMD_endwhile
3759 && ea.cmdidx != CMD_catch
3760 && ea.cmdidx != CMD_finally
Bram Moolenaar9d383f32023-05-14 21:38:12 +01003761 && ea.cmdidx != CMD_endtry
3762 && !ignore_unreachable_code_for_testing)
Bram Moolenaarefd88552020-06-18 20:50:10 +02003763 {
Bram Moolenaara2c00282023-05-14 22:05:15 +01003764 semsg(_(e_unreachable_code_after_str),
3765 cctx.ctx_had_return ? "return" : "throw");
Bram Moolenaar3988f642020-08-27 22:43:03 +02003766 goto erret;
Bram Moolenaarefd88552020-06-18 20:50:10 +02003767 }
Bram Moolenaara2c00282023-05-14 22:05:15 +01003768 cctx.ctx_had_throw = FALSE;
Bram Moolenaarefd88552020-06-18 20:50:10 +02003769
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +02003770 p = skipwhite(p);
3771 if (ea.cmdidx != CMD_SIZE
3772 && ea.cmdidx != CMD_write && ea.cmdidx != CMD_read)
3773 {
Bram Moolenaar9b123d82020-09-14 22:39:11 +02003774 if (ea.cmdidx >= 0)
3775 ea.argt = excmd_get_argt(ea.cmdidx);
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +02003776 if ((ea.argt & EX_BANG) && *p == '!')
3777 {
3778 ea.forceit = TRUE;
3779 p = skipwhite(p + 1);
3780 }
Bram Moolenaar09d94212022-05-05 15:20:03 +01003781 if ((ea.argt & EX_RANGE) == 0 && ea.addr_count > 0)
3782 {
3783 emsg(_(e_no_range_allowed));
3784 goto erret;
3785 }
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +02003786 }
3787
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003788 switch (ea.cmdidx)
3789 {
3790 case CMD_def:
Bram Moolenaar38453522021-11-28 22:00:12 +00003791 case CMD_function:
Bram Moolenaar04b12692020-05-04 23:24:44 +02003792 ea.arg = p;
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00003793 line = compile_nested_function(&ea, &cctx, &lines_to_free);
Bram Moolenaar04b12692020-05-04 23:24:44 +02003794 break;
3795
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003796 case CMD_return:
Bram Moolenaar3b1373b2021-05-17 00:01:42 +02003797 line = compile_return(p, check_return_type,
3798 local_cmdmod.cmod_flags & CMOD_LEGACY, &cctx);
Bram Moolenaarefd88552020-06-18 20:50:10 +02003799 cctx.ctx_had_return = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003800 break;
3801
3802 case CMD_let:
Bram Moolenaarc58f5452020-10-21 20:58:52 +02003803 emsg(_(e_cannot_use_let_in_vim9_script));
3804 break;
Bram Moolenaar30fd8202020-09-26 15:09:30 +02003805 case CMD_var:
3806 case CMD_final:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003807 case CMD_const:
Bram Moolenaarbdc0f1c2021-04-24 19:08:24 +02003808 case CMD_increment:
3809 case CMD_decrement:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003810 line = compile_assignment(p, &ea, ea.cmdidx, &cctx);
Bram Moolenaar47a519a2020-06-14 23:05:10 +02003811 if (line == p)
Bram Moolenaar8b716f52022-02-15 21:17:56 +00003812 {
3813 emsg(_(e_invalid_assignment));
Bram Moolenaar47a519a2020-06-14 23:05:10 +02003814 line = NULL;
Bram Moolenaar8b716f52022-02-15 21:17:56 +00003815 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003816 break;
3817
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02003818 case CMD_unlet:
3819 case CMD_unlockvar:
3820 case CMD_lockvar:
3821 line = compile_unletlock(p, &ea, &cctx);
3822 break;
3823
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003824 case CMD_import:
Bram Moolenaar4db572e2021-07-18 18:21:38 +02003825 emsg(_(e_import_can_only_be_used_in_script));
3826 line = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003827 break;
3828
3829 case CMD_if:
3830 line = compile_if(p, &cctx);
3831 break;
3832 case CMD_elseif:
3833 line = compile_elseif(p, &cctx);
Bram Moolenaarefd88552020-06-18 20:50:10 +02003834 cctx.ctx_had_return = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003835 break;
3836 case CMD_else:
3837 line = compile_else(p, &cctx);
Bram Moolenaarefd88552020-06-18 20:50:10 +02003838 cctx.ctx_had_return = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003839 break;
3840 case CMD_endif:
3841 line = compile_endif(p, &cctx);
3842 break;
3843
3844 case CMD_while:
3845 line = compile_while(p, &cctx);
3846 break;
3847 case CMD_endwhile:
3848 line = compile_endwhile(p, &cctx);
Bram Moolenaarefd88552020-06-18 20:50:10 +02003849 cctx.ctx_had_return = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003850 break;
3851
3852 case CMD_for:
3853 line = compile_for(p, &cctx);
3854 break;
3855 case CMD_endfor:
3856 line = compile_endfor(p, &cctx);
Bram Moolenaarefd88552020-06-18 20:50:10 +02003857 cctx.ctx_had_return = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003858 break;
3859 case CMD_continue:
3860 line = compile_continue(p, &cctx);
3861 break;
3862 case CMD_break:
3863 line = compile_break(p, &cctx);
3864 break;
3865
3866 case CMD_try:
3867 line = compile_try(p, &cctx);
3868 break;
3869 case CMD_catch:
3870 line = compile_catch(p, &cctx);
Bram Moolenaarefd88552020-06-18 20:50:10 +02003871 cctx.ctx_had_return = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003872 break;
3873 case CMD_finally:
3874 line = compile_finally(p, &cctx);
Bram Moolenaarefd88552020-06-18 20:50:10 +02003875 cctx.ctx_had_return = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003876 break;
3877 case CMD_endtry:
3878 line = compile_endtry(p, &cctx);
3879 break;
3880 case CMD_throw:
3881 line = compile_throw(p, &cctx);
Bram Moolenaara2c00282023-05-14 22:05:15 +01003882 cctx.ctx_had_throw = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003883 break;
3884
Bram Moolenaar007f9d62020-07-06 23:04:49 +02003885 case CMD_eval:
Bram Moolenaarc3235272021-07-10 19:42:03 +02003886 line = compile_eval(p, &cctx);
Bram Moolenaar007f9d62020-07-06 23:04:49 +02003887 break;
3888
Bram Moolenaar1d84f762022-09-03 21:35:53 +01003889 case CMD_defer:
3890 line = compile_defer(p, &cctx);
3891 break;
3892
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003893#ifdef HAS_MESSAGE_WINDOW
3894 case CMD_echowindow:
3895 {
3896 long cmd_count = get_cmd_count(line, &ea);
Bram Moolenaar2eae3d22022-10-07 15:09:27 +01003897 if (cmd_count < 0)
3898 line = NULL;
3899 else
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003900 line = compile_mult_expr(p, ea.cmdidx,
3901 cmd_count, &cctx);
3902 }
3903 break;
3904#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003905 case CMD_echo:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003906 case CMD_echon:
Bram Moolenaar7de62622021-08-07 15:05:47 +02003907 case CMD_echoconsole:
Bram Moolenaar7d7ad7b2022-09-01 16:00:53 +01003908 case CMD_echoerr:
3909 case CMD_echomsg:
Bram Moolenaar7d7ad7b2022-09-01 16:00:53 +01003910 case CMD_execute:
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003911 line = compile_mult_expr(p, ea.cmdidx, 0, &cctx);
Bram Moolenaarad39c092020-02-26 18:23:43 +01003912 break;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003913
Bram Moolenaarc3516f72020-09-08 22:45:35 +02003914 case CMD_put:
3915 ea.cmd = cmd;
3916 line = compile_put(p, &ea, &cctx);
3917 break;
3918
Bram Moolenaar4c137212021-04-19 16:48:48 +02003919 case CMD_substitute:
Bram Moolenaar7b829262021-10-13 15:04:34 +01003920 if (check_global_and_subst(ea.cmd, p) == FAIL)
3921 goto erret;
Bram Moolenaar4c137212021-04-19 16:48:48 +02003922 if (cctx.ctx_skip == SKIP_YES)
3923 line = (char_u *)"";
3924 else
3925 {
3926 ea.arg = p;
3927 line = compile_substitute(line, &ea, &cctx);
3928 }
3929 break;
3930
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02003931 case CMD_redir:
3932 ea.arg = p;
3933 line = compile_redir(line, &ea, &cctx);
3934 break;
3935
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02003936 case CMD_cexpr:
3937 case CMD_lexpr:
3938 case CMD_caddexpr:
3939 case CMD_laddexpr:
3940 case CMD_cgetexpr:
3941 case CMD_lgetexpr:
Bram Moolenaarb7c97812021-05-05 22:51:39 +02003942#ifdef FEAT_QUICKFIX
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02003943 ea.arg = p;
3944 line = compile_cexpr(line, &ea, &cctx);
Bram Moolenaarb7c97812021-05-05 22:51:39 +02003945#else
3946 ex_ni(&ea);
3947 line = NULL;
3948#endif
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02003949 break;
3950
Bram Moolenaarae616492020-07-28 20:07:27 +02003951 case CMD_append:
3952 case CMD_change:
3953 case CMD_insert:
Bram Moolenaar10b94212021-02-19 21:42:57 +01003954 case CMD_k:
Bram Moolenaarf5a48012020-08-01 17:00:03 +02003955 case CMD_t:
Bram Moolenaarae616492020-07-28 20:07:27 +02003956 case CMD_xit:
3957 not_in_vim9(&ea);
3958 goto erret;
3959
Bram Moolenaar002262f2020-07-08 17:47:57 +02003960 case CMD_SIZE:
Bram Moolenaar3988f642020-08-27 22:43:03 +02003961 if (cctx.ctx_skip != SKIP_YES)
3962 {
3963 semsg(_(e_invalid_command_str), ea.cmd);
3964 goto erret;
3965 }
3966 // We don't check for a next command here.
3967 line = (char_u *)"";
3968 break;
Bram Moolenaar002262f2020-07-08 17:47:57 +02003969
Bram Moolenaar20677332021-06-06 17:02:53 +02003970 case CMD_lua:
3971 case CMD_mzscheme:
3972 case CMD_perl:
3973 case CMD_py3:
3974 case CMD_python3:
3975 case CMD_python:
3976 case CMD_pythonx:
3977 case CMD_ruby:
3978 case CMD_tcl:
3979 ea.arg = p;
3980 if (vim_strchr(line, '\n') == NULL)
Bram Moolenaar5163fcc2020-08-27 23:37:09 +02003981 line = compile_exec(line, &ea, &cctx);
Bram Moolenaar20677332021-06-06 17:02:53 +02003982 else
3983 // heredoc lines have been concatenated with NL
3984 // characters in get_function_body()
3985 line = compile_script(line, &cctx);
3986 break;
3987
Bram Moolenaar107f7322022-02-06 17:30:41 +00003988 case CMD_vim9script:
Bram Moolenaar8cbf2492022-02-06 20:28:13 +00003989 if (cctx.ctx_skip != SKIP_YES)
3990 {
3991 emsg(_(e_vim9script_can_only_be_used_in_script));
3992 goto erret;
3993 }
3994 line = (char_u *)"";
3995 break;
Bram Moolenaar107f7322022-02-06 17:30:41 +00003996
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02003997 case CMD_type:
3998 emsg(_(e_type_can_only_be_used_in_script));
3999 goto erret;
4000 break;
4001
Bram Moolenaar7b829262021-10-13 15:04:34 +01004002 case CMD_global:
4003 if (check_global_and_subst(ea.cmd, p) == FAIL)
4004 goto erret;
4005 // FALLTHROUGH
Bram Moolenaar20677332021-06-06 17:02:53 +02004006 default:
4007 // Not recognized, execute with do_cmdline_cmd().
4008 ea.arg = p;
4009 line = compile_exec(line, &ea, &cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004010 break;
4011 }
Bram Moolenaar5d72ce62020-08-20 23:04:06 +02004012nextline:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004013 if (line == NULL)
4014 goto erret;
Bram Moolenaar585fea72020-04-02 22:33:21 +02004015 line = skipwhite(line);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004016
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +02004017 // Undo any command modifiers.
Bram Moolenaar02194d22020-10-24 23:08:38 +02004018 generate_undo_cmdmods(&cctx);
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +02004019
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004020 if (cctx.ctx_type_stack.ga_len < 0)
4021 {
4022 iemsg("Type stack underflow");
4023 goto erret;
4024 }
Bram Moolenaarb8bebd02023-01-30 20:24:23 +00004025 } // END of the loop over all the function body lines.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004026
4027 if (cctx.ctx_scope != NULL)
4028 {
4029 if (cctx.ctx_scope->se_type == IF_SCOPE)
Bram Moolenaar1a992222021-12-31 17:25:48 +00004030 emsg(_(e_missing_endif));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004031 else if (cctx.ctx_scope->se_type == WHILE_SCOPE)
Bram Moolenaar1a992222021-12-31 17:25:48 +00004032 emsg(_(e_missing_endwhile));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004033 else if (cctx.ctx_scope->se_type == FOR_SCOPE)
Bram Moolenaar1a992222021-12-31 17:25:48 +00004034 emsg(_(e_missing_endfor));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004035 else
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004036 emsg(_(e_missing_rcurly));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004037 goto erret;
4038 }
4039
Bram Moolenaara2c00282023-05-14 22:05:15 +01004040 // TODO: if a function ends in "throw" but there was a return elsewhere we
4041 // should not assume the return type is "void".
4042 if (!cctx.ctx_had_return && !cctx.ctx_had_throw)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004043 {
Bram Moolenaare6174fd2021-06-12 18:30:56 +02004044 if (ufunc->uf_ret_type->tt_type == VAR_UNKNOWN)
4045 ufunc->uf_ret_type = &t_void;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004046 else if (ufunc->uf_ret_type->tt_type != VAR_VOID
Yegappan Lakshmanan1db15142023-09-19 20:34:05 +02004047 && !IS_CONSTRUCTOR_METHOD(ufunc))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004048 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004049 emsg(_(e_missing_return_statement));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004050 goto erret;
4051 }
4052
Bram Moolenaarf57b43c2021-06-15 22:13:27 +02004053 // Return void if there is no return at the end.
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004054 // For a constructor return the object.
Yegappan Lakshmanan1db15142023-09-19 20:34:05 +02004055 if (IS_CONSTRUCTOR_METHOD(ufunc))
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00004056 {
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004057 generate_instr(&cctx, ISN_RETURN_OBJECT);
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00004058 ufunc->uf_ret_type = &ufunc->uf_class->class_object_type;
4059 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004060 else
4061 generate_instr(&cctx, ISN_RETURN_VOID);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004062 }
4063
Bram Moolenaar599410c2021-04-10 14:03:43 +02004064 // When compiled with ":silent!" and there was an error don't consider the
4065 // function compiled.
4066 if (emsg_silent == 0 || did_emsg_silent == did_emsg_silent_before)
Bram Moolenaar05afcee2020-03-31 23:32:31 +02004067 {
4068 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
4069 + ufunc->uf_dfunc_idx;
4070 dfunc->df_deleted = FALSE;
Bram Moolenaar4aab88d2020-12-24 21:56:41 +01004071 dfunc->df_script_seq = current_sctx.sc_seq;
Bram Moolenaarf002a412021-01-24 13:34:18 +01004072#ifdef FEAT_PROFILE
Bram Moolenaare99d4222021-06-13 14:01:26 +02004073 if (cctx.ctx_compile_type == CT_PROFILE)
Bram Moolenaarb2049902021-01-24 12:53:53 +01004074 {
4075 dfunc->df_instr_prof = instr->ga_data;
4076 dfunc->df_instr_prof_count = instr->ga_len;
4077 }
4078 else
Bram Moolenaarf002a412021-01-24 13:34:18 +01004079#endif
Bram Moolenaare99d4222021-06-13 14:01:26 +02004080 if (cctx.ctx_compile_type == CT_DEBUG)
4081 {
4082 dfunc->df_instr_debug = instr->ga_data;
4083 dfunc->df_instr_debug_count = instr->ga_len;
4084 }
4085 else
Bram Moolenaarb2049902021-01-24 12:53:53 +01004086 {
4087 dfunc->df_instr = instr->ga_data;
4088 dfunc->df_instr_count = instr->ga_len;
4089 }
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02004090 dfunc->df_varcount = dfunc->df_var_names.ga_len;
Bram Moolenaar148ce7a2020-09-23 21:57:23 +02004091 dfunc->df_has_closure = cctx.ctx_has_closure;
Bram Moolenaarb46c0832022-09-15 17:19:37 +01004092
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +02004093 if (cctx.ctx_outer_used)
Bram Moolenaarb46c0832022-09-15 17:19:37 +01004094 {
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +02004095 ufunc->uf_flags |= FC_CLOSURE;
Bram Moolenaarb46c0832022-09-15 17:19:37 +01004096 if (outer_cctx != NULL)
4097 ++outer_cctx->ctx_closure_count;
4098 }
4099
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004100 ufunc->uf_def_status = UF_COMPILED;
Bram Moolenaar05afcee2020-03-31 23:32:31 +02004101 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004102
4103 ret = OK;
4104
4105erret:
Bram Moolenaar599410c2021-04-10 14:03:43 +02004106 if (ufunc->uf_def_status == UF_COMPILING)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004107 {
Bram Moolenaar05afcee2020-03-31 23:32:31 +02004108 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
4109 + ufunc->uf_dfunc_idx;
Bram Moolenaar20431c92020-03-20 18:39:46 +01004110
Bram Moolenaarcaf1a2f2021-06-15 11:27:21 +02004111 // Compiling aborted, free the generated instructions.
Bram Moolenaar8238f082021-04-20 21:10:48 +02004112 clear_instr_ga(instr);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01004113 VIM_CLEAR(dfunc->df_name);
Bram Moolenaarcaf1a2f2021-06-15 11:27:21 +02004114 ga_clear_strings(&dfunc->df_var_names);
Bram Moolenaar20431c92020-03-20 18:39:46 +01004115
Bram Moolenaar6c4bfe42020-07-23 18:26:30 +02004116 // If using the last entry in the table and it was added above, we
4117 // might as well remove it.
4118 if (!dfunc->df_deleted && new_def_function
Bram Moolenaar45a15082020-05-25 00:28:33 +02004119 && ufunc->uf_dfunc_idx == def_functions.ga_len - 1)
Bram Moolenaar6c4bfe42020-07-23 18:26:30 +02004120 {
Bram Moolenaar20431c92020-03-20 18:39:46 +01004121 --def_functions.ga_len;
Bram Moolenaar6c4bfe42020-07-23 18:26:30 +02004122 ufunc->uf_dfunc_idx = 0;
4123 }
Bram Moolenaar701cc6c2021-04-10 13:33:48 +02004124 ufunc->uf_def_status = UF_COMPILE_ERROR;
Bram Moolenaar20431c92020-03-20 18:39:46 +01004125
Bram Moolenaar3cca2992020-04-02 22:57:36 +02004126 while (cctx.ctx_scope != NULL)
4127 drop_scope(&cctx);
4128
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004129 if (errormsg != NULL)
4130 emsg(errormsg);
Bram Moolenaard66960b2020-10-30 20:46:26 +01004131 else if (did_emsg == did_emsg_before)
Bram Moolenaare13bdec2020-10-16 23:16:47 +02004132 emsg(_(e_compiling_def_function_failed));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004133 }
4134
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004135 if (cctx.ctx_redir_lhs.lhs_name != NULL)
4136 {
4137 if (ret == OK)
4138 {
4139 emsg(_(e_missing_redir_end));
4140 ret = FAIL;
4141 }
4142 vim_free(cctx.ctx_redir_lhs.lhs_name);
Bram Moolenaar753bcf82021-04-21 14:24:24 +02004143 vim_free(cctx.ctx_redir_lhs.lhs_whole);
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02004144 }
4145
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004146 current_sctx = save_current_sctx;
Bram Moolenaarf4e8cdd2020-10-12 22:07:13 +02004147 estack_compiling = save_estack_compiling;
Bram Moolenaardc4c2302021-04-25 13:54:42 +02004148 cmdmod.cmod_flags = save_cmod_flags;
Bram Moolenaar25e0f582020-05-25 22:36:50 +02004149 if (do_estack_push)
4150 estack_pop();
4151
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004152 ga_clear_strings(&lines_to_free);
Bram Moolenaarb84a3812020-05-01 15:44:29 +02004153 free_locals(&cctx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004154 ga_clear(&cctx.ctx_type_stack);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004155 return ret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004156}
4157
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004158 void
4159set_function_type(ufunc_T *ufunc)
4160{
4161 int varargs = ufunc->uf_va_name != NULL;
4162 int argcount = ufunc->uf_args.ga_len;
4163
4164 // Create a type for the function, with the return type and any
4165 // argument types.
4166 // A vararg is included in uf_args.ga_len but not in uf_arg_types.
4167 // The type is included in "tt_args".
4168 if (argcount > 0 || varargs)
4169 {
Bram Moolenaar18062fc2021-03-05 21:35:47 +01004170 if (ufunc->uf_type_list.ga_itemsize == 0)
4171 ga_init2(&ufunc->uf_type_list, sizeof(type_T *), 10);
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004172 ufunc->uf_func_type = alloc_func_type(ufunc->uf_ret_type,
4173 argcount, &ufunc->uf_type_list);
4174 // Add argument types to the function type.
4175 if (func_type_add_arg_types(ufunc->uf_func_type,
4176 argcount + varargs,
4177 &ufunc->uf_type_list) == FAIL)
4178 return;
4179 ufunc->uf_func_type->tt_argcount = argcount + varargs;
4180 ufunc->uf_func_type->tt_min_argcount =
4181 argcount - ufunc->uf_def_args.ga_len;
4182 if (ufunc->uf_arg_types == NULL)
4183 {
4184 int i;
4185
4186 // lambda does not have argument types.
4187 for (i = 0; i < argcount; ++i)
4188 ufunc->uf_func_type->tt_args[i] = &t_any;
4189 }
4190 else
4191 mch_memmove(ufunc->uf_func_type->tt_args,
4192 ufunc->uf_arg_types, sizeof(type_T *) * argcount);
4193 if (varargs)
4194 {
4195 ufunc->uf_func_type->tt_args[argcount] =
Bram Moolenaar2a389082021-04-09 20:24:31 +02004196 ufunc->uf_va_type == NULL ? &t_list_any : ufunc->uf_va_type;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004197 ufunc->uf_func_type->tt_flags = TTFLAG_VARARGS;
4198 }
4199 }
4200 else
4201 // No arguments, can use a predefined type.
4202 ufunc->uf_func_type = get_func_type(ufunc->uf_ret_type,
4203 argcount, &ufunc->uf_type_list);
4204}
4205
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004206/*
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01004207 * Free all instructions for "dfunc" except df_name.
Bram Moolenaar20431c92020-03-20 18:39:46 +01004208 */
4209 static void
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004210delete_def_function_contents(dfunc_T *dfunc, int mark_deleted)
Bram Moolenaar20431c92020-03-20 18:39:46 +01004211{
4212 int idx;
4213
Bram Moolenaard505d172022-12-18 21:42:55 +00004214 // In same cases the instructions may refer to a class in which the
4215 // function is defined and unreferencing the class may call back here
4216 // recursively. Set the df_delete_busy to avoid problems.
4217 if (dfunc->df_delete_busy)
4218 return;
4219 dfunc->df_delete_busy = TRUE;
4220
Bram Moolenaar20431c92020-03-20 18:39:46 +01004221 ga_clear(&dfunc->df_def_args_isn);
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02004222 ga_clear_strings(&dfunc->df_var_names);
Bram Moolenaar20431c92020-03-20 18:39:46 +01004223
4224 if (dfunc->df_instr != NULL)
4225 {
4226 for (idx = 0; idx < dfunc->df_instr_count; ++idx)
4227 delete_instr(dfunc->df_instr + idx);
4228 VIM_CLEAR(dfunc->df_instr);
4229 }
Bram Moolenaarc2dec4c2021-06-13 15:39:00 +02004230 if (dfunc->df_instr_debug != NULL)
4231 {
4232 for (idx = 0; idx < dfunc->df_instr_debug_count; ++idx)
4233 delete_instr(dfunc->df_instr_debug + idx);
4234 VIM_CLEAR(dfunc->df_instr_debug);
Bram Moolenaarc2dec4c2021-06-13 15:39:00 +02004235 }
Bram Moolenaarc05fe072021-01-24 21:30:48 +01004236#ifdef FEAT_PROFILE
4237 if (dfunc->df_instr_prof != NULL)
4238 {
4239 for (idx = 0; idx < dfunc->df_instr_prof_count; ++idx)
4240 delete_instr(dfunc->df_instr_prof + idx);
4241 VIM_CLEAR(dfunc->df_instr_prof);
Bram Moolenaarc05fe072021-01-24 21:30:48 +01004242 }
4243#endif
Bram Moolenaar20431c92020-03-20 18:39:46 +01004244
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004245 if (mark_deleted)
4246 dfunc->df_deleted = TRUE;
4247 if (dfunc->df_ufunc != NULL)
4248 dfunc->df_ufunc->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaard505d172022-12-18 21:42:55 +00004249
4250 dfunc->df_delete_busy = FALSE;
Bram Moolenaar20431c92020-03-20 18:39:46 +01004251}
4252
4253/*
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004254 * When a user function is deleted, clear the contents of any associated def
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01004255 * function, unless another user function still uses it.
4256 * The position in def_functions can be re-used.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004257 */
4258 void
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01004259unlink_def_function(ufunc_T *ufunc)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004260{
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00004261 if (ufunc->uf_dfunc_idx <= 0)
4262 return;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004263
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00004264 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
4265 + ufunc->uf_dfunc_idx;
4266
4267 if (--dfunc->df_refcount <= 0)
4268 delete_def_function_contents(dfunc, TRUE);
4269 ufunc->uf_def_status = UF_NOT_COMPILED;
4270 ufunc->uf_dfunc_idx = 0;
4271 if (dfunc->df_ufunc == ufunc)
4272 dfunc->df_ufunc = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004273}
4274
Bram Moolenaarfdeab652020-09-19 15:16:50 +02004275/*
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01004276 * Used when a user function refers to an existing dfunc.
Bram Moolenaarfdeab652020-09-19 15:16:50 +02004277 */
4278 void
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01004279link_def_function(ufunc_T *ufunc)
Bram Moolenaarfdeab652020-09-19 15:16:50 +02004280{
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00004281 if (ufunc->uf_dfunc_idx <= 0)
4282 return;
Bram Moolenaarfdeab652020-09-19 15:16:50 +02004283
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00004284 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
4285 + ufunc->uf_dfunc_idx;
4286
4287 ++dfunc->df_refcount;
Bram Moolenaarfdeab652020-09-19 15:16:50 +02004288}
4289
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004290#if defined(EXITFREE) || defined(PROTO)
Bram Moolenaar20431c92020-03-20 18:39:46 +01004291/*
4292 * Free all functions defined with ":def".
4293 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004294 void
4295free_def_functions(void)
4296{
Bram Moolenaar20431c92020-03-20 18:39:46 +01004297 int idx;
4298
4299 for (idx = 0; idx < def_functions.ga_len; ++idx)
4300 {
4301 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data) + idx;
4302
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004303 delete_def_function_contents(dfunc, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01004304 vim_free(dfunc->df_name);
Bram Moolenaar20431c92020-03-20 18:39:46 +01004305 }
4306
4307 ga_clear(&def_functions);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004308}
4309#endif
4310
4311
4312#endif // FEAT_EVAL