blob: 40b549934bd3b62357dc49b3dafad7d2e78ef63c [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/*
11 * vim9execute.c: execute Vim9 script instructions
12 */
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 Moolenaar8a7d6542020-01-26 15:56:19 +010024
25// Structure put on ec_trystack when ISN_TRY is encountered.
26typedef struct {
Bram Moolenaard9d77892021-02-12 21:32:47 +010027 int tcd_frame_idx; // ec_frame_idx at ISN_TRY
28 int tcd_stack_len; // size of ectx.ec_stack at ISN_TRY
Bram Moolenaard3d8fee2021-06-30 19:54:43 +020029 int tcd_in_catch; // in catch or finally block
30 int tcd_did_throw; // set did_throw in :endtry
Bram Moolenaar7e82c5f2021-02-21 21:32:45 +010031 int tcd_catch_idx; // instruction of the first :catch or :finally
32 int tcd_finally_idx; // instruction of the :finally block or zero
33 int tcd_endtry_idx; // instruction of the :endtry
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010034 int tcd_caught; // catch block entered
Bram Moolenaar2e34c342021-03-14 12:13:33 +010035 int tcd_cont; // :continue encountered, jump here (minus one)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010036 int tcd_return; // when TRUE return from end of :finally
37} trycmd_T;
38
Bram Moolenaar4c137212021-04-19 16:48:48 +020039// Data local to a function.
40// On a function call, if not empty, is saved on the stack and restored when
41// returning.
42typedef struct {
43 int floc_restore_cmdmod;
44 cmdmod_T floc_save_cmdmod;
45 int floc_restore_cmdmod_stacklen;
46} funclocal_T;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010047
Bram Moolenaarc04f2a42021-06-09 19:30:03 +020048// Structure to hold a reference to an outer_T, with information of whether it
49// was allocated.
50typedef struct {
51 outer_T *or_outer;
52 partial_T *or_partial; // decrement "or_partial->pt_refcount" later
53 int or_outer_allocated; // free "or_outer" later
54} outer_ref_T;
55
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010056// A stack is used to store:
57// - arguments passed to a :def function
58// - info about the calling function, to use when returning
59// - local variables
60// - temporary values
61//
62// In detail (FP == Frame Pointer):
63// arg1 first argument from caller (if present)
64// arg2 second argument from caller (if present)
65// extra_arg1 any missing optional argument default value
66// FP -> cur_func calling function
Bram Moolenaar6ed545e2022-05-09 20:09:23 +010067// current previous instruction pointer
68// frame_ptr previous Frame Pointer
69// var1 space for local variable
70// var2 space for local variable
71// .... fixed space for max. number of local variables
72// temp temporary values
73// .... flexible space for temporary values (can grow big)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010074
75/*
76 * Execution context.
77 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +010078struct ectx_S {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010079 garray_T ec_stack; // stack of typval_T values
Bram Moolenaarbf67ea12020-05-02 17:52:42 +020080 int ec_frame_idx; // index in ec_stack: context of ec_dfunc_idx
Bram Moolenaar4c137212021-04-19 16:48:48 +020081 int ec_initial_frame_idx; // frame index when called
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010082
Bram Moolenaarc04f2a42021-06-09 19:30:03 +020083 outer_ref_T *ec_outer_ref; // outer scope used for closures, allocated
Bram Moolenaar4c137212021-04-19 16:48:48 +020084 funclocal_T ec_funclocal;
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +020085
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010086 garray_T ec_trystack; // stack of trycmd_T values
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010087
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010088 isn_T *ec_instr; // array with instructions
Dominique Pelle3276f582021-08-07 12:44:41 +020089 int ec_dfunc_idx; // current function index
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010090 int ec_iidx; // index in ec_instr: instruction to execute
Bram Moolenaar148ce7a2020-09-23 21:57:23 +020091
92 garray_T ec_funcrefs; // partials that might be a closure
Bram Moolenaar4c137212021-04-19 16:48:48 +020093
94 int ec_did_emsg_before;
95 int ec_trylevel_at_start;
96 where_T ec_where;
Bram Moolenaarcd45ed02020-12-22 17:35:54 +010097};
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010098
Bram Moolenaar12d26532021-02-19 19:13:21 +010099#ifdef FEAT_PROFILE
100// stack of profinfo_T used when profiling.
101static garray_T profile_info_ga = {0, 0, sizeof(profinfo_T), 20, NULL};
102#endif
103
Bram Moolenaar1d84f762022-09-03 21:35:53 +0100104// Get pointer to item in the stack.
105#define STACK_TV(idx) (((typval_T *)ectx->ec_stack.ga_data) + idx)
106
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100107// Get pointer to item relative to the bottom of the stack, -1 is the last one.
Bram Moolenaar11107ba2020-08-15 21:10:16 +0200108#define STACK_TV_BOT(idx) (((typval_T *)ectx->ec_stack.ga_data) + ectx->ec_stack.ga_len + (idx))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100109
Bram Moolenaar1d84f762022-09-03 21:35:53 +0100110// Get pointer to a local variable on the stack. Negative for arguments.
111#define STACK_TV_VAR(idx) (((typval_T *)ectx->ec_stack.ga_data) + ectx->ec_frame_idx + STACK_FRAME_SIZE + idx)
112
Bram Moolenaar418f1df2020-08-12 21:34:49 +0200113 void
114to_string_error(vartype_T vartype)
115{
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200116 semsg(_(e_cannot_convert_str_to_string), vartype_name(vartype));
Bram Moolenaar418f1df2020-08-12 21:34:49 +0200117}
118
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100119/*
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100120 * Return the number of arguments, including optional arguments and any vararg.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100121 */
122 static int
123ufunc_argcount(ufunc_T *ufunc)
124{
125 return ufunc->uf_args.ga_len + (ufunc->uf_va_name != NULL ? 1 : 0);
126}
127
128/*
LemonBoy372bcce2022-04-25 12:43:20 +0100129 * Create a new string from "count" items at the bottom of the stack.
130 * A trailing NUL is appended.
131 * When "count" is zero an empty string is added to the stack.
132 */
133 static int
134exe_concat(int count, ectx_T *ectx)
135{
136 int idx;
137 int len = 0;
138 typval_T *tv;
139 garray_T ga;
140
141 ga_init2(&ga, sizeof(char), 1);
142 // Preallocate enough space for the whole string to avoid having to grow
143 // and copy.
144 for (idx = 0; idx < count; ++idx)
145 {
146 tv = STACK_TV_BOT(idx - count);
147 if (tv->vval.v_string != NULL)
148 len += (int)STRLEN(tv->vval.v_string);
149 }
150
151 if (ga_grow(&ga, len + 1) == FAIL)
152 return FAIL;
153
154 for (idx = 0; idx < count; ++idx)
155 {
156 tv = STACK_TV_BOT(idx - count);
157 ga_concat(&ga, tv->vval.v_string);
158 clear_tv(tv);
159 }
160
161 // add a terminating NUL
162 ga_append(&ga, NUL);
163
164 ectx->ec_stack.ga_len -= count - 1;
165 STACK_TV_BOT(-1)->vval.v_string = ga.ga_data;
166
167 return OK;
168}
169
170/*
Bram Moolenaarfe270812020-04-11 22:31:27 +0200171 * Create a new list from "count" items at the bottom of the stack.
172 * When "count" is zero an empty list is added to the stack.
Bram Moolenaarec15b1c2022-03-27 16:29:53 +0100173 * When "count" is -1 a NULL list is added to the stack.
Bram Moolenaarfe270812020-04-11 22:31:27 +0200174 */
175 static int
176exe_newlist(int count, ectx_T *ectx)
177{
Bram Moolenaarec15b1c2022-03-27 16:29:53 +0100178 list_T *list = NULL;
Bram Moolenaarfe270812020-04-11 22:31:27 +0200179 int idx;
180 typval_T *tv;
181
Bram Moolenaarec15b1c2022-03-27 16:29:53 +0100182 if (count >= 0)
183 {
184 list = list_alloc_with_items(count);
185 if (list == NULL)
186 return FAIL;
187 for (idx = 0; idx < count; ++idx)
188 list_set_item(list, idx, STACK_TV_BOT(idx - count));
189 }
Bram Moolenaarfe270812020-04-11 22:31:27 +0200190
191 if (count > 0)
192 ectx->ec_stack.ga_len -= count - 1;
Bram Moolenaar35578162021-08-02 19:10:38 +0200193 else if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarec15b1c2022-03-27 16:29:53 +0100194 {
195 list_unref(list);
Bram Moolenaarfe270812020-04-11 22:31:27 +0200196 return FAIL;
Bram Moolenaarec15b1c2022-03-27 16:29:53 +0100197 }
Bram Moolenaarfe270812020-04-11 22:31:27 +0200198 else
199 ++ectx->ec_stack.ga_len;
200 tv = STACK_TV_BOT(-1);
201 tv->v_type = VAR_LIST;
202 tv->vval.v_list = list;
Bram Moolenaar566badc2022-09-18 13:46:08 +0100203 tv->v_lock = 0;
Bram Moolenaarec15b1c2022-03-27 16:29:53 +0100204 if (list != NULL)
205 ++list->lv_refcount;
206 return OK;
207}
208
209/*
210 * Implementation of ISN_NEWDICT.
211 * Returns FAIL on total failure, MAYBE on error.
212 */
213 static int
214exe_newdict(int count, ectx_T *ectx)
215{
216 dict_T *dict = NULL;
217 dictitem_T *item;
218 char_u *key;
219 int idx;
220 typval_T *tv;
221
222 if (count >= 0)
223 {
224 dict = dict_alloc();
225 if (unlikely(dict == NULL))
226 return FAIL;
227 for (idx = 0; idx < count; ++idx)
228 {
229 // have already checked key type is VAR_STRING
230 tv = STACK_TV_BOT(2 * (idx - count));
231 // check key is unique
Bram Moolenaara9fa8c52023-01-02 18:10:04 +0000232 key = tv->vval.v_string == NULL ? (char_u *)"" : tv->vval.v_string;
Bram Moolenaarec15b1c2022-03-27 16:29:53 +0100233 item = dict_find(dict, key, -1);
234 if (item != NULL)
235 {
Bram Moolenaara9fa8c52023-01-02 18:10:04 +0000236 semsg(_(e_duplicate_key_in_dictionary_str), key);
Bram Moolenaarec15b1c2022-03-27 16:29:53 +0100237 dict_unref(dict);
238 return MAYBE;
239 }
240 item = dictitem_alloc(key);
241 clear_tv(tv);
242 if (unlikely(item == NULL))
243 {
244 dict_unref(dict);
245 return FAIL;
246 }
Bram Moolenaar0d1f55c2022-04-05 17:30:29 +0100247 tv = STACK_TV_BOT(2 * (idx - count) + 1);
248 item->di_tv = *tv;
Bram Moolenaarec15b1c2022-03-27 16:29:53 +0100249 item->di_tv.v_lock = 0;
Bram Moolenaar0d1f55c2022-04-05 17:30:29 +0100250 tv->v_type = VAR_UNKNOWN;
Bram Moolenaarec15b1c2022-03-27 16:29:53 +0100251 if (dict_add(dict, item) == FAIL)
252 {
253 // can this ever happen?
254 dict_unref(dict);
255 return FAIL;
256 }
257 }
258 }
259
260 if (count > 0)
261 ectx->ec_stack.ga_len -= 2 * count - 1;
262 else if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Christian Brabandt86eddce2024-03-26 18:42:52 +0100263 {
264 dict_unref(dict);
Bram Moolenaarec15b1c2022-03-27 16:29:53 +0100265 return FAIL;
Christian Brabandt86eddce2024-03-26 18:42:52 +0100266 }
Bram Moolenaarec15b1c2022-03-27 16:29:53 +0100267 else
268 ++ectx->ec_stack.ga_len;
269 tv = STACK_TV_BOT(-1);
270 tv->v_type = VAR_DICT;
271 tv->v_lock = 0;
272 tv->vval.v_dict = dict;
273 if (dict != NULL)
274 ++dict->dv_refcount;
Bram Moolenaarfe270812020-04-11 22:31:27 +0200275 return OK;
276}
277
278/*
Bram Moolenaar4f8f5422021-06-20 19:28:14 +0200279 * If debug_tick changed check if "ufunc" has a breakpoint and update
280 * "uf_has_breakpoint".
281 */
Bram Moolenaar96923b72022-03-15 15:57:04 +0000282 void
Bram Moolenaar4f8f5422021-06-20 19:28:14 +0200283update_has_breakpoint(ufunc_T *ufunc)
284{
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +0000285 if (ufunc->uf_debug_tick == debug_tick)
286 return;
Bram Moolenaar4f8f5422021-06-20 19:28:14 +0200287
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +0000288 linenr_T breakpoint;
289
290 ufunc->uf_debug_tick = debug_tick;
291 breakpoint = dbg_find_breakpoint(FALSE, ufunc->uf_name, 0);
292 ufunc->uf_has_breakpoint = breakpoint > 0;
Bram Moolenaar4f8f5422021-06-20 19:28:14 +0200293}
294
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +0200295static garray_T dict_stack = GA_EMPTY;
296
297/*
298 * Put a value on the dict stack. This consumes "tv".
299 */
300 static int
301dict_stack_save(typval_T *tv)
302{
303 if (dict_stack.ga_growsize == 0)
Bram Moolenaar04935fb2022-01-08 16:19:22 +0000304 ga_init2(&dict_stack, sizeof(typval_T), 10);
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +0200305 if (ga_grow(&dict_stack, 1) == FAIL)
306 return FAIL;
307 ((typval_T *)dict_stack.ga_data)[dict_stack.ga_len] = *tv;
308 ++dict_stack.ga_len;
309 return OK;
310}
311
312/*
313 * Get the typval at top of the dict stack.
314 */
315 static typval_T *
316dict_stack_get_tv(void)
317{
318 if (dict_stack.ga_len == 0)
319 return NULL;
320 return ((typval_T *)dict_stack.ga_data) + dict_stack.ga_len - 1;
321}
322
323/*
324 * Get the dict at top of the dict stack.
325 */
326 static dict_T *
327dict_stack_get_dict(void)
328{
329 typval_T *tv;
330
331 if (dict_stack.ga_len == 0)
332 return NULL;
333 tv = ((typval_T *)dict_stack.ga_data) + dict_stack.ga_len - 1;
334 if (tv->v_type == VAR_DICT)
335 return tv->vval.v_dict;
336 return NULL;
337}
338
339/*
340 * Drop an item from the dict stack.
341 */
342 static void
343dict_stack_drop(void)
344{
345 if (dict_stack.ga_len == 0)
346 {
347 iemsg("Dict stack underflow");
348 return;
349 }
350 --dict_stack.ga_len;
351 clear_tv(((typval_T *)dict_stack.ga_data) + dict_stack.ga_len);
352}
353
354/*
355 * Drop items from the dict stack until the length is equal to "len".
356 */
357 static void
358dict_stack_clear(int len)
359{
360 while (dict_stack.ga_len > len)
361 dict_stack_drop();
362}
363
Bram Moolenaar4f8f5422021-06-20 19:28:14 +0200364/*
Bram Moolenaar7aca5ca2022-02-07 19:56:43 +0000365 * Get a pointer to useful "pt_outer" of "pt".
366 */
367 static outer_T *
368get_pt_outer(partial_T *pt)
369{
370 partial_T *ptref = pt->pt_outer_partial;
371
372 if (ptref == NULL)
373 return &pt->pt_outer;
374
375 // partial using partial (recursively)
376 while (ptref->pt_outer_partial != NULL)
377 ptref = ptref->pt_outer_partial;
378 return &ptref->pt_outer;
379}
380
381/*
Bram Moolenaar0d89d8a2022-12-31 14:01:24 +0000382 * Check "argcount" arguments on the stack against what "ufunc" expects.
383 * "off" is the offset of arguments on the stack.
384 * Return OK or FAIL.
385 */
386 static int
387check_ufunc_arg_types(ufunc_T *ufunc, int argcount, int off, ectx_T *ectx)
388{
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +0000389 if (ufunc->uf_arg_types == NULL && ufunc->uf_va_type == NULL)
390 return OK;
391
392 typval_T *argv = STACK_TV_BOT(0) - argcount - off;
393
394 // The function can change at runtime, check that the argument
395 // types are correct.
396 for (int i = 0; i < argcount; ++i)
Bram Moolenaar0d89d8a2022-12-31 14:01:24 +0000397 {
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +0000398 type_T *type = NULL;
Bram Moolenaar0d89d8a2022-12-31 14:01:24 +0000399
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +0000400 // assume a v:none argument, using the default value, is always OK
401 if (argv[i].v_type == VAR_SPECIAL
402 && argv[i].vval.v_number == VVAL_NONE)
403 continue;
Ernie Raelb077b582023-12-14 20:11:44 +0100404 // only pass values to user functions, never types
405 if (check_typval_is_value(&argv[i]) == FAIL)
406 return FAIL;
Bram Moolenaar0d89d8a2022-12-31 14:01:24 +0000407
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +0000408 if (i < ufunc->uf_args.ga_len && ufunc->uf_arg_types != NULL)
409 type = ufunc->uf_arg_types[i];
410 else if (ufunc->uf_va_type != NULL)
411 type = ufunc->uf_va_type->tt_member;
412 if (type != NULL && check_typval_arg_type(type,
413 &argv[i], NULL, i + 1) == FAIL)
414 return FAIL;
Bram Moolenaar0d89d8a2022-12-31 14:01:24 +0000415 }
416 return OK;
417}
418
419/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100420 * Call compiled function "cdf_idx" from compiled code.
Bram Moolenaarab360522021-01-10 14:02:28 +0100421 * This adds a stack frame and sets the instruction pointer to the start of the
422 * called function.
Bram Moolenaar5800c792022-09-22 17:34:01 +0100423 * If "pt_arg" is not NULL use "pt_arg->pt_outer" for ec_outer_ref->or_outer.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100424 *
425 * Stack has:
426 * - current arguments (already there)
427 * - omitted optional argument (default values) added here
428 * - stack frame:
429 * - pointer to calling function
430 * - Index of next instruction in calling function
431 * - previous frame pointer
432 * - reserved space for local variables
433 */
434 static int
Bram Moolenaar2fecb532021-03-24 22:00:56 +0100435call_dfunc(
436 int cdf_idx,
Bram Moolenaar5800c792022-09-22 17:34:01 +0100437 partial_T *pt_arg,
Bram Moolenaar2fecb532021-03-24 22:00:56 +0100438 int argcount_arg,
Bram Moolenaar2fecb532021-03-24 22:00:56 +0100439 ectx_T *ectx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100440{
Bram Moolenaar2fecb532021-03-24 22:00:56 +0100441 int argcount = argcount_arg;
442 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data) + cdf_idx;
443 ufunc_T *ufunc = dfunc->df_ufunc;
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +0200444 int did_emsg_before = did_emsg_cumul + did_emsg;
Bram Moolenaar2fecb532021-03-24 22:00:56 +0100445 int arg_to_add;
446 int vararg_count = 0;
447 int varcount;
448 int idx;
449 estack_T *entry;
450 funclocal_T *floc = NULL;
Bram Moolenaar648594e2021-07-11 17:55:01 +0200451 int res = OK;
Bram Moolenaar139575d2022-03-15 19:29:30 +0000452 compiletype_T compile_type;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100453
454 if (dfunc->df_deleted)
455 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +0100456 // don't use ufunc->uf_name, it may have been freed
Bram Moolenaar460ae5d2022-01-01 14:19:49 +0000457 emsg_funcname(e_function_was_deleted_str,
Bram Moolenaarcd45ed02020-12-22 17:35:54 +0100458 dfunc->df_name == NULL ? (char_u *)"unknown" : dfunc->df_name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100459 return FAIL;
460 }
461
Bram Moolenaare5ea3462021-01-25 21:01:48 +0100462#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +0100463 if (do_profiling == PROF_YES)
464 {
Bram Moolenaar35578162021-08-02 19:10:38 +0200465 if (GA_GROW_OK(&profile_info_ga, 1))
Bram Moolenaar12d26532021-02-19 19:13:21 +0100466 {
467 profinfo_T *info = ((profinfo_T *)profile_info_ga.ga_data)
468 + profile_info_ga.ga_len;
469 ++profile_info_ga.ga_len;
470 CLEAR_POINTER(info);
471 profile_may_start_func(info, ufunc,
472 (((dfunc_T *)def_functions.ga_data)
473 + ectx->ec_dfunc_idx)->df_ufunc);
474 }
Bram Moolenaar12d26532021-02-19 19:13:21 +0100475 }
Bram Moolenaare5ea3462021-01-25 21:01:48 +0100476#endif
477
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +0200478 // When debugging and using "cont" switches to the not-debugged
479 // instructions, may need to still compile them.
Bram Moolenaar139575d2022-03-15 19:29:30 +0000480 compile_type = get_compile_type(ufunc);
481 if (func_needs_compiling(ufunc, compile_type))
Bram Moolenaar648594e2021-07-11 17:55:01 +0200482 {
Bram Moolenaar139575d2022-03-15 19:29:30 +0000483 res = compile_def_function(ufunc, FALSE, compile_type, NULL);
Bram Moolenaar648594e2021-07-11 17:55:01 +0200484
485 // compile_def_function() may cause def_functions.ga_data to change
486 dfunc = ((dfunc_T *)def_functions.ga_data) + cdf_idx;
487 }
488 if (res == FAIL || INSTRUCTIONS(dfunc) == NULL)
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +0200489 {
490 if (did_emsg_cumul + did_emsg == did_emsg_before)
491 semsg(_(e_function_is_not_compiled_str),
492 printable_func_name(ufunc));
493 return FAIL;
494 }
495
Bram Moolenaar1378fbc2020-04-11 20:50:33 +0200496 if (ufunc->uf_va_name != NULL)
497 {
Bram Moolenaarfe270812020-04-11 22:31:27 +0200498 // Need to make a list out of the vararg arguments.
Bram Moolenaar1378fbc2020-04-11 20:50:33 +0200499 // Stack at time of call with 2 varargs:
500 // normal_arg
501 // optional_arg
502 // vararg_1
503 // vararg_2
Bram Moolenaarfe270812020-04-11 22:31:27 +0200504 // After creating the list:
505 // normal_arg
506 // optional_arg
507 // vararg-list
508 // With missing optional arguments we get:
Bram Moolenaar1378fbc2020-04-11 20:50:33 +0200509 // normal_arg
Bram Moolenaarfe270812020-04-11 22:31:27 +0200510 // After creating the list
511 // normal_arg
512 // (space for optional_arg)
513 // vararg-list
Bram Moolenaar1378fbc2020-04-11 20:50:33 +0200514 vararg_count = argcount - ufunc->uf_args.ga_len;
515 if (vararg_count < 0)
516 vararg_count = 0;
517 else
518 argcount -= vararg_count;
Bram Moolenaarfe270812020-04-11 22:31:27 +0200519 if (exe_newlist(vararg_count, ectx) == FAIL)
Bram Moolenaar1378fbc2020-04-11 20:50:33 +0200520 return FAIL;
Bram Moolenaarfe270812020-04-11 22:31:27 +0200521
522 vararg_count = 1;
Bram Moolenaar1378fbc2020-04-11 20:50:33 +0200523 }
524
Bram Moolenaarfe270812020-04-11 22:31:27 +0200525 arg_to_add = ufunc->uf_args.ga_len - argcount;
Bram Moolenaar1378fbc2020-04-11 20:50:33 +0200526 if (arg_to_add < 0)
527 {
Matvey Tarasovd14bb1a2022-06-29 13:18:27 +0100528 semsg(NGETTEXT(e_one_argument_too_many, e_nr_arguments_too_many,
529 -arg_to_add), -arg_to_add);
Bram Moolenaar1378fbc2020-04-11 20:50:33 +0200530 return FAIL;
531 }
Bram Moolenaarcd1cda22022-02-16 21:48:25 +0000532 else if (arg_to_add > ufunc->uf_def_args.ga_len)
533 {
534 int missing = arg_to_add - ufunc->uf_def_args.ga_len;
535
Matvey Tarasovd14bb1a2022-06-29 13:18:27 +0100536 semsg(NGETTEXT(e_one_argument_too_few, e_nr_arguments_too_few,
537 missing), missing);
Bram Moolenaarcd1cda22022-02-16 21:48:25 +0000538 return FAIL;
539 }
Bram Moolenaar148ce7a2020-09-23 21:57:23 +0200540
Bram Moolenaar574950d2023-01-03 19:08:50 +0000541 // If this is an object method, the object is just before the arguments.
542 typval_T *obj = STACK_TV_BOT(0) - argcount - vararg_count - 1;
543
Yegappan Lakshmananc1946262023-09-25 21:00:46 +0200544 if (IS_OBJECT_METHOD(ufunc) && !IS_CONSTRUCTOR_METHOD(ufunc)
545 && obj->v_type == VAR_OBJECT && obj->vval.v_object == NULL)
546 {
547 // If this is not a constructor method, then a valid object is
548 // needed.
549 emsg(_(e_using_null_object));
550 return FAIL;
551 }
552
Bram Moolenaar0d89d8a2022-12-31 14:01:24 +0000553 // Check the argument types.
554 if (check_ufunc_arg_types(ufunc, argcount, vararg_count, ectx) == FAIL)
555 return FAIL;
556
mityua5550692023-11-25 15:41:20 +0100557 // While check_ufunc_arg_types call, def function compilation process may
558 // run. If so many def functions are compiled, def_functions array may be
559 // reallocated and dfunc may no longer have valid pointer. Get the object
560 // pointer from def_functions again here.
561 dfunc = ((dfunc_T *)def_functions.ga_data) + cdf_idx;
562
Bram Moolenaar148ce7a2020-09-23 21:57:23 +0200563 // Reserve space for:
564 // - missing arguments
565 // - stack frame
566 // - local variables
567 // - if needed: a counter for number of closures created in
568 // ectx->ec_funcrefs.
569 varcount = dfunc->df_varcount + dfunc->df_has_closure;
Bram Moolenaarb46c0832022-09-15 17:19:37 +0100570 if (GA_GROW_FAILS(&ectx->ec_stack,
571 arg_to_add + STACK_FRAME_SIZE + varcount))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100572 return FAIL;
573
Yegappan Lakshmanan1087b8c2023-10-07 22:03:18 +0200574 // The object pointer is in the execution typval stack. The GA_GROW call
575 // above may have reallocated the execution typval stack. So the object
576 // pointer may not be valid anymore. Get the object pointer again from the
577 // execution stack.
578 obj = STACK_TV_BOT(0) - argcount - vararg_count - 1;
579
Bram Moolenaar0ba48e82020-11-17 18:23:19 +0100580 // If depth of calling is getting too high, don't execute the function.
581 if (funcdepth_increment() == FAIL)
582 return FAIL;
Bram Moolenaare99d4222021-06-13 14:01:26 +0200583 ++ex_nesting_level;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +0100584
Bram Moolenaar2fecb532021-03-24 22:00:56 +0100585 // Only make a copy of funclocal if it contains something to restore.
Bram Moolenaar4c137212021-04-19 16:48:48 +0200586 if (ectx->ec_funclocal.floc_restore_cmdmod)
Bram Moolenaar2fecb532021-03-24 22:00:56 +0100587 {
588 floc = ALLOC_ONE(funclocal_T);
589 if (floc == NULL)
590 return FAIL;
Bram Moolenaar4c137212021-04-19 16:48:48 +0200591 *floc = ectx->ec_funclocal;
592 ectx->ec_funclocal.floc_restore_cmdmod = FALSE;
Bram Moolenaar2fecb532021-03-24 22:00:56 +0100593 }
594
Bram Moolenaarfe270812020-04-11 22:31:27 +0200595 // Move the vararg-list to below the missing optional arguments.
596 if (vararg_count > 0 && arg_to_add > 0)
597 *STACK_TV_BOT(arg_to_add - 1) = *STACK_TV_BOT(-1);
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100598
599 // Reserve space for omitted optional arguments, filled in soon.
Bram Moolenaar1378fbc2020-04-11 20:50:33 +0200600 for (idx = 0; idx < arg_to_add; ++idx)
Bram Moolenaarfe270812020-04-11 22:31:27 +0200601 STACK_TV_BOT(idx - vararg_count)->v_type = VAR_UNKNOWN;
Bram Moolenaar1378fbc2020-04-11 20:50:33 +0200602 ectx->ec_stack.ga_len += arg_to_add;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100603
604 // Store current execution state in stack frame for ISN_RETURN.
Bram Moolenaar0186e582021-01-10 18:33:11 +0100605 STACK_TV_BOT(STACK_FRAME_FUNC_OFF)->vval.v_number = ectx->ec_dfunc_idx;
606 STACK_TV_BOT(STACK_FRAME_IIDX_OFF)->vval.v_number = ectx->ec_iidx;
Bram Moolenaar5930ddc2021-04-26 20:32:59 +0200607 STACK_TV_BOT(STACK_FRAME_INSTR_OFF)->vval.v_string = (void *)ectx->ec_instr;
Bram Moolenaarc04f2a42021-06-09 19:30:03 +0200608 STACK_TV_BOT(STACK_FRAME_OUTER_OFF)->vval.v_string =
609 (void *)ectx->ec_outer_ref;
Bram Moolenaar2fecb532021-03-24 22:00:56 +0100610 STACK_TV_BOT(STACK_FRAME_FUNCLOCAL_OFF)->vval.v_string = (void *)floc;
Bram Moolenaar0186e582021-01-10 18:33:11 +0100611 STACK_TV_BOT(STACK_FRAME_IDX_OFF)->vval.v_number = ectx->ec_frame_idx;
Bram Moolenaarbf67ea12020-05-02 17:52:42 +0200612 ectx->ec_frame_idx = ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100613
Bram Moolenaar5800c792022-09-22 17:34:01 +0100614 // Initialize all local variables to number zero. Also initialize the
615 // variable that counts how many closures were created. This is used in
616 // handle_closure_in_use().
617 int initcount = dfunc->df_varcount + (dfunc->df_has_closure ? 1 : 0);
618 for (idx = 0; idx < initcount; ++idx)
Bram Moolenaar5cd64792021-12-25 18:23:24 +0000619 {
620 typval_T *tv = STACK_TV_BOT(STACK_FRAME_SIZE + idx);
621
622 tv->v_type = VAR_NUMBER;
623 tv->vval.v_number = 0;
624 }
Bram Moolenaar148ce7a2020-09-23 21:57:23 +0200625 ectx->ec_stack.ga_len += STACK_FRAME_SIZE + varcount;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100626
Bram Moolenaar574950d2023-01-03 19:08:50 +0000627 // For an object method move the object from just before the arguments to
628 // the first local variable.
Yegappan Lakshmanan1db15142023-09-19 20:34:05 +0200629 if (IS_OBJECT_METHOD(ufunc))
Bram Moolenaar574950d2023-01-03 19:08:50 +0000630 {
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +0200631 if (obj->v_type != VAR_OBJECT)
632 {
633 semsg(_(e_internal_error_str), "type in stack is not an object");
634 return FAIL;
635 }
636
Bram Moolenaar574950d2023-01-03 19:08:50 +0000637 *STACK_TV_VAR(0) = *obj;
638 obj->v_type = VAR_UNKNOWN;
639 }
640
Bram Moolenaar5800c792022-09-22 17:34:01 +0100641 partial_T *pt = pt_arg != NULL ? pt_arg : ufunc->uf_partial;
642 if (pt != NULL || (ufunc->uf_flags & FC_CLOSURE))
Bram Moolenaarcd45ed02020-12-22 17:35:54 +0100643 {
Bram Moolenaarc04f2a42021-06-09 19:30:03 +0200644 outer_ref_T *ref = ALLOC_CLEAR_ONE(outer_ref_T);
Bram Moolenaar0186e582021-01-10 18:33:11 +0100645
Bram Moolenaarc04f2a42021-06-09 19:30:03 +0200646 if (ref == NULL)
Bram Moolenaar0186e582021-01-10 18:33:11 +0100647 return FAIL;
648 if (pt != NULL)
649 {
Bram Moolenaar7aca5ca2022-02-07 19:56:43 +0000650 ref->or_outer = get_pt_outer(pt);
Bram Moolenaarc04f2a42021-06-09 19:30:03 +0200651 ++pt->pt_refcount;
652 ref->or_partial = pt;
Bram Moolenaar0186e582021-01-10 18:33:11 +0100653 }
Bram Moolenaar0186e582021-01-10 18:33:11 +0100654 else
655 {
Bram Moolenaarc04f2a42021-06-09 19:30:03 +0200656 ref->or_outer = ALLOC_CLEAR_ONE(outer_T);
Dominique Pelle5a9e5842021-07-24 19:32:12 +0200657 if (unlikely(ref->or_outer == NULL))
Bram Moolenaarc04f2a42021-06-09 19:30:03 +0200658 {
659 vim_free(ref);
660 return FAIL;
661 }
662 ref->or_outer_allocated = TRUE;
663 ref->or_outer->out_stack = &ectx->ec_stack;
664 ref->or_outer->out_frame_idx = ectx->ec_frame_idx;
665 if (ectx->ec_outer_ref != NULL)
666 ref->or_outer->out_up = ectx->ec_outer_ref->or_outer;
Bram Moolenaar0186e582021-01-10 18:33:11 +0100667 }
Bram Moolenaarc04f2a42021-06-09 19:30:03 +0200668 ectx->ec_outer_ref = ref;
Bram Moolenaarab360522021-01-10 14:02:28 +0100669 }
Bram Moolenaar0186e582021-01-10 18:33:11 +0100670 else
Bram Moolenaarc04f2a42021-06-09 19:30:03 +0200671 ectx->ec_outer_ref = NULL;
Bram Moolenaarcd45ed02020-12-22 17:35:54 +0100672
Bram Moolenaarc970e422021-03-17 15:03:04 +0100673 ++ufunc->uf_calls;
674
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100675 // Set execution state to the start of the called function.
676 ectx->ec_dfunc_idx = cdf_idx;
Bram Moolenaare5ea3462021-01-25 21:01:48 +0100677 ectx->ec_instr = INSTRUCTIONS(dfunc);
Bram Moolenaarb2049902021-01-24 12:53:53 +0100678 entry = estack_push_ufunc(ufunc, 1);
Bram Moolenaarc620c052020-07-08 15:16:19 +0200679 if (entry != NULL)
680 {
681 // Set the script context to the script where the function was defined.
Bram Moolenaarc70fe462021-04-17 17:59:19 +0200682 // Save the current context so it can be restored on return.
683 entry->es_save_sctx = current_sctx;
684 current_sctx = ufunc->uf_script_ctx;
Bram Moolenaarc620c052020-07-08 15:16:19 +0200685 }
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100686
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +0200687 // Start execution at the first instruction.
688 ectx->ec_iidx = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100689
690 return OK;
691}
692
Bram Moolenaar7509ad82021-12-14 18:14:37 +0000693// Double linked list of funcstack_T in use.
694static funcstack_T *first_funcstack = NULL;
695
696 static void
697add_funcstack_to_list(funcstack_T *funcstack)
698{
699 // Link in list of funcstacks.
700 if (first_funcstack != NULL)
701 first_funcstack->fs_prev = funcstack;
702 funcstack->fs_next = first_funcstack;
703 funcstack->fs_prev = NULL;
704 first_funcstack = funcstack;
705}
706
707 static void
708remove_funcstack_from_list(funcstack_T *funcstack)
709{
710 if (funcstack->fs_prev == NULL)
711 first_funcstack = funcstack->fs_next;
712 else
713 funcstack->fs_prev->fs_next = funcstack->fs_next;
714 if (funcstack->fs_next != NULL)
715 funcstack->fs_next->fs_prev = funcstack->fs_prev;
716}
717
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100718/*
Bram Moolenaarbf67ea12020-05-02 17:52:42 +0200719 * Used when returning from a function: Check if any closure is still
720 * referenced. If so then move the arguments and variables to a separate piece
721 * of stack to be used when the closure is called.
722 * When "free_arguments" is TRUE the arguments are to be freed.
723 * Returns FAIL when out of memory.
724 */
725 static int
726handle_closure_in_use(ectx_T *ectx, int free_arguments)
727{
728 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
729 + ectx->ec_dfunc_idx;
Bram Moolenaarfdeab652020-09-19 15:16:50 +0200730 int argcount;
731 int top;
Bram Moolenaarbf67ea12020-05-02 17:52:42 +0200732 int idx;
733 typval_T *tv;
734 int closure_in_use = FALSE;
Bram Moolenaar148ce7a2020-09-23 21:57:23 +0200735 garray_T *gap = &ectx->ec_funcrefs;
736 varnumber_T closure_count;
Bram Moolenaarbf67ea12020-05-02 17:52:42 +0200737
Bram Moolenaarfdeab652020-09-19 15:16:50 +0200738 if (dfunc->df_ufunc == NULL)
Bram Moolenaar148ce7a2020-09-23 21:57:23 +0200739 return OK; // function was freed
740 if (dfunc->df_has_closure == 0)
741 return OK; // no closures
742 tv = STACK_TV(ectx->ec_frame_idx + STACK_FRAME_SIZE + dfunc->df_varcount);
743 closure_count = tv->vval.v_number;
744 if (closure_count == 0)
745 return OK; // no funcrefs created
746
Bram Moolenaar8fa745e2022-09-16 19:04:24 +0100747 // Compute "top": the first entry in the stack used by the function.
748 // This is the first argument (after that comes the stack frame and then
749 // the local variables).
Bram Moolenaarfdeab652020-09-19 15:16:50 +0200750 argcount = ufunc_argcount(dfunc->df_ufunc);
751 top = ectx->ec_frame_idx - argcount;
752
Bram Moolenaarbf67ea12020-05-02 17:52:42 +0200753 // Check if any created closure is still in use.
Bram Moolenaar148ce7a2020-09-23 21:57:23 +0200754 for (idx = 0; idx < closure_count; ++idx)
Bram Moolenaarbf67ea12020-05-02 17:52:42 +0200755 {
Bram Moolenaarc70bdab2020-09-26 19:59:38 +0200756 partial_T *pt;
757 int off = gap->ga_len - closure_count + idx;
Bram Moolenaar148ce7a2020-09-23 21:57:23 +0200758
Bram Moolenaarc70bdab2020-09-26 19:59:38 +0200759 if (off < 0)
760 continue; // count is off or already done
761 pt = ((partial_T **)gap->ga_data)[off];
Bram Moolenaar148ce7a2020-09-23 21:57:23 +0200762 if (pt->pt_refcount > 1)
Bram Moolenaarf7779c62020-05-03 15:38:16 +0200763 {
Bram Moolenaar148ce7a2020-09-23 21:57:23 +0200764 int refcount = pt->pt_refcount;
Bram Moolenaar221fcc72020-05-05 19:46:20 +0200765 int i;
766
Dominique Pelleaf4a61a2021-12-27 17:21:41 +0000767 // A Reference in a local variable doesn't count, it gets
Bram Moolenaar221fcc72020-05-05 19:46:20 +0200768 // unreferenced on return.
769 for (i = 0; i < dfunc->df_varcount; ++i)
770 {
771 typval_T *stv = STACK_TV(ectx->ec_frame_idx
772 + STACK_FRAME_SIZE + i);
Bram Moolenaar148ce7a2020-09-23 21:57:23 +0200773 if (stv->v_type == VAR_PARTIAL && pt == stv->vval.v_partial)
Bram Moolenaar221fcc72020-05-05 19:46:20 +0200774 --refcount;
775 }
776 if (refcount > 1)
777 {
778 closure_in_use = TRUE;
779 break;
780 }
Bram Moolenaarf7779c62020-05-03 15:38:16 +0200781 }
Bram Moolenaarbf67ea12020-05-02 17:52:42 +0200782 }
783
784 if (closure_in_use)
785 {
786 funcstack_T *funcstack = ALLOC_CLEAR_ONE(funcstack_T);
787 typval_T *stack;
788
789 // A closure is using the arguments and/or local variables.
790 // Move them to the called function.
791 if (funcstack == NULL)
792 return FAIL;
Bram Moolenaar7509ad82021-12-14 18:14:37 +0000793
Bram Moolenaar85d5e2b2020-10-10 14:13:01 +0200794 funcstack->fs_var_offset = argcount + STACK_FRAME_SIZE;
Bram Moolenaar1936c762022-09-28 15:19:10 +0100795 funcstack->fs_ga.ga_len = funcstack->fs_var_offset
796 + dfunc->df_varcount;
Bram Moolenaarbf67ea12020-05-02 17:52:42 +0200797 stack = ALLOC_CLEAR_MULT(typval_T, funcstack->fs_ga.ga_len);
798 funcstack->fs_ga.ga_data = stack;
799 if (stack == NULL)
800 {
801 vim_free(funcstack);
802 return FAIL;
803 }
Bram Moolenaar7509ad82021-12-14 18:14:37 +0000804 add_funcstack_to_list(funcstack);
Bram Moolenaarbf67ea12020-05-02 17:52:42 +0200805
806 // Move or copy the arguments.
807 for (idx = 0; idx < argcount; ++idx)
808 {
809 tv = STACK_TV(top + idx);
810 if (free_arguments)
811 {
812 *(stack + idx) = *tv;
813 tv->v_type = VAR_UNKNOWN;
814 }
815 else
816 copy_tv(tv, stack + idx);
817 }
Bram Moolenaar8fa745e2022-09-16 19:04:24 +0100818 // Skip the stack frame.
Bram Moolenaarbf67ea12020-05-02 17:52:42 +0200819 // Move the local variables.
820 for (idx = 0; idx < dfunc->df_varcount; ++idx)
821 {
822 tv = STACK_TV(ectx->ec_frame_idx + STACK_FRAME_SIZE + idx);
Bram Moolenaarf821dda2020-05-06 22:18:17 +0200823
Bram Moolenaar85d5e2b2020-10-10 14:13:01 +0200824 // A partial created for a local function, that is also used as a
825 // local variable, has a reference count for the variable, thus
826 // will never go down to zero. When all these refcounts are one
827 // then the funcstack is unused. We need to count how many we have
Bram Moolenaar7509ad82021-12-14 18:14:37 +0000828 // so we know when to check.
Bram Moolenaarf821dda2020-05-06 22:18:17 +0200829 if (tv->v_type == VAR_PARTIAL && tv->vval.v_partial != NULL)
830 {
Bram Moolenaar85d5e2b2020-10-10 14:13:01 +0200831 int i;
Bram Moolenaarf821dda2020-05-06 22:18:17 +0200832
Bram Moolenaar148ce7a2020-09-23 21:57:23 +0200833 for (i = 0; i < closure_count; ++i)
Bram Moolenaar85d5e2b2020-10-10 14:13:01 +0200834 if (tv->vval.v_partial == ((partial_T **)gap->ga_data)[
835 gap->ga_len - closure_count + i])
836 ++funcstack->fs_min_refcount;
Bram Moolenaarf821dda2020-05-06 22:18:17 +0200837 }
838
Bram Moolenaar85d5e2b2020-10-10 14:13:01 +0200839 *(stack + funcstack->fs_var_offset + idx) = *tv;
Bram Moolenaarbf67ea12020-05-02 17:52:42 +0200840 tv->v_type = VAR_UNKNOWN;
841 }
842
Bram Moolenaar148ce7a2020-09-23 21:57:23 +0200843 for (idx = 0; idx < closure_count; ++idx)
Bram Moolenaarbf67ea12020-05-02 17:52:42 +0200844 {
Bram Moolenaar148ce7a2020-09-23 21:57:23 +0200845 partial_T *pt = ((partial_T **)gap->ga_data)[gap->ga_len
846 - closure_count + idx];
847 if (pt->pt_refcount > 1)
Bram Moolenaarbf67ea12020-05-02 17:52:42 +0200848 {
Bram Moolenaar148ce7a2020-09-23 21:57:23 +0200849 ++funcstack->fs_refcount;
850 pt->pt_funcstack = funcstack;
Bram Moolenaar0186e582021-01-10 18:33:11 +0100851 pt->pt_outer.out_stack = &funcstack->fs_ga;
852 pt->pt_outer.out_frame_idx = ectx->ec_frame_idx - top;
Bram Moolenaarbf67ea12020-05-02 17:52:42 +0200853 }
854 }
855 }
856
Bram Moolenaar148ce7a2020-09-23 21:57:23 +0200857 for (idx = 0; idx < closure_count; ++idx)
858 partial_unref(((partial_T **)gap->ga_data)[gap->ga_len
859 - closure_count + idx]);
860 gap->ga_len -= closure_count;
861 if (gap->ga_len == 0)
862 ga_clear(gap);
863
Bram Moolenaarbf67ea12020-05-02 17:52:42 +0200864 return OK;
865}
866
867/*
Bram Moolenaar85d5e2b2020-10-10 14:13:01 +0200868 * Called when a partial is freed or its reference count goes down to one. The
869 * funcstack may be the only reference to the partials in the local variables.
870 * Go over all of them, the funcref and can be freed if all partials
871 * referencing the funcstack have a reference count of one.
Bram Moolenaaracd6b992022-09-17 16:27:39 +0100872 * Returns TRUE if the funcstack is freed, the partial referencing it will then
873 * also have been freed.
Bram Moolenaar85d5e2b2020-10-10 14:13:01 +0200874 */
Bram Moolenaaracd6b992022-09-17 16:27:39 +0100875 int
Bram Moolenaar85d5e2b2020-10-10 14:13:01 +0200876funcstack_check_refcount(funcstack_T *funcstack)
877{
Bram Moolenaaracd6b992022-09-17 16:27:39 +0100878 int i;
879 garray_T *gap = &funcstack->fs_ga;
880 int done = 0;
881 typval_T *stack;
Bram Moolenaar85d5e2b2020-10-10 14:13:01 +0200882
883 if (funcstack->fs_refcount > funcstack->fs_min_refcount)
Bram Moolenaaracd6b992022-09-17 16:27:39 +0100884 return FALSE;
Bram Moolenaar85d5e2b2020-10-10 14:13:01 +0200885 for (i = funcstack->fs_var_offset; i < gap->ga_len; ++i)
886 {
887 typval_T *tv = ((typval_T *)gap->ga_data) + i;
888
889 if (tv->v_type == VAR_PARTIAL && tv->vval.v_partial != NULL
890 && tv->vval.v_partial->pt_funcstack == funcstack
891 && tv->vval.v_partial->pt_refcount == 1)
892 ++done;
893 }
Bram Moolenaaracd6b992022-09-17 16:27:39 +0100894 if (done != funcstack->fs_min_refcount)
895 return FALSE;
Bram Moolenaar85d5e2b2020-10-10 14:13:01 +0200896
Bram Moolenaaracd6b992022-09-17 16:27:39 +0100897 stack = gap->ga_data;
898
899 // All partials referencing the funcstack have a reference count of
900 // one, thus the funcstack is no longer of use.
901 for (i = 0; i < gap->ga_len; ++i)
902 clear_tv(stack + i);
903 vim_free(stack);
904 remove_funcstack_from_list(funcstack);
905 vim_free(funcstack);
906
907 return TRUE;
Bram Moolenaar85d5e2b2020-10-10 14:13:01 +0200908}
909
910/*
Bram Moolenaar7509ad82021-12-14 18:14:37 +0000911 * For garbage collecting: set references in all variables referenced by
912 * all funcstacks.
913 */
914 int
915set_ref_in_funcstacks(int copyID)
916{
917 funcstack_T *funcstack;
918
919 for (funcstack = first_funcstack; funcstack != NULL;
920 funcstack = funcstack->fs_next)
921 {
922 typval_T *stack = funcstack->fs_ga.ga_data;
923 int i;
924
925 for (i = 0; i < funcstack->fs_ga.ga_len; ++i)
926 if (set_ref_in_item(stack + i, copyID, NULL, NULL))
927 return TRUE; // abort
928 }
929 return FALSE;
930}
931
Bram Moolenaar806a2732022-09-04 15:40:36 +0100932// Ugly static to avoid passing the execution context around through many
933// layers.
934static ectx_T *current_ectx = NULL;
935
Bram Moolenaar7509ad82021-12-14 18:14:37 +0000936/*
Bram Moolenaar806a2732022-09-04 15:40:36 +0100937 * Return TRUE if currently executing a :def function.
938 * Can be used by builtin functions only.
Bram Moolenaar1d84f762022-09-03 21:35:53 +0100939 */
Bram Moolenaar806a2732022-09-04 15:40:36 +0100940 int
941in_def_function(void)
942{
943 return current_ectx != NULL;
944}
945
946/*
Ernie Rael4c8da022023-10-11 21:35:11 +0200947 * If executing a class/object method, then fill in the lval_T.
948 * Set lr_tv to the executing item, and lr_exec_class to the executing class;
949 * use free_tv and class_unref when finished with the lval_root.
950 * For use by builtin functions.
951 *
952 * Return FAIL and do nothing if not executing in a class; otherwise OK.
953 */
954 int
955fill_exec_lval_root(lval_root_T *root)
956{
957 ectx_T *ectx = current_ectx;
958 if (ectx != NULL)
959 {
960 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
961 + current_ectx->ec_dfunc_idx;
962 ufunc_T *ufunc = dfunc->df_ufunc;
963 if (ufunc->uf_class != NULL) // executing a method?
964 {
965 typval_T *tv = alloc_tv();
966 if (tv != NULL)
967 {
968 CLEAR_POINTER(root);
969 root->lr_tv = tv;
970 copy_tv(STACK_TV_VAR(0), root->lr_tv);
971 root->lr_cl_exec = ufunc->uf_class;
972 ++root->lr_cl_exec->class_refcount;
973 return OK;
974 }
975 }
976 }
977
978 return FAIL;
979}
980
981/*
Bram Moolenaar98aff652022-09-06 21:02:35 +0100982 * Clear "current_ectx" and return the previous value. To be used when calling
983 * a user function.
984 */
985 ectx_T *
dundargocc57b5bc2022-11-02 13:30:51 +0000986clear_current_ectx(void)
Bram Moolenaar98aff652022-09-06 21:02:35 +0100987{
988 ectx_T *r = current_ectx;
989
990 current_ectx = NULL;
991 return r;
992}
993
994 void
995restore_current_ectx(ectx_T *ectx)
996{
997 if (current_ectx != NULL)
998 iemsg("Restoring current_ectx while it is not NULL");
999 current_ectx = ectx;
1000}
1001
1002/*
Bram Moolenaar806a2732022-09-04 15:40:36 +01001003 * Add an entry for a deferred function call to the currently executing
1004 * function.
1005 * Return the list or NULL when failed.
1006 */
1007 static list_T *
1008add_defer_item(int var_idx, int argcount, ectx_T *ectx)
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001009{
1010 typval_T *defer_tv = STACK_TV_VAR(var_idx);
1011 list_T *defer_l;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001012 list_T *l;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001013 typval_T listval;
1014
1015 if (defer_tv->v_type != VAR_LIST)
1016 {
Bram Moolenaara5348f22022-09-04 11:42:22 +01001017 // first time, allocate the list
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001018 if (rettv_list_alloc(defer_tv) == FAIL)
Bram Moolenaar806a2732022-09-04 15:40:36 +01001019 return NULL;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001020 }
1021 defer_l = defer_tv->vval.v_list;
1022
1023 l = list_alloc_with_items(argcount + 1);
1024 if (l == NULL)
Bram Moolenaar806a2732022-09-04 15:40:36 +01001025 return NULL;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001026 listval.v_type = VAR_LIST;
1027 listval.vval.v_list = l;
1028 listval.v_lock = 0;
Bram Moolenaara5348f22022-09-04 11:42:22 +01001029 if (list_insert_tv(defer_l, &listval, defer_l->lv_first) == FAIL)
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001030 {
1031 vim_free(l);
Bram Moolenaar806a2732022-09-04 15:40:36 +01001032 return NULL;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001033 }
1034
Bram Moolenaar806a2732022-09-04 15:40:36 +01001035 return l;
1036}
1037
1038/*
1039 * Handle ISN_DEFER. Stack has a function reference and "argcount" arguments.
1040 * The local variable that lists deferred functions is "var_idx".
1041 * Returns OK or FAIL.
1042 */
1043 static int
Yegappan Lakshmananf3eac692023-10-17 11:00:45 +02001044defer_command(int var_idx, int argcount, ectx_T *ectx)
Bram Moolenaar806a2732022-09-04 15:40:36 +01001045{
Yegappan Lakshmananf3eac692023-10-17 11:00:45 +02001046 list_T *l = add_defer_item(var_idx, argcount, ectx);
Bram Moolenaar806a2732022-09-04 15:40:36 +01001047 int i;
1048 typval_T *func_tv;
1049
1050 if (l == NULL)
1051 return FAIL;
1052
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001053 func_tv = STACK_TV_BOT(-argcount - 1);
Yegappan Lakshmananf3eac692023-10-17 11:00:45 +02001054 if (func_tv->v_type != VAR_PARTIAL && func_tv->v_type != VAR_FUNC)
Bram Moolenaarf5fec052022-09-11 11:49:22 +01001055 {
1056 semsg(_(e_expected_str_but_got_str),
Yegappan Lakshmananf3eac692023-10-17 11:00:45 +02001057 "function or partial",
Bram Moolenaarf5fec052022-09-11 11:49:22 +01001058 vartype_name(func_tv->v_type));
1059 return FAIL;
1060 }
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001061 list_set_item(l, 0, func_tv);
1062
Bram Moolenaarf5fec052022-09-11 11:49:22 +01001063 for (i = 0; i < argcount; ++i)
Yegappan Lakshmananf3eac692023-10-17 11:00:45 +02001064 list_set_item(l, i + 1, STACK_TV_BOT(-argcount + i));
1065 ectx->ec_stack.ga_len -= argcount + 1;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001066 return OK;
1067}
1068
1069/*
Bram Moolenaar8dbab1d2023-01-27 20:14:02 +00001070 * Add a deferred call for "name" with arguments "argvars[argcount]".
Bram Moolenaar806a2732022-09-04 15:40:36 +01001071 * Consumes "name", also on failure.
1072 * Only to be called when in_def_function() returns TRUE.
1073 */
1074 int
1075add_defer_function(char_u *name, int argcount, typval_T *argvars)
1076{
1077 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
1078 + current_ectx->ec_dfunc_idx;
1079 list_T *l;
1080 typval_T func_tv;
1081 int i;
1082
1083 if (dfunc->df_defer_var_idx == 0)
1084 {
1085 iemsg("df_defer_var_idx is zero");
Bram Moolenaar31ea6bf2022-09-05 10:47:13 +01001086 vim_free(name);
Bram Moolenaar806a2732022-09-04 15:40:36 +01001087 return FAIL;
1088 }
Bram Moolenaar806a2732022-09-04 15:40:36 +01001089
Bram Moolenaarf5fec052022-09-11 11:49:22 +01001090 l = add_defer_item(dfunc->df_defer_var_idx - 1, argcount, current_ectx);
Bram Moolenaar806a2732022-09-04 15:40:36 +01001091 if (l == NULL)
1092 {
Bram Moolenaar31ea6bf2022-09-05 10:47:13 +01001093 vim_free(name);
Bram Moolenaar806a2732022-09-04 15:40:36 +01001094 return FAIL;
1095 }
1096
Bram Moolenaar31ea6bf2022-09-05 10:47:13 +01001097 func_tv.v_type = VAR_FUNC;
1098 func_tv.v_lock = 0;
1099 func_tv.vval.v_string = name;
Bram Moolenaar806a2732022-09-04 15:40:36 +01001100 list_set_item(l, 0, &func_tv);
Bram Moolenaar31ea6bf2022-09-05 10:47:13 +01001101
Bram Moolenaar806a2732022-09-04 15:40:36 +01001102 for (i = 0; i < argcount; ++i)
1103 list_set_item(l, i + 1, argvars + i);
1104 return OK;
1105}
1106
1107/*
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001108 * Invoked when returning from a function: Invoke any deferred calls.
1109 */
1110 static void
1111invoke_defer_funcs(ectx_T *ectx)
1112{
1113 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
1114 + ectx->ec_dfunc_idx;
1115 typval_T *defer_tv = STACK_TV_VAR(dfunc->df_defer_var_idx - 1);
1116 listitem_T *li;
1117
1118 if (defer_tv->v_type != VAR_LIST)
1119 return; // no function added
Yegappan Lakshmanan14113fd2023-03-07 17:13:51 +00001120 FOR_ALL_LIST_ITEMS(defer_tv->vval.v_list, li)
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001121 {
1122 list_T *l = li->li_tv.vval.v_list;
1123 typval_T rettv;
1124 typval_T argvars[MAX_FUNC_ARGS];
1125 int i;
1126 listitem_T *arg_li = l->lv_first;
Bram Moolenaar8dbab1d2023-01-27 20:14:02 +00001127 typval_T *functv = &l->lv_first->li_tv;
Yegappan Lakshmananf3eac692023-10-17 11:00:45 +02001128 int argcount = l->lv_len - 1;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001129
zeertzjqa1f2b5d2023-04-18 21:04:53 +01001130 if (functv->vval.v_string == NULL)
1131 // already being called, can happen if function does ":qa"
1132 continue;
1133
Bram Moolenaar8dbab1d2023-01-27 20:14:02 +00001134 for (i = 0; i < argcount; ++i)
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001135 {
1136 arg_li = arg_li->li_next;
1137 argvars[i] = arg_li->li_tv;
1138 }
1139
Bram Moolenaar8dbab1d2023-01-27 20:14:02 +00001140 funcexe_T funcexe;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001141 CLEAR_FIELD(funcexe);
1142 funcexe.fe_evaluate = TRUE;
1143 rettv.v_type = VAR_UNKNOWN;
Bram Moolenaar8dbab1d2023-01-27 20:14:02 +00001144 if (functv->v_type == VAR_PARTIAL)
1145 {
1146 funcexe.fe_partial = functv->vval.v_partial;
Yegappan Lakshmananf3eac692023-10-17 11:00:45 +02001147 funcexe.fe_object = functv->vval.v_partial->pt_obj;
Bram Moolenaar8dbab1d2023-01-27 20:14:02 +00001148 if (funcexe.fe_object != NULL)
1149 ++funcexe.fe_object->obj_refcount;
1150 }
zeertzjqa1f2b5d2023-04-18 21:04:53 +01001151
1152 char_u *name = functv->vval.v_string;
1153 functv->vval.v_string = NULL;
1154
Yegappan Lakshmanan06725952023-10-18 11:47:37 +02001155 // If the deferred function is called after an exception, then only the
Yegappan Lakshmananc59c1e02023-10-19 10:52:34 +02001156 // first statement in the function will be executed (because of the
1157 // exception). So save and restore the try/catch/throw exception
1158 // state.
1159 exception_state_T estate;
1160 exception_state_save(&estate);
1161 exception_state_clear();
Yegappan Lakshmanan06725952023-10-18 11:47:37 +02001162
zeertzjqa1f2b5d2023-04-18 21:04:53 +01001163 (void)call_func(name, -1, &rettv, argcount, argvars, &funcexe);
1164
Yegappan Lakshmananc59c1e02023-10-19 10:52:34 +02001165 exception_state_restore(&estate);
Yegappan Lakshmanan06725952023-10-18 11:47:37 +02001166
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001167 clear_tv(&rettv);
zeertzjqa1f2b5d2023-04-18 21:04:53 +01001168 vim_free(name);
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001169 }
1170}
1171
1172/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001173 * Return from the current function.
1174 */
Bram Moolenaarbf67ea12020-05-02 17:52:42 +02001175 static int
Bram Moolenaar4c137212021-04-19 16:48:48 +02001176func_return(ectx_T *ectx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001177{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001178 int idx;
Bram Moolenaar34c54eb2020-11-25 19:15:19 +01001179 int ret_idx;
Bram Moolenaarbf67ea12020-05-02 17:52:42 +02001180 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
1181 + ectx->ec_dfunc_idx;
1182 int argcount = ufunc_argcount(dfunc->df_ufunc);
Bram Moolenaarc620c052020-07-08 15:16:19 +02001183 estack_T *entry;
Bram Moolenaar12d26532021-02-19 19:13:21 +01001184 int prev_dfunc_idx = STACK_TV(ectx->ec_frame_idx
1185 + STACK_FRAME_FUNC_OFF)->vval.v_number;
Bram Moolenaarb06b50d2021-04-26 21:39:25 +02001186 funclocal_T *floc;
1187#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01001188 dfunc_T *prev_dfunc = ((dfunc_T *)def_functions.ga_data)
1189 + prev_dfunc_idx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001190
Bram Moolenaar12d26532021-02-19 19:13:21 +01001191 if (do_profiling == PROF_YES)
1192 {
1193 ufunc_T *caller = prev_dfunc->df_ufunc;
1194
1195 if (dfunc->df_ufunc->uf_profiling
1196 || (caller != NULL && caller->uf_profiling))
1197 {
1198 profile_may_end_func(((profinfo_T *)profile_info_ga.ga_data)
1199 + profile_info_ga.ga_len - 1, dfunc->df_ufunc, caller);
1200 --profile_info_ga.ga_len;
1201 }
1202 }
1203#endif
Bram Moolenaar919c12c2021-12-14 14:29:16 +00001204
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001205 if (dfunc->df_defer_var_idx > 0)
1206 invoke_defer_funcs(ectx);
1207
Bram Moolenaar919c12c2021-12-14 14:29:16 +00001208 // No check for uf_refcount being zero, cannot think of a way that would
1209 // happen.
Bram Moolenaarc970e422021-03-17 15:03:04 +01001210 --dfunc->df_ufunc->uf_calls;
1211
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001212 // execution context goes one level up
Bram Moolenaarc620c052020-07-08 15:16:19 +02001213 entry = estack_pop();
1214 if (entry != NULL)
Bram Moolenaarc70fe462021-04-17 17:59:19 +02001215 current_sctx = entry->es_save_sctx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001216
Bram Moolenaarbf67ea12020-05-02 17:52:42 +02001217 if (handle_closure_in_use(ectx, TRUE) == FAIL)
1218 return FAIL;
1219
Bram Moolenaar574950d2023-01-03 19:08:50 +00001220 // Clear the arguments. If this was an object method also clear the
1221 // object, it is just before the arguments.
1222 int top = ectx->ec_frame_idx - argcount;
Yegappan Lakshmanan1db15142023-09-19 20:34:05 +02001223 if (IS_OBJECT_METHOD(dfunc->df_ufunc))
Bram Moolenaar574950d2023-01-03 19:08:50 +00001224 --top;
Bram Moolenaarbf67ea12020-05-02 17:52:42 +02001225 for (idx = top; idx < ectx->ec_frame_idx; ++idx)
1226 clear_tv(STACK_TV(idx));
1227
1228 // Clear local variables and temp values, but not the return value.
1229 for (idx = ectx->ec_frame_idx + STACK_FRAME_SIZE;
Bram Moolenaar170fcfc2020-02-06 17:51:35 +01001230 idx < ectx->ec_stack.ga_len - 1; ++idx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001231 clear_tv(STACK_TV(idx));
Bram Moolenaar170fcfc2020-02-06 17:51:35 +01001232
Bram Moolenaar34c54eb2020-11-25 19:15:19 +01001233 // The return value should be on top of the stack. However, when aborting
1234 // it may not be there and ec_frame_idx is the top of the stack.
1235 ret_idx = ectx->ec_stack.ga_len - 1;
Bram Moolenaar0186e582021-01-10 18:33:11 +01001236 if (ret_idx == ectx->ec_frame_idx + STACK_FRAME_IDX_OFF)
Bram Moolenaar34c54eb2020-11-25 19:15:19 +01001237 ret_idx = 0;
1238
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02001239 if (ectx->ec_outer_ref != NULL)
1240 {
1241 if (ectx->ec_outer_ref->or_outer_allocated)
1242 vim_free(ectx->ec_outer_ref->or_outer);
1243 partial_unref(ectx->ec_outer_ref->or_partial);
1244 vim_free(ectx->ec_outer_ref);
1245 }
Bram Moolenaar0186e582021-01-10 18:33:11 +01001246
Bram Moolenaar170fcfc2020-02-06 17:51:35 +01001247 // Restore the previous frame.
Bram Moolenaar12d26532021-02-19 19:13:21 +01001248 ectx->ec_dfunc_idx = prev_dfunc_idx;
Bram Moolenaar0186e582021-01-10 18:33:11 +01001249 ectx->ec_iidx = STACK_TV(ectx->ec_frame_idx
1250 + STACK_FRAME_IIDX_OFF)->vval.v_number;
Bram Moolenaar5930ddc2021-04-26 20:32:59 +02001251 ectx->ec_instr = (void *)STACK_TV(ectx->ec_frame_idx
1252 + STACK_FRAME_INSTR_OFF)->vval.v_string;
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02001253 ectx->ec_outer_ref = (void *)STACK_TV(ectx->ec_frame_idx
Bram Moolenaar0186e582021-01-10 18:33:11 +01001254 + STACK_FRAME_OUTER_OFF)->vval.v_string;
Bram Moolenaar2fecb532021-03-24 22:00:56 +01001255 floc = (void *)STACK_TV(ectx->ec_frame_idx
1256 + STACK_FRAME_FUNCLOCAL_OFF)->vval.v_string;
Bram Moolenaar5366e1a2020-10-01 13:01:34 +02001257 // restoring ec_frame_idx must be last
Bram Moolenaar0186e582021-01-10 18:33:11 +01001258 ectx->ec_frame_idx = STACK_TV(ectx->ec_frame_idx
1259 + STACK_FRAME_IDX_OFF)->vval.v_number;
Bram Moolenaard386e922021-04-25 14:48:49 +02001260
Bram Moolenaar2fecb532021-03-24 22:00:56 +01001261 if (floc == NULL)
Bram Moolenaar4c137212021-04-19 16:48:48 +02001262 ectx->ec_funclocal.floc_restore_cmdmod = FALSE;
Bram Moolenaar2fecb532021-03-24 22:00:56 +01001263 else
1264 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02001265 ectx->ec_funclocal = *floc;
Bram Moolenaar2fecb532021-03-24 22:00:56 +01001266 vim_free(floc);
1267 }
1268
Bram Moolenaar34c54eb2020-11-25 19:15:19 +01001269 if (ret_idx > 0)
1270 {
1271 // Reset the stack to the position before the call, with a spot for the
1272 // return value, moved there from above the frame.
1273 ectx->ec_stack.ga_len = top + 1;
1274 *STACK_TV_BOT(-1) = *STACK_TV(ret_idx);
1275 }
1276 else
1277 // Reset the stack to the position before the call.
1278 ectx->ec_stack.ga_len = top;
Bram Moolenaarbf67ea12020-05-02 17:52:42 +02001279
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001280 funcdepth_decrement();
Bram Moolenaare99d4222021-06-13 14:01:26 +02001281 --ex_nesting_level;
Bram Moolenaarbf67ea12020-05-02 17:52:42 +02001282 return OK;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001283}
1284
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001285/*
1286 * Prepare arguments and rettv for calling a builtin or user function.
1287 */
1288 static int
1289call_prepare(int argcount, typval_T *argvars, ectx_T *ectx)
1290{
1291 int idx;
1292 typval_T *tv;
1293
1294 // Move arguments from bottom of the stack to argvars[] and add terminator.
1295 for (idx = 0; idx < argcount; ++idx)
1296 argvars[idx] = *STACK_TV_BOT(idx - argcount);
1297 argvars[argcount].v_type = VAR_UNKNOWN;
1298
1299 // Result replaces the arguments on the stack.
1300 if (argcount > 0)
1301 ectx->ec_stack.ga_len -= argcount - 1;
Bram Moolenaar35578162021-08-02 19:10:38 +02001302 else if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001303 return FAIL;
1304 else
1305 ++ectx->ec_stack.ga_len;
1306
1307 // Default return value is zero.
1308 tv = STACK_TV_BOT(-1);
1309 tv->v_type = VAR_NUMBER;
1310 tv->vval.v_number = 0;
Bram Moolenaar24565cf2022-03-28 18:16:52 +01001311 tv->v_lock = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001312
1313 return OK;
1314}
1315
1316/*
1317 * Call a builtin function by index.
1318 */
1319 static int
1320call_bfunc(int func_idx, int argcount, ectx_T *ectx)
1321{
1322 typval_T argvars[MAX_FUNC_ARGS];
1323 int idx;
Bram Moolenaar171fb922020-10-28 16:54:47 +01001324 int did_emsg_before = did_emsg;
Bram Moolenaar08f7a412020-07-13 20:41:08 +02001325 ectx_T *prev_ectx = current_ectx;
Bram Moolenaar7a3fe3e2021-07-22 14:58:47 +02001326 char *save_func_name = ectx->ec_where.wt_func_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001327
1328 if (call_prepare(argcount, argvars, ectx) == FAIL)
1329 return FAIL;
Bram Moolenaar7a3fe3e2021-07-22 14:58:47 +02001330 ectx->ec_where.wt_func_name = internal_func_name(func_idx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001331
Bram Moolenaar08f7a412020-07-13 20:41:08 +02001332 // Call the builtin function. Set "current_ectx" so that when it
1333 // recursively invokes call_def_function() a closure context can be set.
1334 current_ectx = ectx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001335 call_internal_func_by_idx(func_idx, argvars, STACK_TV_BOT(-1));
Bram Moolenaar08f7a412020-07-13 20:41:08 +02001336 current_ectx = prev_ectx;
Bram Moolenaar7a3fe3e2021-07-22 14:58:47 +02001337 ectx->ec_where.wt_func_name = save_func_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001338
1339 // Clear the arguments.
1340 for (idx = 0; idx < argcount; ++idx)
1341 clear_tv(&argvars[idx]);
Bram Moolenaar015f4262020-05-05 21:25:22 +02001342
Bram Moolenaar57f799e2020-12-12 20:42:19 +01001343 if (did_emsg > did_emsg_before)
Bram Moolenaar015f4262020-05-05 21:25:22 +02001344 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001345 return OK;
1346}
1347
1348/*
1349 * Execute a user defined function.
Bram Moolenaarab360522021-01-10 14:02:28 +01001350 * If the function is compiled this will add a stack frame and set the
1351 * instruction pointer at the start of the function.
1352 * Otherwise the function is called here.
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02001353 * If "pt" is not null use "pt->pt_outer" for ec_outer_ref->or_outer.
Bram Moolenaar7eeefd42020-02-26 21:24:23 +01001354 * "iptr" can be used to replace the instruction with a more efficient one.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001355 */
1356 static int
Bram Moolenaar0186e582021-01-10 18:33:11 +01001357call_ufunc(
1358 ufunc_T *ufunc,
1359 partial_T *pt,
1360 int argcount,
1361 ectx_T *ectx,
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02001362 isn_T *iptr,
1363 dict_T *selfdict)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001364{
1365 typval_T argvars[MAX_FUNC_ARGS];
1366 funcexe_T funcexe;
Bram Moolenaar0917e862023-02-18 14:42:44 +00001367 funcerror_T error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001368 int idx;
Bram Moolenaar28ee8922020-10-28 20:20:00 +01001369 int did_emsg_before = did_emsg;
Bram Moolenaar139575d2022-03-15 19:29:30 +00001370 compiletype_T compile_type = get_compile_type(ufunc);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001371
Bram Moolenaare99d4222021-06-13 14:01:26 +02001372 if (func_needs_compiling(ufunc, compile_type)
1373 && compile_def_function(ufunc, FALSE, compile_type, NULL)
1374 == FAIL)
Bram Moolenaar822ba242020-05-24 23:00:18 +02001375 return FAIL;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001376 if (ufunc->uf_def_status == UF_COMPILED)
Bram Moolenaar7eeefd42020-02-26 21:24:23 +01001377 {
Bram Moolenaar52c124d2020-12-20 21:43:35 +01001378 error = check_user_func_argcount(ufunc, argcount);
Bram Moolenaar50824712020-12-20 21:10:17 +01001379 if (error != FCERR_UNKNOWN)
1380 {
1381 if (error == FCERR_TOOMANY)
Bram Moolenaara6c18d32022-03-31 20:02:56 +01001382 semsg(_(e_too_many_arguments_for_function_str),
1383 printable_func_name(ufunc));
Bram Moolenaar50824712020-12-20 21:10:17 +01001384 else
Bram Moolenaare1242042021-12-16 20:56:57 +00001385 semsg(_(e_not_enough_arguments_for_function_str),
Bram Moolenaara6c18d32022-03-31 20:02:56 +01001386 printable_func_name(ufunc));
Bram Moolenaar50824712020-12-20 21:10:17 +01001387 return FAIL;
1388 }
1389
Bram Moolenaar7eeefd42020-02-26 21:24:23 +01001390 // The function has been compiled, can call it quickly. For a function
1391 // that was defined later: we can call it directly next time.
1392 if (iptr != NULL)
1393 {
Bram Moolenaar20431c92020-03-20 18:39:46 +01001394 delete_instr(iptr);
Bram Moolenaar7eeefd42020-02-26 21:24:23 +01001395 iptr->isn_type = ISN_DCALL;
1396 iptr->isn_arg.dfunc.cdf_idx = ufunc->uf_dfunc_idx;
1397 iptr->isn_arg.dfunc.cdf_argcount = argcount;
1398 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02001399 return call_dfunc(ufunc->uf_dfunc_idx, pt, argcount, ectx);
Bram Moolenaar7eeefd42020-02-26 21:24:23 +01001400 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001401
1402 if (call_prepare(argcount, argvars, ectx) == FAIL)
1403 return FAIL;
Bram Moolenaara80faa82020-04-12 19:37:17 +02001404 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00001405 funcexe.fe_evaluate = TRUE;
1406 funcexe.fe_selfdict = selfdict != NULL ? selfdict : dict_stack_get_dict();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001407
1408 // Call the user function. Result goes in last position on the stack.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001409 error = call_user_func_check(ufunc, argcount, argvars,
Bram Moolenaar851f86b2021-12-13 14:26:44 +00001410 STACK_TV_BOT(-1), &funcexe, funcexe.fe_selfdict);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001411
1412 // Clear the arguments.
1413 for (idx = 0; idx < argcount; ++idx)
1414 clear_tv(&argvars[idx]);
1415
1416 if (error != FCERR_NONE)
1417 {
Bram Moolenaar87b4e5c2022-10-01 15:32:46 +01001418 user_func_error(error, printable_func_name(ufunc),
1419 funcexe.fe_found_var);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001420 return FAIL;
1421 }
Bram Moolenaar28ee8922020-10-28 20:20:00 +01001422 if (did_emsg > did_emsg_before)
Bram Moolenaared677f52020-08-12 16:38:10 +02001423 // Error other than from calling the function itself.
1424 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001425 return OK;
1426}
1427
1428/*
Bram Moolenaara91a7132021-03-25 21:12:15 +01001429 * If command modifiers were applied restore them.
1430 */
1431 static void
1432may_restore_cmdmod(funclocal_T *funclocal)
1433{
1434 if (funclocal->floc_restore_cmdmod)
1435 {
1436 cmdmod.cmod_filter_regmatch.regprog = NULL;
1437 undo_cmdmod(&cmdmod);
1438 cmdmod = funclocal->floc_save_cmdmod;
1439 funclocal->floc_restore_cmdmod = FALSE;
1440 }
1441}
1442
1443/*
Bram Moolenaar88c89c72021-08-14 14:01:05 +02001444 * Return TRUE if an error was given (not caught in try/catch) or CTRL-C was
1445 * pressed.
Bram Moolenaara1773442020-08-12 15:21:22 +02001446 */
1447 static int
Bram Moolenaar88c89c72021-08-14 14:01:05 +02001448vim9_aborting(int prev_uncaught_emsg)
Bram Moolenaara1773442020-08-12 15:21:22 +02001449{
Bram Moolenaar88c89c72021-08-14 14:01:05 +02001450 return uncaught_emsg > prev_uncaught_emsg || got_int || did_throw;
Bram Moolenaara1773442020-08-12 15:21:22 +02001451}
1452
1453/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001454 * Execute a function by "name".
1455 * This can be a builtin function or a user function.
Bram Moolenaar7eeefd42020-02-26 21:24:23 +01001456 * "iptr" can be used to replace the instruction with a more efficient one.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001457 * Returns FAIL if not found without an error message.
1458 */
1459 static int
Bram Moolenaar2fecb532021-03-24 22:00:56 +01001460call_by_name(
1461 char_u *name,
1462 int argcount,
Bram Moolenaar2fecb532021-03-24 22:00:56 +01001463 ectx_T *ectx,
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02001464 isn_T *iptr,
1465 dict_T *selfdict)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001466{
1467 ufunc_T *ufunc;
1468
1469 if (builtin_function(name, -1))
1470 {
1471 int func_idx = find_internal_func(name);
1472
Bram Moolenaar1983f1a2022-02-28 20:55:02 +00001473 if (func_idx < 0) // Impossible?
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001474 return FAIL;
Bram Moolenaar389df252020-07-09 21:20:47 +02001475 if (check_internal_func(func_idx, argcount) < 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001476 return FAIL;
1477 return call_bfunc(func_idx, argcount, ectx);
1478 }
1479
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00001480 ufunc = find_func(name, FALSE);
Bram Moolenaara1773442020-08-12 15:21:22 +02001481
1482 if (ufunc == NULL)
1483 {
Bram Moolenaar88c89c72021-08-14 14:01:05 +02001484 int prev_uncaught_emsg = uncaught_emsg;
Bram Moolenaara1773442020-08-12 15:21:22 +02001485
1486 if (script_autoload(name, TRUE))
1487 // loaded a package, search for the function again
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00001488 ufunc = find_func(name, FALSE);
Bram Moolenaar88c89c72021-08-14 14:01:05 +02001489
1490 if (vim9_aborting(prev_uncaught_emsg))
Bram Moolenaara1773442020-08-12 15:21:22 +02001491 return FAIL; // bail out if loading the script caused an error
1492 }
1493
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001494 if (ufunc != NULL)
Bram Moolenaar04947cc2021-03-06 19:26:46 +01001495 {
Bram Moolenaar0d89d8a2022-12-31 14:01:24 +00001496 if (check_ufunc_arg_types(ufunc, argcount, 0, ectx) == FAIL)
1497 return FAIL;
Bram Moolenaar04947cc2021-03-06 19:26:46 +01001498
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02001499 return call_ufunc(ufunc, NULL, argcount, ectx, iptr, selfdict);
Bram Moolenaar04947cc2021-03-06 19:26:46 +01001500 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001501
1502 return FAIL;
1503}
1504
1505 static int
Bram Moolenaar2fecb532021-03-24 22:00:56 +01001506call_partial(
1507 typval_T *tv,
1508 int argcount_arg,
Bram Moolenaar2fecb532021-03-24 22:00:56 +01001509 ectx_T *ectx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001510{
Bram Moolenaara90afb92020-07-15 22:38:56 +02001511 int argcount = argcount_arg;
Bram Moolenaarbd5da372020-03-31 23:13:10 +02001512 char_u *name = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001513 int called_emsg_before = called_emsg;
Bram Moolenaarcb6cbf22021-01-12 17:17:01 +01001514 int res = FAIL;
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02001515 dict_T *selfdict = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001516
1517 if (tv->v_type == VAR_PARTIAL)
1518 {
Bram Moolenaara90afb92020-07-15 22:38:56 +02001519 partial_T *pt = tv->vval.v_partial;
1520 int i;
1521
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02001522 if (pt->pt_obj != NULL)
1523 {
1524 // partial with an object method. Push the object before the
1525 // function arguments.
1526 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
1527 return FAIL;
1528 for (i = 1; i <= argcount; ++i)
1529 *STACK_TV_BOT(-i + 1) = *STACK_TV_BOT(-i);
1530
1531 typval_T *obj_tv = STACK_TV_BOT(-argcount);
1532 obj_tv->v_type = VAR_OBJECT;
1533 obj_tv->v_lock = 0;
1534 obj_tv->vval.v_object = pt->pt_obj;
1535 ++pt->pt_obj->obj_refcount;
1536 ++ectx->ec_stack.ga_len;
1537 }
1538
Bram Moolenaara90afb92020-07-15 22:38:56 +02001539 if (pt->pt_argc > 0)
1540 {
1541 // Make space for arguments from the partial, shift the "argcount"
1542 // arguments up.
Bram Moolenaar35578162021-08-02 19:10:38 +02001543 if (GA_GROW_FAILS(&ectx->ec_stack, pt->pt_argc))
Bram Moolenaara90afb92020-07-15 22:38:56 +02001544 return FAIL;
1545 for (i = 1; i <= argcount; ++i)
1546 *STACK_TV_BOT(-i + pt->pt_argc) = *STACK_TV_BOT(-i);
1547 ectx->ec_stack.ga_len += pt->pt_argc;
1548 argcount += pt->pt_argc;
1549
1550 // copy the arguments from the partial onto the stack
1551 for (i = 0; i < pt->pt_argc; ++i)
1552 copy_tv(&pt->pt_argv[i], STACK_TV_BOT(-argcount + i));
1553 }
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02001554 selfdict = pt->pt_dict;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001555
1556 if (pt->pt_func != NULL)
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02001557 return call_ufunc(pt->pt_func, pt, argcount, ectx, NULL, selfdict);
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001558
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001559 name = pt->pt_name;
1560 }
Bram Moolenaarbd5da372020-03-31 23:13:10 +02001561 else if (tv->v_type == VAR_FUNC)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001562 name = tv->vval.v_string;
Bram Moolenaar95006e32020-08-29 17:47:08 +02001563 if (name != NULL)
1564 {
Bram Moolenaar0917e862023-02-18 14:42:44 +00001565 char_u fname_buf[FLEN_FIXED + 1];
1566 char_u *tofree = NULL;
1567 funcerror_T error = FCERR_NONE;
1568 char_u *fname;
Bram Moolenaar95006e32020-08-29 17:47:08 +02001569
1570 // May need to translate <SNR>123_ to K_SNR.
1571 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
1572 if (error != FCERR_NONE)
1573 res = FAIL;
1574 else
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02001575 res = call_by_name(fname, argcount, ectx, NULL, selfdict);
Bram Moolenaar95006e32020-08-29 17:47:08 +02001576 vim_free(tofree);
1577 }
1578
Bram Moolenaarcb6cbf22021-01-12 17:17:01 +01001579 if (res == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001580 {
1581 if (called_emsg == called_emsg_before)
Bram Moolenaara6c18d32022-03-31 20:02:56 +01001582 emsg_funcname(e_unknown_function_str,
Bram Moolenaar015f4262020-05-05 21:25:22 +02001583 name == NULL ? (char_u *)"[unknown]" : name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001584 return FAIL;
1585 }
1586 return OK;
1587}
1588
1589/*
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +02001590 * Check if "lock" is VAR_LOCKED or VAR_FIXED. If so give an error and return
1591 * TRUE.
1592 */
1593 static int
1594error_if_locked(int lock, char *error)
1595{
1596 if (lock & (VAR_LOCKED | VAR_FIXED))
1597 {
1598 emsg(_(error));
1599 return TRUE;
1600 }
1601 return FALSE;
1602}
1603
1604/*
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01001605 * Give an error if "tv" is not a number and return FAIL.
1606 */
1607 static int
1608check_for_number(typval_T *tv)
1609{
1610 if (tv->v_type != VAR_NUMBER)
1611 {
1612 semsg(_(e_expected_str_but_got_str),
1613 vartype_name(VAR_NUMBER), vartype_name(tv->v_type));
1614 return FAIL;
1615 }
1616 return OK;
1617}
1618
1619/*
Bram Moolenaar0bbf7222020-02-19 22:31:48 +01001620 * Store "tv" in variable "name".
1621 * This is for s: and g: variables.
1622 */
1623 static void
1624store_var(char_u *name, typval_T *tv)
1625{
1626 funccal_entry_T entry;
Bram Moolenaard877a572021-04-01 19:42:48 +02001627 int flags = ASSIGN_DECL;
Bram Moolenaar0bbf7222020-02-19 22:31:48 +01001628
Bram Moolenaard877a572021-04-01 19:42:48 +02001629 if (tv->v_lock)
1630 flags |= ASSIGN_CONST;
Bram Moolenaar0bbf7222020-02-19 22:31:48 +01001631 save_funccal(&entry);
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001632 set_var_const(name, 0, NULL, tv, FALSE, flags, 0);
Bram Moolenaar0bbf7222020-02-19 22:31:48 +01001633 restore_funccal();
1634}
1635
Bram Moolenaar3beaf9c2020-12-18 17:23:14 +01001636/*
Bram Moolenaar4f5e3972020-12-21 17:30:50 +01001637 * Convert "tv" to a string.
1638 * Return FAIL if not allowed.
1639 */
1640 static int
Yegappan Lakshmananbce51d92024-04-15 19:19:52 +02001641do_2string(typval_T *tv, int is_2string_any, int tostring_flags)
Bram Moolenaar4f5e3972020-12-21 17:30:50 +01001642{
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00001643 if (tv->v_type == VAR_STRING)
1644 return OK;
1645
1646 char_u *str;
1647
1648 if (is_2string_any)
Bram Moolenaar4f5e3972020-12-21 17:30:50 +01001649 {
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00001650 switch (tv->v_type)
Bram Moolenaar4f5e3972020-12-21 17:30:50 +01001651 {
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00001652 case VAR_SPECIAL:
1653 case VAR_BOOL:
1654 case VAR_NUMBER:
1655 case VAR_FLOAT:
Yegappan Lakshmananf01493c2024-04-14 23:21:02 +02001656 case VAR_DICT:
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00001657 case VAR_BLOB: break;
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02001658
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00001659 case VAR_LIST:
Yegappan Lakshmananbce51d92024-04-15 19:19:52 +02001660 if (tostring_flags & TOSTRING_TOLERANT)
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02001661 {
Bram Moolenaarb288ba92021-06-05 17:10:55 +02001662 char_u *s, *e, *p;
1663 garray_T ga;
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02001664
Bram Moolenaarb288ba92021-06-05 17:10:55 +02001665 ga_init2(&ga, sizeof(char_u *), 1);
1666
1667 // Convert to NL separated items, then
1668 // escape the items and replace the NL with
1669 // a space.
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02001670 str = typval2string(tv, TRUE);
Bram Moolenaarb288ba92021-06-05 17:10:55 +02001671 if (str == NULL)
1672 return FAIL;
1673 s = str;
1674 while ((e = vim_strchr(s, '\n')) != NULL)
1675 {
1676 *e = NUL;
Bram Moolenaar21c1a0c2021-10-17 17:20:23 +01001677 p = vim_strsave_fnameescape(s,
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00001678 VSE_NONE);
Bram Moolenaarb288ba92021-06-05 17:10:55 +02001679 if (p != NULL)
1680 {
1681 ga_concat(&ga, p);
1682 ga_concat(&ga, (char_u *)" ");
1683 vim_free(p);
1684 }
1685 s = e + 1;
1686 }
1687 vim_free(str);
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02001688 clear_tv(tv);
1689 tv->v_type = VAR_STRING;
Bram Moolenaarb288ba92021-06-05 17:10:55 +02001690 tv->vval.v_string = ga.ga_data;
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02001691 return OK;
1692 }
Yegappan Lakshmananbce51d92024-04-15 19:19:52 +02001693 if (tostring_flags & TOSTRING_INTERPOLATE)
1694 break;
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02001695 // FALLTHROUGH
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00001696 default: to_string_error(tv->v_type);
1697 return FAIL;
Bram Moolenaar4f5e3972020-12-21 17:30:50 +01001698 }
Bram Moolenaar4f5e3972020-12-21 17:30:50 +01001699 }
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00001700 str = typval_tostring(tv, TRUE);
1701 clear_tv(tv);
1702 tv->v_type = VAR_STRING;
1703 tv->vval.v_string = str;
Bram Moolenaar4f5e3972020-12-21 17:30:50 +01001704 return OK;
1705}
1706
1707/*
Bram Moolenaar3beaf9c2020-12-18 17:23:14 +01001708 * When the value of "sv" is a null list of dict, allocate it.
1709 */
1710 static void
Bram Moolenaar859cc212022-03-28 15:22:35 +01001711allocate_if_null(svar_T *sv)
Bram Moolenaar3beaf9c2020-12-18 17:23:14 +01001712{
Bram Moolenaar859cc212022-03-28 15:22:35 +01001713 typval_T *tv = sv->sv_tv;
1714
Bram Moolenaar3beaf9c2020-12-18 17:23:14 +01001715 switch (tv->v_type)
1716 {
1717 case VAR_LIST:
Bram Moolenaar859cc212022-03-28 15:22:35 +01001718 if (tv->vval.v_list == NULL && sv->sv_type != &t_list_empty)
Bram Moolenaarfef80642021-02-03 20:01:19 +01001719 (void)rettv_list_alloc(tv);
Bram Moolenaar3beaf9c2020-12-18 17:23:14 +01001720 break;
1721 case VAR_DICT:
Bram Moolenaar859cc212022-03-28 15:22:35 +01001722 if (tv->vval.v_dict == NULL && sv->sv_type != &t_dict_empty)
Bram Moolenaarfef80642021-02-03 20:01:19 +01001723 (void)rettv_dict_alloc(tv);
Bram Moolenaar3beaf9c2020-12-18 17:23:14 +01001724 break;
Bram Moolenaarb7c21af2021-04-18 14:12:31 +02001725 case VAR_BLOB:
Bram Moolenaar859cc212022-03-28 15:22:35 +01001726 if (tv->vval.v_blob == NULL && sv->sv_type != &t_blob_null)
Bram Moolenaarb7c21af2021-04-18 14:12:31 +02001727 (void)rettv_blob_alloc(tv);
1728 break;
Bram Moolenaar3beaf9c2020-12-18 17:23:14 +01001729 default:
1730 break;
1731 }
1732}
Bram Moolenaard3aac292020-04-19 14:32:17 +02001733
Bram Moolenaare7525c52021-01-09 13:20:37 +01001734/*
Bram Moolenaar0289a092021-03-14 18:40:19 +01001735 * Return the character "str[index]" where "index" is the character index,
1736 * including composing characters.
1737 * If "index" is out of range NULL is returned.
Bram Moolenaare7525c52021-01-09 13:20:37 +01001738 */
1739 char_u *
1740char_from_string(char_u *str, varnumber_T index)
1741{
1742 size_t nbyte = 0;
1743 varnumber_T nchar = index;
1744 size_t slen;
1745
1746 if (str == NULL)
1747 return NULL;
1748 slen = STRLEN(str);
1749
Bram Moolenaarff871402021-03-26 13:34:05 +01001750 // Do the same as for a list: a negative index counts from the end.
1751 // Optimization to check the first byte to be below 0x80 (and no composing
1752 // character follows) makes this a lot faster.
Bram Moolenaare7525c52021-01-09 13:20:37 +01001753 if (index < 0)
1754 {
1755 int clen = 0;
1756
1757 for (nbyte = 0; nbyte < slen; ++clen)
Bram Moolenaarff871402021-03-26 13:34:05 +01001758 {
1759 if (str[nbyte] < 0x80 && str[nbyte + 1] < 0x80)
1760 ++nbyte;
1761 else if (enc_utf8)
1762 nbyte += utfc_ptr2len(str + nbyte);
1763 else
1764 nbyte += mb_ptr2len(str + nbyte);
1765 }
Bram Moolenaare7525c52021-01-09 13:20:37 +01001766 nchar = clen + index;
1767 if (nchar < 0)
1768 // unlike list: index out of range results in empty string
1769 return NULL;
1770 }
1771
1772 for (nbyte = 0; nchar > 0 && nbyte < slen; --nchar)
Bram Moolenaarff871402021-03-26 13:34:05 +01001773 {
1774 if (str[nbyte] < 0x80 && str[nbyte + 1] < 0x80)
1775 ++nbyte;
1776 else if (enc_utf8)
1777 nbyte += utfc_ptr2len(str + nbyte);
1778 else
1779 nbyte += mb_ptr2len(str + nbyte);
1780 }
Bram Moolenaare7525c52021-01-09 13:20:37 +01001781 if (nbyte >= slen)
1782 return NULL;
Bram Moolenaar0289a092021-03-14 18:40:19 +01001783 return vim_strnsave(str + nbyte, mb_ptr2len(str + nbyte));
Bram Moolenaare7525c52021-01-09 13:20:37 +01001784}
1785
1786/*
1787 * Get the byte index for character index "idx" in string "str" with length
Bram Moolenaar0289a092021-03-14 18:40:19 +01001788 * "str_len". Composing characters are included.
Bram Moolenaare7525c52021-01-09 13:20:37 +01001789 * If going over the end return "str_len".
1790 * If "idx" is negative count from the end, -1 is the last character.
1791 * When going over the start return -1.
1792 */
1793 static long
1794char_idx2byte(char_u *str, size_t str_len, varnumber_T idx)
1795{
1796 varnumber_T nchar = idx;
1797 size_t nbyte = 0;
1798
1799 if (nchar >= 0)
1800 {
1801 while (nchar > 0 && nbyte < str_len)
1802 {
Bram Moolenaar0289a092021-03-14 18:40:19 +01001803 nbyte += mb_ptr2len(str + nbyte);
Bram Moolenaare7525c52021-01-09 13:20:37 +01001804 --nchar;
1805 }
1806 }
1807 else
1808 {
1809 nbyte = str_len;
1810 while (nchar < 0 && nbyte > 0)
1811 {
1812 --nbyte;
1813 nbyte -= mb_head_off(str, str + nbyte);
1814 ++nchar;
1815 }
1816 if (nchar < 0)
1817 return -1;
1818 }
1819 return (long)nbyte;
1820}
1821
1822/*
Bram Moolenaar0289a092021-03-14 18:40:19 +01001823 * Return the slice "str[first : last]" using character indexes. Composing
1824 * characters are included.
Bram Moolenaar6601b622021-01-13 21:47:15 +01001825 * "exclusive" is TRUE for slice().
Bram Moolenaare7525c52021-01-09 13:20:37 +01001826 * Return NULL when the result is empty.
1827 */
1828 char_u *
Bram Moolenaar6601b622021-01-13 21:47:15 +01001829string_slice(char_u *str, varnumber_T first, varnumber_T last, int exclusive)
Bram Moolenaare7525c52021-01-09 13:20:37 +01001830{
1831 long start_byte, end_byte;
1832 size_t slen;
1833
1834 if (str == NULL)
1835 return NULL;
1836 slen = STRLEN(str);
1837 start_byte = char_idx2byte(str, slen, first);
1838 if (start_byte < 0)
1839 start_byte = 0; // first index very negative: use zero
Bram Moolenaar6601b622021-01-13 21:47:15 +01001840 if ((last == -1 && !exclusive) || last == VARNUM_MAX)
Bram Moolenaare7525c52021-01-09 13:20:37 +01001841 end_byte = (long)slen;
1842 else
1843 {
1844 end_byte = char_idx2byte(str, slen, last);
Bram Moolenaar6601b622021-01-13 21:47:15 +01001845 if (!exclusive && end_byte >= 0 && end_byte < (long)slen)
Bram Moolenaare7525c52021-01-09 13:20:37 +01001846 // end index is inclusive
Bram Moolenaar0289a092021-03-14 18:40:19 +01001847 end_byte += mb_ptr2len(str + end_byte);
Bram Moolenaare7525c52021-01-09 13:20:37 +01001848 }
1849
1850 if (start_byte >= (long)slen || end_byte <= start_byte)
1851 return NULL;
1852 return vim_strnsave(str + start_byte, end_byte - start_byte);
1853}
1854
Bram Moolenaar6db660b2021-08-01 14:08:54 +02001855/*
1856 * Get a script variable for ISN_STORESCRIPT and ISN_LOADSCRIPT.
1857 * When "dfunc_idx" is negative don't give an error.
1858 * Returns NULL for an error.
1859 */
Bram Moolenaar07a65d22020-12-26 20:09:15 +01001860 static svar_T *
Bram Moolenaar6db660b2021-08-01 14:08:54 +02001861get_script_svar(scriptref_T *sref, int dfunc_idx)
Bram Moolenaar07a65d22020-12-26 20:09:15 +01001862{
1863 scriptitem_T *si = SCRIPT_ITEM(sref->sref_sid);
Bram Moolenaar6db660b2021-08-01 14:08:54 +02001864 dfunc_T *dfunc = dfunc_idx < 0 ? NULL
1865 : ((dfunc_T *)def_functions.ga_data) + dfunc_idx;
Bram Moolenaar07a65d22020-12-26 20:09:15 +01001866 svar_T *sv;
1867
1868 if (sref->sref_seq != si->sn_script_seq)
1869 {
Bram Moolenaar6db660b2021-08-01 14:08:54 +02001870 // The script was reloaded after the function was compiled, the
1871 // script_idx may not be valid.
1872 if (dfunc != NULL)
1873 semsg(_(e_script_variable_invalid_after_reload_in_function_str),
1874 printable_func_name(dfunc->df_ufunc));
Bram Moolenaar07a65d22020-12-26 20:09:15 +01001875 return NULL;
1876 }
1877 sv = ((svar_T *)si->sn_var_vals.ga_data) + sref->sref_idx;
Bram Moolenaar6de22962022-09-09 21:35:36 +01001878 if (sv->sv_name == NULL)
1879 {
1880 if (dfunc != NULL)
1881 emsg(_(e_script_variable_was_deleted));
1882 return NULL;
1883 }
Bram Moolenaar60dc8272021-07-29 22:48:54 +02001884 if (!equal_type(sv->sv_type, sref->sref_type, 0))
Bram Moolenaar07a65d22020-12-26 20:09:15 +01001885 {
Bram Moolenaar6db660b2021-08-01 14:08:54 +02001886 if (dfunc != NULL)
1887 emsg(_(e_script_variable_type_changed));
Bram Moolenaar07a65d22020-12-26 20:09:15 +01001888 return NULL;
1889 }
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001890
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01001891 if ((sv->sv_flags & SVFLAG_EXPORTED) == 0
1892 && sref->sref_sid != current_sctx.sc_sid)
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001893 {
1894 if (dfunc != NULL)
1895 semsg(_(e_item_not_exported_in_script_str), sv->sv_name);
1896 return NULL;
1897 }
Bram Moolenaar07a65d22020-12-26 20:09:15 +01001898 return sv;
1899}
1900
Bram Moolenaar0bbf7222020-02-19 22:31:48 +01001901/*
Bram Moolenaar20677332021-06-06 17:02:53 +02001902 * Function passed to do_cmdline() for splitting a script joined by NL
1903 * characters.
1904 */
1905 static char_u *
1906get_split_sourceline(
1907 int c UNUSED,
1908 void *cookie,
1909 int indent UNUSED,
1910 getline_opt_T options UNUSED)
1911{
1912 source_cookie_T *sp = (source_cookie_T *)cookie;
1913 char_u *p;
1914 char_u *line;
1915
Bram Moolenaar20677332021-06-06 17:02:53 +02001916 p = vim_strchr(sp->nextline, '\n');
1917 if (p == NULL)
1918 {
1919 line = vim_strsave(sp->nextline);
1920 sp->nextline += STRLEN(sp->nextline);
1921 }
1922 else
1923 {
1924 line = vim_strnsave(sp->nextline, p - sp->nextline);
1925 sp->nextline = p + 1;
1926 }
1927 return line;
1928}
1929
1930/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001931 * Execute a function by "name".
1932 * This can be a builtin function, user function or a funcref.
Bram Moolenaar7eeefd42020-02-26 21:24:23 +01001933 * "iptr" can be used to replace the instruction with a more efficient one.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001934 */
1935 static int
Bram Moolenaar2fecb532021-03-24 22:00:56 +01001936call_eval_func(
1937 char_u *name,
1938 int argcount,
Bram Moolenaar2fecb532021-03-24 22:00:56 +01001939 ectx_T *ectx,
1940 isn_T *iptr)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001941{
Bram Moolenaared677f52020-08-12 16:38:10 +02001942 int called_emsg_before = called_emsg;
1943 int res;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001944
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02001945 res = call_by_name(name, argcount, ectx, iptr, NULL);
Bram Moolenaared677f52020-08-12 16:38:10 +02001946 if (res == FAIL && called_emsg == called_emsg_before)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001947 {
Bram Moolenaar1df8b3f2020-04-23 18:13:23 +02001948 dictitem_T *v;
1949
1950 v = find_var(name, NULL, FALSE);
Bram Moolenaara6c18d32022-03-31 20:02:56 +01001951 if (v == NULL || (v->di_tv.v_type != VAR_PARTIAL
1952 && v->di_tv.v_type != VAR_FUNC))
Bram Moolenaar1df8b3f2020-04-23 18:13:23 +02001953 {
Bram Moolenaara6c18d32022-03-31 20:02:56 +01001954 emsg_funcname(e_unknown_function_str, name);
Bram Moolenaar1df8b3f2020-04-23 18:13:23 +02001955 return FAIL;
1956 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02001957 return call_partial(&v->di_tv, argcount, ectx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001958 }
Bram Moolenaared677f52020-08-12 16:38:10 +02001959 return res;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001960}
1961
1962/*
Bram Moolenaarf112f302020-12-20 17:47:52 +01001963 * When a function reference is used, fill a partial with the information
1964 * needed, especially when it is used as a closure.
1965 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001966 int
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01001967fill_partial_and_closure(
Bram Moolenaarcc341812022-09-19 15:54:34 +01001968 partial_T *pt,
1969 ufunc_T *ufunc,
1970 loopvarinfo_T *lvi,
1971 ectx_T *ectx)
Bram Moolenaarf112f302020-12-20 17:47:52 +01001972{
1973 pt->pt_func = ufunc;
1974 pt->pt_refcount = 1;
1975
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001976 if (ufunc->uf_flags & FC_CLOSURE)
Bram Moolenaarf112f302020-12-20 17:47:52 +01001977 {
1978 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
1979 + ectx->ec_dfunc_idx;
1980
Bram Moolenaarb46c0832022-09-15 17:19:37 +01001981 // The closure may need to find arguments and local variables of the
1982 // current function in the stack.
Bram Moolenaar0186e582021-01-10 18:33:11 +01001983 pt->pt_outer.out_stack = &ectx->ec_stack;
1984 pt->pt_outer.out_frame_idx = ectx->ec_frame_idx;
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02001985 if (ectx->ec_outer_ref != NULL)
1986 {
1987 // The current context already has a context, link to that one.
1988 pt->pt_outer.out_up = ectx->ec_outer_ref->or_outer;
1989 if (ectx->ec_outer_ref->or_partial != NULL)
1990 {
1991 pt->pt_outer.out_up_partial = ectx->ec_outer_ref->or_partial;
1992 ++pt->pt_outer.out_up_partial->pt_refcount;
1993 }
1994 }
Bram Moolenaarf112f302020-12-20 17:47:52 +01001995
Bram Moolenaarcc341812022-09-19 15:54:34 +01001996 if (lvi != NULL)
1997 {
1998 int depth;
1999
2000 // The closure may need to find variables defined inside a loop,
2001 // for every nested loop. A new reference is made every time,
2002 // ISN_ENDLOOP will check if they are actually used.
2003 for (depth = 0; depth < lvi->lvi_depth; ++depth)
2004 {
2005 pt->pt_outer.out_loop[depth].stack = &ectx->ec_stack;
2006 pt->pt_outer.out_loop[depth].var_idx = ectx->ec_frame_idx
2007 + STACK_FRAME_SIZE + lvi->lvi_loop[depth].var_idx;
2008 pt->pt_outer.out_loop[depth].var_count =
2009 lvi->lvi_loop[depth].var_count;
2010 }
Bram Moolenaar6d313be2022-09-22 16:36:25 +01002011 pt->pt_outer.out_loop_size = lvi->lvi_depth;
Bram Moolenaarcc341812022-09-19 15:54:34 +01002012 }
Bram Moolenaar6d313be2022-09-22 16:36:25 +01002013 else
2014 pt->pt_outer.out_loop_size = 0;
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01002015
Bram Moolenaarb46c0832022-09-15 17:19:37 +01002016 // If the function currently executing returns and the closure is still
2017 // being referenced, we need to make a copy of the context (arguments
2018 // and local variables) so that the closure can use it later.
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02002019 // Store a reference to the partial so we can handle that.
Bram Moolenaar35578162021-08-02 19:10:38 +02002020 if (GA_GROW_FAILS(&ectx->ec_funcrefs, 1))
Bram Moolenaarf112f302020-12-20 17:47:52 +01002021 {
2022 vim_free(pt);
2023 return FAIL;
2024 }
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02002025 // Extra variable keeps the count of closures created in the current
2026 // function call.
Bram Moolenaarf112f302020-12-20 17:47:52 +01002027 ++(((typval_T *)ectx->ec_stack.ga_data) + ectx->ec_frame_idx
2028 + STACK_FRAME_SIZE + dfunc->df_varcount)->vval.v_number;
2029
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01002030 ((partial_T **)ectx->ec_funcrefs.ga_data)[ectx->ec_funcrefs.ga_len]
2031 = pt;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002032 ++pt->pt_refcount;
2033 ++ectx->ec_funcrefs.ga_len;
2034 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002035 ++ufunc->uf_refcount;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002036 return OK;
2037}
2038
Bram Moolenaaraacc9662021-08-13 19:40:51 +02002039/*
2040 * Execute iptr->isn_arg.string as an Ex command.
2041 */
2042 static int
Ernie Raelee865f32023-09-29 19:53:55 +02002043exec_command(isn_T *iptr, char_u *cmd_string)
Bram Moolenaaraacc9662021-08-13 19:40:51 +02002044{
2045 source_cookie_T cookie;
2046
2047 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaarc4e1b862023-02-26 18:58:23 +00002048 // Pass getsourceline to get an error for a missing ":end" command.
Bram Moolenaaraacc9662021-08-13 19:40:51 +02002049 CLEAR_FIELD(cookie);
2050 cookie.sourcing_lnum = iptr->isn_lnum - 1;
Ernie Raelee865f32023-09-29 19:53:55 +02002051 if (do_cmdline(cmd_string, getsourceline, &cookie,
Bram Moolenaaraacc9662021-08-13 19:40:51 +02002052 DOCMD_VERBOSE|DOCMD_NOWAIT|DOCMD_KEYTYPED) == FAIL
2053 || did_emsg)
2054 return FAIL;
2055 return OK;
2056}
2057
Bram Moolenaar89445512022-04-14 12:58:23 +01002058/*
2059 * If script "sid" is not loaded yet then load it now.
2060 * Caller must make sure "sid" is a valid script ID.
2061 * "loaded" is set to TRUE if the script had to be loaded.
2062 * Returns FAIL if loading fails, OK if already loaded or loaded now.
2063 */
2064 int
2065may_load_script(int sid, int *loaded)
2066{
2067 scriptitem_T *si = SCRIPT_ITEM(sid);
2068
2069 if (si->sn_state == SN_STATE_NOT_LOADED)
2070 {
2071 *loaded = TRUE;
2072 if (do_source(si->sn_name, FALSE, DOSO_NONE, NULL) == FAIL)
2073 {
2074 semsg(_(e_cant_open_file_str), si->sn_name);
2075 return FAIL;
2076 }
2077 }
2078 return OK;
2079}
2080
Bram Moolenaarf18332f2021-05-07 17:55:55 +02002081// used for v_instr of typval of VAR_INSTR
2082struct instr_S {
2083 ectx_T *instr_ectx;
2084 isn_T *instr_instr;
2085};
2086
Bram Moolenaar4c137212021-04-19 16:48:48 +02002087// used for substitute_instr
2088typedef struct subs_expr_S {
2089 ectx_T *subs_ectx;
2090 isn_T *subs_instr;
2091 int subs_status;
2092} subs_expr_T;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002093
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02002094// Set when calling do_debug().
2095static ectx_T *debug_context = NULL;
Bram Moolenaar6bc30b02021-06-16 19:19:55 +02002096static int debug_var_count;
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02002097
2098/*
2099 * When debugging lookup "name" and return the typeval.
2100 * When not found return NULL.
2101 */
2102 typval_T *
2103lookup_debug_var(char_u *name)
2104{
2105 int idx;
2106 dfunc_T *dfunc;
Bram Moolenaar6bc30b02021-06-16 19:19:55 +02002107 ufunc_T *ufunc;
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02002108 ectx_T *ectx = debug_context;
Bram Moolenaar6bc30b02021-06-16 19:19:55 +02002109 int varargs_off;
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02002110
2111 if (ectx == NULL)
2112 return NULL;
2113 dfunc = ((dfunc_T *)def_functions.ga_data) + ectx->ec_dfunc_idx;
2114
2115 // Go through the local variable names, from last to first.
Bram Moolenaar6bc30b02021-06-16 19:19:55 +02002116 for (idx = debug_var_count - 1; idx >= 0; --idx)
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02002117 {
Bram Moolenaare406ff82022-03-10 20:47:43 +00002118 char_u *varname = ((char_u **)dfunc->df_var_names.ga_data)[idx];
2119
2120 // the variable name may be NULL when not available in this block
2121 if (varname != NULL && STRCMP(varname, name) == 0)
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02002122 return STACK_TV_VAR(idx);
2123 }
2124
Bram Moolenaar6bc30b02021-06-16 19:19:55 +02002125 // Go through argument names.
2126 ufunc = dfunc->df_ufunc;
2127 varargs_off = ufunc->uf_va_name == NULL ? 0 : 1;
2128 for (idx = 0; idx < ufunc->uf_args.ga_len; ++idx)
2129 if (STRCMP(((char_u **)(ufunc->uf_args.ga_data))[idx], name) == 0)
2130 return STACK_TV(ectx->ec_frame_idx - ufunc->uf_args.ga_len
2131 - varargs_off + idx);
2132 if (ufunc->uf_va_name != NULL && STRCMP(ufunc->uf_va_name, name) == 0)
2133 return STACK_TV(ectx->ec_frame_idx - 1);
2134
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02002135 return NULL;
2136}
2137
Bram Moolenaar26a44842021-09-02 18:49:06 +02002138/*
2139 * Return TRUE if there might be a breakpoint in "ufunc", which is when a
2140 * breakpoint was set in that function or when there is any expression.
2141 */
2142 int
2143may_break_in_function(ufunc_T *ufunc)
2144{
2145 return ufunc->uf_has_breakpoint || debug_has_expr_breakpoint();
2146}
2147
Bram Moolenaar4cea5362021-06-16 22:24:40 +02002148 static void
2149handle_debug(isn_T *iptr, ectx_T *ectx)
2150{
2151 char_u *line;
2152 ufunc_T *ufunc = (((dfunc_T *)def_functions.ga_data)
2153 + ectx->ec_dfunc_idx)->df_ufunc;
2154 isn_T *ni;
2155 int end_lnum = iptr->isn_lnum;
2156 garray_T ga;
2157 int lnum;
2158
Bram Moolenaar4f8f5422021-06-20 19:28:14 +02002159 if (ex_nesting_level > debug_break_level)
2160 {
2161 linenr_T breakpoint;
2162
Bram Moolenaar26a44842021-09-02 18:49:06 +02002163 if (!may_break_in_function(ufunc))
Bram Moolenaar4f8f5422021-06-20 19:28:14 +02002164 return;
2165
2166 // check for the next breakpoint if needed
2167 breakpoint = dbg_find_breakpoint(FALSE, ufunc->uf_name,
Bram Moolenaar8cec9272021-06-23 20:20:53 +02002168 iptr->isn_arg.debug.dbg_break_lnum);
Bram Moolenaar4f8f5422021-06-20 19:28:14 +02002169 if (breakpoint <= 0 || breakpoint > iptr->isn_lnum)
2170 return;
2171 }
2172
Bram Moolenaar4cea5362021-06-16 22:24:40 +02002173 SOURCING_LNUM = iptr->isn_lnum;
2174 debug_context = ectx;
Bram Moolenaar8cec9272021-06-23 20:20:53 +02002175 debug_var_count = iptr->isn_arg.debug.dbg_var_names_len;
Bram Moolenaar4cea5362021-06-16 22:24:40 +02002176
2177 for (ni = iptr + 1; ni->isn_type != ISN_FINISH; ++ni)
2178 if (ni->isn_type == ISN_DEBUG
2179 || ni->isn_type == ISN_RETURN
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002180 || ni->isn_type == ISN_RETURN_OBJECT
Bram Moolenaar4cea5362021-06-16 22:24:40 +02002181 || ni->isn_type == ISN_RETURN_VOID)
2182 {
Bram Moolenaar112bed02021-11-23 22:16:34 +00002183 end_lnum = ni->isn_lnum + (ni->isn_type == ISN_DEBUG ? 0 : 1);
Bram Moolenaar4cea5362021-06-16 22:24:40 +02002184 break;
2185 }
2186
2187 if (end_lnum > iptr->isn_lnum)
2188 {
2189 ga_init2(&ga, sizeof(char_u *), 10);
Bram Moolenaar310091d2021-12-23 21:14:37 +00002190 for (lnum = iptr->isn_lnum; lnum < end_lnum
2191 && lnum <= ufunc->uf_lines.ga_len; ++lnum)
Bram Moolenaar59b50c32021-06-17 22:27:48 +02002192 {
Bram Moolenaar303215d2021-07-07 20:10:43 +02002193 char_u *p = ((char_u **)ufunc->uf_lines.ga_data)[lnum - 1];
Bram Moolenaar59b50c32021-06-17 22:27:48 +02002194
Bram Moolenaar303215d2021-07-07 20:10:43 +02002195 if (p == NULL)
2196 continue; // left over from continuation line
2197 p = skipwhite(p);
Bram Moolenaar59b50c32021-06-17 22:27:48 +02002198 if (*p == '#')
2199 break;
Bram Moolenaar35578162021-08-02 19:10:38 +02002200 if (GA_GROW_OK(&ga, 1))
Bram Moolenaar59b50c32021-06-17 22:27:48 +02002201 ((char_u **)(ga.ga_data))[ga.ga_len++] = p;
2202 if (STRNCMP(p, "def ", 4) == 0)
2203 break;
2204 }
Bram Moolenaar4cea5362021-06-16 22:24:40 +02002205 line = ga_concat_strings(&ga, " ");
2206 vim_free(ga.ga_data);
2207 }
2208 else
2209 line = ((char_u **)ufunc->uf_lines.ga_data)[iptr->isn_lnum - 1];
Bram Moolenaar4cea5362021-06-16 22:24:40 +02002210
Dominique Pelle6e969552021-06-17 13:53:41 +02002211 do_debug(line == NULL ? (char_u *)"[empty]" : line);
Bram Moolenaar4cea5362021-06-16 22:24:40 +02002212 debug_context = NULL;
2213
2214 if (end_lnum > iptr->isn_lnum)
2215 vim_free(line);
2216}
2217
Bram Moolenaar4c137212021-04-19 16:48:48 +02002218/*
Bram Moolenaar65b0d162022-12-13 18:43:22 +00002219 * Store a value in a list, dict, blob or object variable.
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002220 * Returns OK, FAIL or NOTDONE (uncatchable error).
2221 */
2222 static int
2223execute_storeindex(isn_T *iptr, ectx_T *ectx)
2224{
Bram Moolenaarf7d1c6e2023-01-16 20:47:57 +00002225 vartype_T dest_type = iptr->isn_arg.storeindex.si_vartype;
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002226 typval_T *tv;
2227 typval_T *tv_idx = STACK_TV_BOT(-2);
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002228 long lidx = 0;
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002229 typval_T *tv_dest = STACK_TV_BOT(-1);
2230 int status = OK;
2231
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002232 if (tv_idx->v_type == VAR_NUMBER)
2233 lidx = (long)tv_idx->vval.v_number;
2234
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002235 // Stack contains:
2236 // -3 value to be stored
2237 // -2 index
Yegappan Lakshmanan3775f772023-09-01 22:05:45 +02002238 // -1 dict, list, blob, object or class
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002239 tv = STACK_TV_BOT(-3);
2240 SOURCING_LNUM = iptr->isn_lnum;
Gianmaria Bajod7085a02023-08-31 18:15:26 +02002241
2242 // Make sure an object has been initialized
2243 if (dest_type == VAR_OBJECT && tv_dest->vval.v_object == NULL)
2244 {
2245 emsg(_(e_using_null_object));
2246 status = FAIL;
2247 }
2248 else if (dest_type == VAR_ANY)
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002249 {
2250 dest_type = tv_dest->v_type;
2251 if (dest_type == VAR_DICT)
2252 status = do_2string(tv_idx, TRUE, FALSE);
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002253 else if (dest_type == VAR_OBJECT && tv_idx->v_type == VAR_STRING)
2254 {
2255 // Need to get the member index now that the class is known.
2256 object_T *obj = tv_dest->vval.v_object;
Ernie Raelbe828252024-07-26 18:37:02 +02002257 if (obj == NULL)
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002258 {
Ernie Raelbe828252024-07-26 18:37:02 +02002259 emsg(_(e_using_null_object));
2260 status = FAIL;
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002261 }
2262 else
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002263 {
Ernie Raelbe828252024-07-26 18:37:02 +02002264 class_T *cl = obj->obj_class;
2265 char_u *member = tv_idx->vval.v_string;
2266
2267 int m_idx;
2268 ocmember_T *m = object_member_lookup(cl, member, 0, &m_idx);
2269 if (m != NULL)
2270 {
2271 if (*member == '_')
2272 {
2273 emsg_var_cl_define(
2274 e_cannot_access_protected_variable_str,
2275 m->ocm_name, 0, cl);
2276 status = FAIL;
2277 }
2278
2279 lidx = m_idx;
2280 }
2281 else
2282 {
2283 member_not_found_msg(cl, VAR_OBJECT, member, 0);
2284 status = FAIL;
2285 }
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002286 }
2287 }
2288 else if ((dest_type == VAR_LIST || dest_type == VAR_OBJECT)
2289 && tv_idx->v_type != VAR_NUMBER)
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002290 {
2291 emsg(_(e_number_expected));
2292 status = FAIL;
2293 }
2294 }
Bram Moolenaare08be092022-02-17 13:08:26 +00002295
2296 if (status == OK)
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002297 {
Bram Moolenaare08be092022-02-17 13:08:26 +00002298 if (dest_type == VAR_LIST)
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002299 {
Bram Moolenaare08be092022-02-17 13:08:26 +00002300 list_T *list = tv_dest->vval.v_list;
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002301
Bram Moolenaare08be092022-02-17 13:08:26 +00002302 if (list == NULL)
2303 {
2304 emsg(_(e_list_not_set));
2305 return FAIL;
2306 }
2307 if (lidx < 0 && list->lv_len + lidx >= 0)
2308 // negative index is relative to the end
2309 lidx = list->lv_len + lidx;
2310 if (lidx < 0 || lidx > list->lv_len)
2311 {
2312 semsg(_(e_list_index_out_of_range_nr), lidx);
2313 return FAIL;
2314 }
2315 if (lidx < list->lv_len)
2316 {
2317 listitem_T *li = list_find(list, lidx);
2318
2319 if (error_if_locked(li->li_tv.v_lock,
Bram Moolenaar70c43d82022-01-26 21:01:15 +00002320 e_cannot_change_locked_list_item))
Bram Moolenaare08be092022-02-17 13:08:26 +00002321 return FAIL;
2322 // overwrite existing list item
2323 clear_tv(&li->li_tv);
2324 li->li_tv = *tv;
2325 }
2326 else
2327 {
2328 if (error_if_locked(list->lv_lock, e_cannot_change_locked_list))
2329 return FAIL;
2330 // append to list, only fails when out of memory
2331 if (list_append_tv(list, tv) == FAIL)
2332 return NOTDONE;
2333 clear_tv(tv);
2334 }
2335 }
2336 else if (dest_type == VAR_DICT)
2337 {
2338 char_u *key = tv_idx->vval.v_string;
2339 dict_T *dict = tv_dest->vval.v_dict;
2340 dictitem_T *di;
2341
2342 SOURCING_LNUM = iptr->isn_lnum;
2343 if (dict == NULL)
2344 {
2345 emsg(_(e_dictionary_not_set));
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002346 return FAIL;
Bram Moolenaare08be092022-02-17 13:08:26 +00002347 }
2348 if (key == NULL)
2349 key = (char_u *)"";
2350 di = dict_find(dict, key, -1);
2351 if (di != NULL)
2352 {
2353 if (error_if_locked(di->di_tv.v_lock,
2354 e_cannot_change_dict_item))
2355 return FAIL;
2356 // overwrite existing value
2357 clear_tv(&di->di_tv);
2358 di->di_tv = *tv;
2359 }
2360 else
2361 {
2362 if (error_if_locked(dict->dv_lock, e_cannot_change_dict))
2363 return FAIL;
2364 // add to dict, only fails when out of memory
2365 if (dict_add_tv(dict, (char *)key, tv) == FAIL)
2366 return NOTDONE;
2367 clear_tv(tv);
2368 }
2369 }
2370 else if (dest_type == VAR_BLOB)
2371 {
Bram Moolenaare08be092022-02-17 13:08:26 +00002372 blob_T *blob = tv_dest->vval.v_blob;
Bram Moolenaar65b0d162022-12-13 18:43:22 +00002373 varnumber_T nr;
2374 int error = FALSE;
2375 int len;
Bram Moolenaare08be092022-02-17 13:08:26 +00002376
2377 if (blob == NULL)
2378 {
2379 emsg(_(e_blob_not_set));
2380 return FAIL;
2381 }
2382 len = blob_len(blob);
2383 if (lidx < 0 && len + lidx >= 0)
2384 // negative index is relative to the end
2385 lidx = len + lidx;
2386
2387 // Can add one byte at the end.
2388 if (lidx < 0 || lidx > len)
2389 {
2390 semsg(_(e_blob_index_out_of_range_nr), lidx);
2391 return FAIL;
2392 }
2393 if (value_check_lock(blob->bv_lock, (char_u *)"blob", FALSE))
2394 return FAIL;
2395 nr = tv_get_number_chk(tv, &error);
2396 if (error)
2397 return FAIL;
2398 blob_set_append(blob, lidx, nr);
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002399 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002400 else if (dest_type == VAR_CLASS || dest_type == VAR_OBJECT)
2401 {
Yegappan Lakshmanan3775f772023-09-01 22:05:45 +02002402 typval_T *otv;
Bram Moolenaarf7d1c6e2023-01-16 20:47:57 +00002403
Yegappan Lakshmanan3775f772023-09-01 22:05:45 +02002404 if (dest_type == VAR_OBJECT)
2405 {
2406 object_T *obj = tv_dest->vval.v_object;
2407
2408 otv = (typval_T *)(obj + 1);
2409 class_T *itf = iptr->isn_arg.storeindex.si_class;
2410 if (itf != NULL)
2411 // convert interface member index to class member index
Ernie Rael18143d32023-09-04 22:30:41 +02002412 lidx = object_index_from_itf_index(itf, FALSE, lidx,
Yegappan Lakshmanan5a05d372023-09-29 19:43:11 +02002413 obj->obj_class);
Yegappan Lakshmanan3775f772023-09-01 22:05:45 +02002414 }
2415 else
2416 {
2417 // VAR_CLASS
2418 class_T *class = tv_dest->vval.v_class;
2419 otv = class->class_members_tv;
2420 }
Bram Moolenaarf7d1c6e2023-01-16 20:47:57 +00002421
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002422 clear_tv(&otv[lidx]);
2423 otv[lidx] = *tv;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002424 }
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002425 else
2426 {
Bram Moolenaare08be092022-02-17 13:08:26 +00002427 status = FAIL;
2428 semsg(_(e_cannot_index_str), vartype_name(dest_type));
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002429 }
2430 }
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002431
2432 clear_tv(tv_idx);
2433 clear_tv(tv_dest);
2434 ectx->ec_stack.ga_len -= 3;
2435 if (status == FAIL)
2436 {
2437 clear_tv(tv);
2438 return FAIL;
2439 }
2440 return OK;
2441}
2442
2443/*
Bram Moolenaarea5c8982022-02-17 14:42:02 +00002444 * Store a value in a list or blob range.
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002445 */
2446 static int
2447execute_storerange(isn_T *iptr, ectx_T *ectx)
2448{
2449 typval_T *tv;
2450 typval_T *tv_idx1 = STACK_TV_BOT(-3);
2451 typval_T *tv_idx2 = STACK_TV_BOT(-2);
2452 typval_T *tv_dest = STACK_TV_BOT(-1);
2453 int status = OK;
2454
2455 // Stack contains:
2456 // -4 value to be stored
2457 // -3 first index or "none"
2458 // -2 second index or "none"
2459 // -1 destination list or blob
2460 tv = STACK_TV_BOT(-4);
Bram Moolenaarea5c8982022-02-17 14:42:02 +00002461 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002462 if (tv_dest->v_type == VAR_LIST)
2463 {
Bram Moolenaar2995e5c2022-03-18 21:41:47 +00002464 long n1;
2465 long n2;
2466 listitem_T *li1;
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002467
Bram Moolenaar2995e5c2022-03-18 21:41:47 +00002468 n1 = (long)tv_get_number_chk(tv_idx1, NULL);
2469 if (tv_idx2->v_type == VAR_SPECIAL
2470 && tv_idx2->vval.v_number == VVAL_NONE)
2471 n2 = list_len(tv_dest->vval.v_list) - 1;
2472 else
2473 n2 = (long)tv_get_number_chk(tv_idx2, NULL);
2474
Bram Moolenaar22ebd172022-04-01 15:26:58 +01002475 li1 = check_range_index_one(tv_dest->vval.v_list, &n1, TRUE, FALSE);
Bram Moolenaar2995e5c2022-03-18 21:41:47 +00002476 if (li1 == NULL)
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002477 status = FAIL;
2478 else
2479 {
Bram Moolenaar2995e5c2022-03-18 21:41:47 +00002480 status = check_range_index_two(tv_dest->vval.v_list,
2481 &n1, li1, &n2, FALSE);
2482 if (status != FAIL)
2483 status = list_assign_range(
2484 tv_dest->vval.v_list,
2485 tv->vval.v_list,
2486 n1,
2487 n2,
2488 tv_idx2->v_type == VAR_SPECIAL,
2489 (char_u *)"=",
2490 (char_u *)"[unknown]");
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002491 }
2492 }
2493 else if (tv_dest->v_type == VAR_BLOB)
2494 {
2495 varnumber_T n1;
2496 varnumber_T n2;
Bram Moolenaar2995e5c2022-03-18 21:41:47 +00002497 long bloblen;
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002498
Bram Moolenaar2995e5c2022-03-18 21:41:47 +00002499 n1 = tv_get_number_chk(tv_idx1, NULL);
2500 if (tv_idx2->v_type == VAR_SPECIAL
2501 && tv_idx2->vval.v_number == VVAL_NONE)
2502 n2 = blob_len(tv_dest->vval.v_blob) - 1;
2503 else
2504 n2 = tv_get_number_chk(tv_idx2, NULL);
2505 bloblen = blob_len(tv_dest->vval.v_blob);
2506
2507 if (check_blob_index(bloblen, n1, FALSE) == FAIL
2508 || check_blob_range(bloblen, n1, n2, FALSE) == FAIL)
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002509 status = FAIL;
2510 else
Bram Moolenaar2995e5c2022-03-18 21:41:47 +00002511 status = blob_set_range(tv_dest->vval.v_blob, n1, n2, tv);
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002512 }
2513 else
2514 {
2515 status = FAIL;
Bram Moolenaarea5c8982022-02-17 14:42:02 +00002516 emsg(_(e_list_or_blob_required));
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002517 }
2518
2519 clear_tv(tv_idx1);
2520 clear_tv(tv_idx2);
2521 clear_tv(tv_dest);
2522 ectx->ec_stack.ga_len -= 4;
2523 clear_tv(tv);
2524
2525 return status;
2526}
2527
2528/*
2529 * Unlet item in list or dict variable.
2530 */
2531 static int
2532execute_unletindex(isn_T *iptr, ectx_T *ectx)
2533{
2534 typval_T *tv_idx = STACK_TV_BOT(-2);
2535 typval_T *tv_dest = STACK_TV_BOT(-1);
2536 int status = OK;
2537
2538 // Stack contains:
2539 // -2 index
2540 // -1 dict or list
Bram Moolenaar6296d1e2022-02-17 16:30:11 +00002541 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002542 if (tv_dest->v_type == VAR_DICT)
2543 {
2544 // unlet a dict item, index must be a string
Bram Moolenaarea5c8982022-02-17 14:42:02 +00002545 if (tv_idx->v_type != VAR_STRING && tv_idx->v_type != VAR_NUMBER)
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002546 {
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002547 semsg(_(e_expected_str_but_got_str),
2548 vartype_name(VAR_STRING),
2549 vartype_name(tv_idx->v_type));
2550 status = FAIL;
2551 }
2552 else
2553 {
2554 dict_T *d = tv_dest->vval.v_dict;
Bram Moolenaarea5c8982022-02-17 14:42:02 +00002555 char_u *key;
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002556 dictitem_T *di = NULL;
2557
2558 if (d != NULL && value_check_lock(
2559 d->dv_lock, NULL, FALSE))
2560 status = FAIL;
2561 else
2562 {
Bram Moolenaarea5c8982022-02-17 14:42:02 +00002563 if (tv_idx->v_type == VAR_STRING)
2564 {
2565 key = tv_idx->vval.v_string;
2566 if (key == NULL)
2567 key = (char_u *)"";
2568 }
2569 else
2570 {
2571 key = tv_get_string(tv_idx);
2572 }
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002573 if (d != NULL)
2574 di = dict_find(d, key, (int)STRLEN(key));
2575 if (di == NULL)
2576 {
2577 // NULL dict is equivalent to empty dict
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00002578 semsg(_(e_key_not_present_in_dictionary_str), key);
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002579 status = FAIL;
2580 }
2581 else if (var_check_fixed(di->di_flags,
2582 NULL, FALSE)
2583 || var_check_ro(di->di_flags,
2584 NULL, FALSE))
2585 status = FAIL;
2586 else
Bram Moolenaaref2c3252022-11-25 16:31:51 +00002587 dictitem_remove(d, di, "unlet");
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002588 }
2589 }
2590 }
2591 else if (tv_dest->v_type == VAR_LIST)
2592 {
2593 // unlet a List item, index must be a number
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002594 if (check_for_number(tv_idx) == FAIL)
2595 {
2596 status = FAIL;
2597 }
2598 else
2599 {
2600 list_T *l = tv_dest->vval.v_list;
2601 long n = (long)tv_idx->vval.v_number;
2602
2603 if (l != NULL && value_check_lock(
2604 l->lv_lock, NULL, FALSE))
2605 status = FAIL;
2606 else
2607 {
2608 listitem_T *li = list_find(l, n);
2609
2610 if (li == NULL)
2611 {
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002612 semsg(_(e_list_index_out_of_range_nr), n);
2613 status = FAIL;
2614 }
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002615 else
2616 listitem_remove(l, li);
2617 }
2618 }
2619 }
2620 else
2621 {
2622 status = FAIL;
2623 semsg(_(e_cannot_index_str),
2624 vartype_name(tv_dest->v_type));
2625 }
2626
2627 clear_tv(tv_idx);
2628 clear_tv(tv_dest);
2629 ectx->ec_stack.ga_len -= 2;
2630
2631 return status;
2632}
2633
2634/*
2635 * Unlet a range of items in a list variable.
2636 */
2637 static int
2638execute_unletrange(isn_T *iptr, ectx_T *ectx)
2639{
2640 // Stack contains:
2641 // -3 index1
2642 // -2 index2
2643 // -1 dict or list
2644 typval_T *tv_idx1 = STACK_TV_BOT(-3);
2645 typval_T *tv_idx2 = STACK_TV_BOT(-2);
2646 typval_T *tv_dest = STACK_TV_BOT(-1);
2647 int status = OK;
2648
2649 if (tv_dest->v_type == VAR_LIST)
2650 {
2651 // indexes must be a number
2652 SOURCING_LNUM = iptr->isn_lnum;
2653 if (check_for_number(tv_idx1) == FAIL
2654 || (tv_idx2->v_type != VAR_SPECIAL
2655 && check_for_number(tv_idx2) == FAIL))
2656 {
2657 status = FAIL;
2658 }
2659 else
2660 {
2661 list_T *l = tv_dest->vval.v_list;
2662 long n1 = (long)tv_idx1->vval.v_number;
2663 long n2 = tv_idx2->v_type == VAR_SPECIAL
2664 ? 0 : (long)tv_idx2->vval.v_number;
2665 listitem_T *li;
2666
2667 li = list_find_index(l, &n1);
2668 if (li == NULL)
Bram Moolenaar6296d1e2022-02-17 16:30:11 +00002669 {
2670 semsg(_(e_list_index_out_of_range_nr),
2671 (long)tv_idx1->vval.v_number);
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002672 status = FAIL;
Bram Moolenaar6296d1e2022-02-17 16:30:11 +00002673 }
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002674 else
2675 {
2676 if (n1 < 0)
2677 n1 = list_idx_of_item(l, li);
2678 if (n2 < 0)
2679 {
2680 listitem_T *li2 = list_find(l, n2);
2681
2682 if (li2 == NULL)
Bram Moolenaar6296d1e2022-02-17 16:30:11 +00002683 {
2684 semsg(_(e_list_index_out_of_range_nr), n2);
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002685 status = FAIL;
Bram Moolenaar6296d1e2022-02-17 16:30:11 +00002686 }
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002687 else
2688 n2 = list_idx_of_item(l, li2);
2689 }
2690 if (status != FAIL
2691 && tv_idx2->v_type != VAR_SPECIAL
2692 && n2 < n1)
2693 {
2694 semsg(_(e_list_index_out_of_range_nr), n2);
2695 status = FAIL;
2696 }
Bram Moolenaar6b8c7ba2022-03-20 17:46:06 +00002697 if (status != FAIL)
2698 list_unlet_range(l, li, n1,
2699 tv_idx2->v_type != VAR_SPECIAL, n2);
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002700 }
2701 }
2702 }
2703 else
2704 {
2705 status = FAIL;
2706 SOURCING_LNUM = iptr->isn_lnum;
2707 semsg(_(e_cannot_index_str),
2708 vartype_name(tv_dest->v_type));
2709 }
2710
2711 clear_tv(tv_idx1);
2712 clear_tv(tv_idx2);
2713 clear_tv(tv_dest);
2714 ectx->ec_stack.ga_len -= 3;
2715
2716 return status;
2717}
2718
2719/*
2720 * Top of a for loop.
2721 */
2722 static int
2723execute_for(isn_T *iptr, ectx_T *ectx)
2724{
2725 typval_T *tv;
Bram Moolenaarb46c0832022-09-15 17:19:37 +01002726 int jump = FALSE;
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002727 typval_T *ltv = STACK_TV_BOT(-1);
2728 typval_T *idxtv =
Bram Moolenaarcc341812022-09-19 15:54:34 +01002729 STACK_TV_VAR(iptr->isn_arg.forloop.for_loop_idx);
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002730
2731 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
2732 return FAIL;
2733 if (ltv->v_type == VAR_LIST)
2734 {
2735 list_T *list = ltv->vval.v_list;
2736
2737 // push the next item from the list
2738 ++idxtv->vval.v_number;
2739 if (list == NULL
2740 || idxtv->vval.v_number >= list->lv_len)
2741 {
Bram Moolenaarb46c0832022-09-15 17:19:37 +01002742 jump = TRUE;
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002743 }
2744 else if (list->lv_first == &range_list_item)
2745 {
2746 // non-materialized range() list
2747 tv = STACK_TV_BOT(0);
2748 tv->v_type = VAR_NUMBER;
2749 tv->v_lock = 0;
2750 tv->vval.v_number = list_find_nr(
2751 list, idxtv->vval.v_number, NULL);
2752 ++ectx->ec_stack.ga_len;
2753 }
2754 else
2755 {
2756 listitem_T *li = list_find(list,
2757 idxtv->vval.v_number);
2758
2759 copy_tv(&li->li_tv, STACK_TV_BOT(0));
2760 ++ectx->ec_stack.ga_len;
2761 }
2762 }
2763 else if (ltv->v_type == VAR_STRING)
2764 {
2765 char_u *str = ltv->vval.v_string;
2766
2767 // The index is for the last byte of the previous
2768 // character.
2769 ++idxtv->vval.v_number;
2770 if (str == NULL || str[idxtv->vval.v_number] == NUL)
2771 {
Bram Moolenaarb46c0832022-09-15 17:19:37 +01002772 jump = TRUE;
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002773 }
2774 else
2775 {
2776 int clen = mb_ptr2len(str + idxtv->vval.v_number);
2777
2778 // Push the next character from the string.
2779 tv = STACK_TV_BOT(0);
2780 tv->v_type = VAR_STRING;
2781 tv->vval.v_string = vim_strnsave(
2782 str + idxtv->vval.v_number, clen);
2783 ++ectx->ec_stack.ga_len;
2784 idxtv->vval.v_number += clen - 1;
2785 }
2786 }
2787 else if (ltv->v_type == VAR_BLOB)
2788 {
2789 blob_T *blob = ltv->vval.v_blob;
2790
2791 // When we get here the first time make a copy of the
2792 // blob, so that the iteration still works when it is
2793 // changed.
2794 if (idxtv->vval.v_number == -1 && blob != NULL)
2795 {
2796 blob_copy(blob, ltv);
2797 blob_unref(blob);
2798 blob = ltv->vval.v_blob;
2799 }
2800
2801 // The index is for the previous byte.
2802 ++idxtv->vval.v_number;
Bram Moolenaarb46c0832022-09-15 17:19:37 +01002803 if (blob == NULL || idxtv->vval.v_number >= blob_len(blob))
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002804 {
Bram Moolenaarb46c0832022-09-15 17:19:37 +01002805 jump = TRUE;
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002806 }
2807 else
2808 {
2809 // Push the next byte from the blob.
2810 tv = STACK_TV_BOT(0);
2811 tv->v_type = VAR_NUMBER;
2812 tv->vval.v_number = blob_get(blob,
2813 idxtv->vval.v_number);
2814 ++ectx->ec_stack.ga_len;
2815 }
2816 }
2817 else
2818 {
2819 semsg(_(e_for_loop_on_str_not_supported),
2820 vartype_name(ltv->v_type));
2821 return FAIL;
2822 }
Bram Moolenaarb46c0832022-09-15 17:19:37 +01002823
2824 if (jump)
2825 {
2826 // past the end of the list/string/blob, jump to "endfor"
2827 ectx->ec_iidx = iptr->isn_arg.forloop.for_end;
2828 may_restore_cmdmod(&ectx->ec_funclocal);
2829 }
2830 else
2831 {
2832 // Store the current number of funcrefs, this may be used in
2833 // ISN_LOOPEND. The variable index is always one more than the loop
2834 // variable index.
Bram Moolenaarcc341812022-09-19 15:54:34 +01002835 tv = STACK_TV_VAR(iptr->isn_arg.forloop.for_loop_idx + 1);
Bram Moolenaarb46c0832022-09-15 17:19:37 +01002836 tv->vval.v_number = ectx->ec_funcrefs.ga_len;
2837 }
2838
2839 return OK;
2840}
2841
2842/*
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01002843 * Code for handling variables declared inside a loop and used in a closure.
2844 * This is very similar to what is done with funcstack_T. The difference is
2845 * that the funcstack_T has the scope of a function, while a loopvars_T has the
2846 * scope of the block inside a loop and each loop may have its own.
2847 */
2848
2849// Double linked list of loopvars_T in use.
2850static loopvars_T *first_loopvars = NULL;
2851
2852 static void
2853add_loopvars_to_list(loopvars_T *loopvars)
2854{
2855 // Link in list of loopvarss.
2856 if (first_loopvars != NULL)
2857 first_loopvars->lvs_prev = loopvars;
2858 loopvars->lvs_next = first_loopvars;
2859 loopvars->lvs_prev = NULL;
2860 first_loopvars = loopvars;
2861}
2862
2863 static void
2864remove_loopvars_from_list(loopvars_T *loopvars)
2865{
2866 if (loopvars->lvs_prev == NULL)
2867 first_loopvars = loopvars->lvs_next;
2868 else
2869 loopvars->lvs_prev->lvs_next = loopvars->lvs_next;
2870 if (loopvars->lvs_next != NULL)
2871 loopvars->lvs_next->lvs_prev = loopvars->lvs_prev;
2872}
2873
2874/*
Bram Moolenaarb46c0832022-09-15 17:19:37 +01002875 * End of a for or while loop: Handle any variables used by a closure.
2876 */
2877 static int
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01002878execute_endloop(isn_T *iptr, ectx_T *ectx)
Bram Moolenaarb46c0832022-09-15 17:19:37 +01002879{
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01002880 endloop_T *endloop = &iptr->isn_arg.endloop;
2881 typval_T *tv_refcount = STACK_TV_VAR(endloop->end_funcref_idx);
2882 int prev_closure_count = tv_refcount->vval.v_number;
Bram Moolenaarcc341812022-09-19 15:54:34 +01002883 int depth = endloop->end_depth;
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01002884 garray_T *gap = &ectx->ec_funcrefs;
2885 int closure_in_use = FALSE;
2886 loopvars_T *loopvars;
2887 typval_T *stack;
2888 int idx;
2889
Bram Moolenaarcc341812022-09-19 15:54:34 +01002890 // Check if any created closure is still being referenced and loopvars have
2891 // not been saved yet for the current depth.
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01002892 for (idx = prev_closure_count; idx < gap->ga_len; ++idx)
2893 {
2894 partial_T *pt = ((partial_T **)gap->ga_data)[idx];
2895
Bram Moolenaarcc341812022-09-19 15:54:34 +01002896 if (pt->pt_refcount > 1 && pt->pt_loopvars[depth] == NULL)
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01002897 {
2898 int refcount = pt->pt_refcount;
2899 int i;
2900
2901 // A Reference in a variable inside the loop doesn't count, it gets
2902 // unreferenced at the end of the loop.
2903 for (i = 0; i < endloop->end_var_count; ++i)
2904 {
2905 typval_T *stv = STACK_TV_VAR(endloop->end_var_idx + i);
2906
2907 if (stv->v_type == VAR_PARTIAL && pt == stv->vval.v_partial)
2908 --refcount;
2909 }
2910 if (refcount > 1)
2911 {
2912 closure_in_use = TRUE;
2913 break;
2914 }
2915 }
2916 }
2917
2918 // If no function reference were created since the start of the loop block
2919 // or it is no longer referenced there is nothing to do.
2920 if (!closure_in_use)
2921 return OK;
2922
2923 // A closure is using variables declared inside the loop.
2924 // Move them to the called function.
2925 loopvars = ALLOC_CLEAR_ONE(loopvars_T);
2926 if (loopvars == NULL)
2927 return FAIL;
2928
2929 loopvars->lvs_ga.ga_len = endloop->end_var_count;
2930 stack = ALLOC_CLEAR_MULT(typval_T, loopvars->lvs_ga.ga_len);
2931 loopvars->lvs_ga.ga_data = stack;
2932 if (stack == NULL)
2933 {
2934 vim_free(loopvars);
2935 return FAIL;
2936 }
2937 add_loopvars_to_list(loopvars);
2938
2939 // Move the variable values.
2940 for (idx = 0; idx < endloop->end_var_count; ++idx)
2941 {
2942 typval_T *tv = STACK_TV_VAR(endloop->end_var_idx + idx);
2943
2944 *(stack + idx) = *tv;
2945 tv->v_type = VAR_UNKNOWN;
2946 }
2947
2948 for (idx = prev_closure_count; idx < gap->ga_len; ++idx)
2949 {
2950 partial_T *pt = ((partial_T **)gap->ga_data)[idx];
2951
Bram Moolenaarcc341812022-09-19 15:54:34 +01002952 if (pt->pt_refcount > 1 && pt->pt_loopvars[depth] == NULL)
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01002953 {
2954 ++loopvars->lvs_refcount;
Bram Moolenaarcc341812022-09-19 15:54:34 +01002955 pt->pt_loopvars[depth] = loopvars;
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01002956
Bram Moolenaarcc341812022-09-19 15:54:34 +01002957 pt->pt_outer.out_loop[depth].stack = &loopvars->lvs_ga;
2958 pt->pt_outer.out_loop[depth].var_idx -=
2959 ectx->ec_frame_idx + STACK_FRAME_SIZE + endloop->end_var_idx;
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01002960 }
2961 }
Bram Moolenaarb46c0832022-09-15 17:19:37 +01002962
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002963 return OK;
2964}
2965
2966/*
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01002967 * Called when a partial is freed or its reference count goes down to one. The
2968 * loopvars may be the only reference to the partials in the local variables.
2969 * Go over all of them, the funcref and can be freed if all partials
2970 * referencing the loopvars have a reference count of one.
Bram Moolenaarcc341812022-09-19 15:54:34 +01002971 * Return TRUE if it was freed.
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01002972 */
Bram Moolenaarcc341812022-09-19 15:54:34 +01002973 int
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01002974loopvars_check_refcount(loopvars_T *loopvars)
2975{
2976 int i;
2977 garray_T *gap = &loopvars->lvs_ga;
2978 int done = 0;
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01002979 typval_T *stack = gap->ga_data;
2980
Bram Moolenaarcc341812022-09-19 15:54:34 +01002981 if (loopvars->lvs_refcount > loopvars->lvs_min_refcount)
2982 return FALSE;
2983 for (i = 0; i < gap->ga_len; ++i)
2984 {
2985 typval_T *tv = ((typval_T *)gap->ga_data) + i;
2986
2987 if (tv->v_type == VAR_PARTIAL && tv->vval.v_partial != NULL
2988 && tv->vval.v_partial->pt_refcount == 1)
2989 {
2990 int depth;
2991
2992 for (depth = 0; depth < MAX_LOOP_DEPTH; ++depth)
2993 if (tv->vval.v_partial->pt_loopvars[depth] == loopvars)
2994 ++done;
2995 }
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01002996 }
Bram Moolenaarcc341812022-09-19 15:54:34 +01002997 if (done != loopvars->lvs_min_refcount)
2998 return FALSE;
2999
3000 // All partials referencing the loopvars have a reference count of
3001 // one, thus the loopvars is no longer of use.
3002 stack = gap->ga_data;
3003 for (i = 0; i < gap->ga_len; ++i)
3004 clear_tv(stack + i);
3005 vim_free(stack);
3006 remove_loopvars_from_list(loopvars);
3007 vim_free(loopvars);
3008 return TRUE;
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01003009}
3010
3011/*
3012 * For garbage collecting: set references in all variables referenced by
3013 * all loopvars.
3014 */
3015 int
3016set_ref_in_loopvars(int copyID)
3017{
3018 loopvars_T *loopvars;
3019
3020 for (loopvars = first_loopvars; loopvars != NULL;
3021 loopvars = loopvars->lvs_next)
3022 {
3023 typval_T *stack = loopvars->lvs_ga.ga_data;
3024 int i;
3025
3026 for (i = 0; i < loopvars->lvs_ga.ga_len; ++i)
3027 if (set_ref_in_item(stack + i, copyID, NULL, NULL))
3028 return TRUE; // abort
3029 }
3030 return FALSE;
3031}
3032
3033/*
Bram Moolenaar06b77222022-01-25 15:51:56 +00003034 * Load instruction for w:/b:/g:/t: variable.
3035 * "isn_type" is used instead of "iptr->isn_type".
3036 */
3037 static int
3038load_namespace_var(ectx_T *ectx, isntype_T isn_type, isn_T *iptr)
3039{
3040 dictitem_T *di = NULL;
3041 hashtab_T *ht = NULL;
3042 char namespace;
3043
3044 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
3045 return NOTDONE;
3046 switch (isn_type)
3047 {
3048 case ISN_LOADG:
3049 ht = get_globvar_ht();
3050 namespace = 'g';
3051 break;
3052 case ISN_LOADB:
3053 ht = &curbuf->b_vars->dv_hashtab;
3054 namespace = 'b';
3055 break;
3056 case ISN_LOADW:
3057 ht = &curwin->w_vars->dv_hashtab;
3058 namespace = 'w';
3059 break;
3060 case ISN_LOADT:
3061 ht = &curtab->tp_vars->dv_hashtab;
3062 namespace = 't';
3063 break;
3064 default: // Cannot reach here
3065 return NOTDONE;
3066 }
3067 di = find_var_in_ht(ht, 0, iptr->isn_arg.string, TRUE);
3068
Bram Moolenaar06b77222022-01-25 15:51:56 +00003069 if (di == NULL)
3070 {
Bram Moolenaarfe732552022-02-22 19:39:13 +00003071 if (isn_type == ISN_LOADG)
3072 {
3073 ufunc_T *ufunc = find_func(iptr->isn_arg.string, TRUE);
3074
3075 // g:Something could be a function
3076 if (ufunc != NULL)
3077 {
3078 typval_T *tv = STACK_TV_BOT(0);
3079
3080 ++ectx->ec_stack.ga_len;
3081 tv->v_type = VAR_FUNC;
3082 tv->vval.v_string = alloc(STRLEN(iptr->isn_arg.string) + 3);
3083 if (tv->vval.v_string == NULL)
3084 return FAIL;
3085 STRCPY(tv->vval.v_string, "g:");
3086 STRCPY(tv->vval.v_string + 2, iptr->isn_arg.string);
3087 return OK;
3088 }
3089 }
Bram Moolenaar06b77222022-01-25 15:51:56 +00003090 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaarfe732552022-02-22 19:39:13 +00003091 if (vim_strchr(iptr->isn_arg.string, AUTOLOAD_CHAR) != NULL)
Bram Moolenaar06b77222022-01-25 15:51:56 +00003092 // no check if the item exists in the script but
3093 // isn't exported, it is too complicated
Bram Moolenaarfe732552022-02-22 19:39:13 +00003094 semsg(_(e_item_not_found_in_script_str), iptr->isn_arg.string);
Bram Moolenaar06b77222022-01-25 15:51:56 +00003095 else
3096 semsg(_(e_undefined_variable_char_str),
Bram Moolenaarfe732552022-02-22 19:39:13 +00003097 namespace, iptr->isn_arg.string);
Bram Moolenaar06b77222022-01-25 15:51:56 +00003098 return FAIL;
3099 }
3100 else
3101 {
3102 copy_tv(&di->di_tv, STACK_TV_BOT(0));
3103 ++ectx->ec_stack.ga_len;
3104 }
3105 return OK;
3106}
3107
Bram Moolenaard0200c82023-01-28 15:19:40 +00003108
3109 static void
3110object_required_error(typval_T *tv)
3111{
3112 garray_T type_list;
3113 ga_init2(&type_list, sizeof(type_T *), 10);
3114 type_T *type = typval2type(tv, get_copyID(), &type_list, TVTT_DO_MEMBER);
3115 char *tofree = NULL;
3116 char *typename = type_name(type, &tofree);
3117 semsg(_(e_object_required_found_str), typename);
3118 vim_free(tofree);
3119 clear_type_list(&type_list);
3120}
3121
Bram Moolenaar06b77222022-01-25 15:51:56 +00003122/*
Bram Moolenaar4c137212021-04-19 16:48:48 +02003123 * Execute instructions in execution context "ectx".
3124 * Return OK or FAIL;
3125 */
3126 static int
3127exec_instructions(ectx_T *ectx)
3128{
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003129 int ret = FAIL;
3130 int save_trylevel_at_start = ectx->ec_trylevel_at_start;
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02003131 int dict_stack_len_at_start = dict_stack.ga_len;
Bram Moolenaarf785aa12021-02-11 21:19:34 +01003132
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +02003133 // Start execution at the first instruction.
Bram Moolenaar4c137212021-04-19 16:48:48 +02003134 ectx->ec_iidx = 0;
Bram Moolenaar170fcfc2020-02-06 17:51:35 +01003135
Bram Moolenaarff652882021-05-16 15:24:49 +02003136 // Only catch exceptions in this instruction list.
3137 ectx->ec_trylevel_at_start = trylevel;
3138
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003139 for (;;)
3140 {
Bram Moolenaara7490192021-07-22 12:26:14 +02003141 static int breakcheck_count = 0; // using "static" makes it faster
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003142 isn_T *iptr;
Bram Moolenaara7490192021-07-22 12:26:14 +02003143 typval_T *tv;
Bram Moolenaar20431c92020-03-20 18:39:46 +01003144
Dominique Pelle5a9e5842021-07-24 19:32:12 +02003145 if (unlikely(++breakcheck_count >= 100))
Bram Moolenaar270d0382020-05-15 21:42:53 +02003146 {
3147 line_breakcheck();
3148 breakcheck_count = 0;
3149 }
Dominique Pelle5a9e5842021-07-24 19:32:12 +02003150 if (unlikely(got_int))
Bram Moolenaar20431c92020-03-20 18:39:46 +01003151 {
3152 // Turn CTRL-C into an exception.
3153 got_int = FALSE;
Bram Moolenaar97acfc72020-03-22 13:44:28 +01003154 if (throw_exception("Vim:Interrupt", ET_INTERRUPT, NULL) == FAIL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003155 goto theend;
Bram Moolenaar20431c92020-03-20 18:39:46 +01003156 did_throw = TRUE;
3157 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003158
Dominique Pelle5a9e5842021-07-24 19:32:12 +02003159 if (unlikely(did_emsg && msg_list != NULL && *msg_list != NULL))
Bram Moolenaara26b9702020-04-18 19:53:28 +02003160 {
3161 // Turn an error message into an exception.
3162 did_emsg = FALSE;
3163 if (throw_exception(*msg_list, ET_ERROR, NULL) == FAIL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003164 goto theend;
Bram Moolenaara26b9702020-04-18 19:53:28 +02003165 did_throw = TRUE;
3166 *msg_list = NULL;
Bram Moolenaar3ef2e412023-04-30 18:50:48 +01003167
3168 // This exception was not caught (yet).
3169 garray_T *trystack = &ectx->ec_trystack;
3170 if (trystack->ga_len > 0)
3171 {
3172 trycmd_T *trycmd = ((trycmd_T *)trystack->ga_data)
3173 + trystack->ga_len - 1;
3174 if (trycmd->tcd_frame_idx == ectx->ec_frame_idx)
3175 trycmd->tcd_caught = FALSE;
3176 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003177 }
3178
Dominique Pelle5a9e5842021-07-24 19:32:12 +02003179 if (unlikely(did_throw))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003180 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02003181 garray_T *trystack = &ectx->ec_trystack;
Bram Moolenaar20431c92020-03-20 18:39:46 +01003182 trycmd_T *trycmd = NULL;
Bram Moolenaard3d8fee2021-06-30 19:54:43 +02003183 int index = trystack->ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003184
3185 // An exception jumps to the first catch, finally, or returns from
3186 // the current function.
Bram Moolenaard3d8fee2021-06-30 19:54:43 +02003187 while (index > 0)
3188 {
3189 trycmd = ((trycmd_T *)trystack->ga_data) + index - 1;
Bram Moolenaar3ef2e412023-04-30 18:50:48 +01003190 // 1. after :try and before :catch - jump to first :catch
3191 // 2. in :catch block - jump to :finally
3192 // 3. in :catch block and no finally - jump to :endtry
3193 if (!trycmd->tcd_in_catch || trycmd->tcd_finally_idx != 0
3194 || trycmd->tcd_frame_idx == ectx->ec_frame_idx)
Bram Moolenaard3d8fee2021-06-30 19:54:43 +02003195 break;
3196 // In the catch and finally block of this try we have to go up
3197 // one level.
3198 --index;
3199 trycmd = NULL;
3200 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02003201 if (trycmd != NULL && trycmd->tcd_frame_idx == ectx->ec_frame_idx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003202 {
Bram Moolenaar834193a2021-06-30 20:39:15 +02003203 if (trycmd->tcd_in_catch)
3204 {
Bram Moolenaar3ef2e412023-04-30 18:50:48 +01003205 if (trycmd->tcd_finally_idx > 0)
3206 {
3207 // exception inside ":catch", jump to ":finally" once
3208 ectx->ec_iidx = trycmd->tcd_finally_idx;
3209 trycmd->tcd_finally_idx = 0;
3210 }
3211 else
3212 {
3213 // exception inside ":catch" or ":finally", jump to
3214 // ":endtry"
3215 ectx->ec_iidx = trycmd->tcd_endtry_idx;
3216 }
Bram Moolenaar834193a2021-06-30 20:39:15 +02003217 }
3218 else
Bram Moolenaar3ef2e412023-04-30 18:50:48 +01003219 {
Bram Moolenaar834193a2021-06-30 20:39:15 +02003220 // jump to first ":catch"
3221 ectx->ec_iidx = trycmd->tcd_catch_idx;
Bram Moolenaar3ef2e412023-04-30 18:50:48 +01003222 trycmd->tcd_in_catch = TRUE;
3223 }
Bram Moolenaard3d8fee2021-06-30 19:54:43 +02003224 did_throw = FALSE; // don't come back here until :endtry
3225 trycmd->tcd_did_throw = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003226 }
3227 else
3228 {
Bram Moolenaar3ef2e412023-04-30 18:50:48 +01003229 // Not inside try or need to return from current function.
Bram Moolenaarcdd70f02020-08-13 21:40:18 +02003230 // Push a dummy return value.
Bram Moolenaar35578162021-08-02 19:10:38 +02003231 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003232 goto theend;
Bram Moolenaarcdd70f02020-08-13 21:40:18 +02003233 tv = STACK_TV_BOT(0);
3234 tv->v_type = VAR_NUMBER;
3235 tv->vval.v_number = 0;
Bram Moolenaar4c137212021-04-19 16:48:48 +02003236 ++ectx->ec_stack.ga_len;
3237 if (ectx->ec_frame_idx == ectx->ec_initial_frame_idx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003238 {
Bram Moolenaarcdd70f02020-08-13 21:40:18 +02003239 // At the toplevel we are done.
Bram Moolenaar257cc5e2020-02-19 17:06:11 +01003240 need_rethrow = TRUE;
Bram Moolenaar4c137212021-04-19 16:48:48 +02003241 if (handle_closure_in_use(ectx, FALSE) == FAIL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003242 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003243 goto done;
3244 }
3245
Bram Moolenaar4c137212021-04-19 16:48:48 +02003246 if (func_return(ectx) == FAIL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003247 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003248 }
3249 continue;
3250 }
3251
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00003252 /*
3253 * Big switch on the instruction. Most compilers will be turning this
3254 * into an efficient lookup table, since the "case" values are an enum
3255 * with sequential numbers. It may look ugly, but it should be the
3256 * most efficient way.
3257 */
Bram Moolenaar4c137212021-04-19 16:48:48 +02003258 iptr = &ectx->ec_instr[ectx->ec_iidx++];
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003259 switch (iptr->isn_type)
3260 {
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00003261 // Constructor, first instruction in a new() method.
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003262 case ISN_CONSTRUCT:
3263 // "this" is always the local variable at index zero
3264 tv = STACK_TV_VAR(0);
3265 tv->v_type = VAR_OBJECT;
3266 tv->vval.v_object = alloc_clear(
3267 iptr->isn_arg.construct.construct_size);
3268 tv->vval.v_object->obj_class =
3269 iptr->isn_arg.construct.construct_class;
Bram Moolenaard28d7b92022-12-08 20:42:00 +00003270 ++tv->vval.v_object->obj_class->class_refcount;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003271 tv->vval.v_object->obj_refcount = 1;
Bram Moolenaard28d7b92022-12-08 20:42:00 +00003272 object_created(tv->vval.v_object);
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01003273
3274 // When creating an enum value object, initialize the name and
3275 // ordinal object variables.
3276 class_T *en = tv->vval.v_object->obj_class;
3277 if (IS_ENUM(en))
3278 enum_set_internal_obj_vars(en, tv->vval.v_object);
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003279 break;
3280
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003281 // execute Ex command line
3282 case ISN_EXEC:
Ernie Raelee865f32023-09-29 19:53:55 +02003283 if (exec_command(iptr, iptr->isn_arg.string) == FAIL)
Bram Moolenaaraacc9662021-08-13 19:40:51 +02003284 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003285 break;
3286
Bram Moolenaar20677332021-06-06 17:02:53 +02003287 // execute Ex command line split at NL characters.
3288 case ISN_EXEC_SPLIT:
3289 {
3290 source_cookie_T cookie;
Bram Moolenaar518df272021-06-06 17:34:13 +02003291 char_u *line;
Bram Moolenaar20677332021-06-06 17:02:53 +02003292
3293 SOURCING_LNUM = iptr->isn_lnum;
3294 CLEAR_FIELD(cookie);
3295 cookie.sourcing_lnum = iptr->isn_lnum - 1;
3296 cookie.nextline = iptr->isn_arg.string;
Bram Moolenaar518df272021-06-06 17:34:13 +02003297 line = get_split_sourceline(0, &cookie, 0, 0);
3298 if (do_cmdline(line,
Bram Moolenaar20677332021-06-06 17:02:53 +02003299 get_split_sourceline, &cookie,
3300 DOCMD_VERBOSE|DOCMD_NOWAIT|DOCMD_KEYTYPED)
3301 == FAIL
3302 || did_emsg)
Bram Moolenaar518df272021-06-06 17:34:13 +02003303 {
3304 vim_free(line);
Bram Moolenaar20677332021-06-06 17:02:53 +02003305 goto on_error;
Bram Moolenaar518df272021-06-06 17:34:13 +02003306 }
3307 vim_free(line);
Bram Moolenaar20677332021-06-06 17:02:53 +02003308 }
3309 break;
3310
Bram Moolenaare4eed8c2021-12-01 15:22:56 +00003311 // execute Ex command line that is only a range
3312 case ISN_EXECRANGE:
3313 {
3314 exarg_T ea;
3315 char *error = NULL;
3316
3317 CLEAR_FIELD(ea);
3318 ea.cmdidx = CMD_SIZE;
3319 ea.addr_type = ADDR_LINES;
3320 ea.cmd = iptr->isn_arg.string;
Bram Moolenaar0c7f2612022-02-17 19:44:07 +00003321 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaare4eed8c2021-12-01 15:22:56 +00003322 parse_cmd_address(&ea, &error, FALSE);
Bram Moolenaar01a4dcb2021-12-04 13:15:10 +00003323 if (ea.cmd == NULL)
3324 goto on_error;
Bram Moolenaar0c7f2612022-02-17 19:44:07 +00003325 // error is always NULL when using ADDR_LINES
3326 error = ex_range_without_command(&ea);
Bram Moolenaare4eed8c2021-12-01 15:22:56 +00003327 if (error != NULL)
3328 {
Bram Moolenaare4eed8c2021-12-01 15:22:56 +00003329 emsg(error);
3330 goto on_error;
3331 }
3332 }
3333 break;
3334
Bram Moolenaar3b1373b2021-05-17 00:01:42 +02003335 // Evaluate an expression with legacy syntax, push it onto the
3336 // stack.
3337 case ISN_LEGACY_EVAL:
3338 {
3339 char_u *arg = iptr->isn_arg.string;
3340 int res;
3341 int save_flags = cmdmod.cmod_flags;
3342
Bram Moolenaar35578162021-08-02 19:10:38 +02003343 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003344 goto theend;
Bram Moolenaar3b1373b2021-05-17 00:01:42 +02003345 tv = STACK_TV_BOT(0);
3346 init_tv(tv);
3347 cmdmod.cmod_flags |= CMOD_LEGACY;
3348 res = eval0(arg, tv, NULL, &EVALARG_EVALUATE);
3349 cmdmod.cmod_flags = save_flags;
3350 if (res == FAIL)
3351 goto on_error;
3352 ++ectx->ec_stack.ga_len;
3353 }
3354 break;
3355
Bram Moolenaarf18332f2021-05-07 17:55:55 +02003356 // push typeval VAR_INSTR with instructions to be executed
3357 case ISN_INSTR:
3358 {
Bram Moolenaar35578162021-08-02 19:10:38 +02003359 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003360 goto theend;
Bram Moolenaarf18332f2021-05-07 17:55:55 +02003361 tv = STACK_TV_BOT(0);
3362 tv->vval.v_instr = ALLOC_ONE(instr_T);
3363 if (tv->vval.v_instr == NULL)
3364 goto on_error;
3365 ++ectx->ec_stack.ga_len;
3366
3367 tv->v_type = VAR_INSTR;
3368 tv->vval.v_instr->instr_ectx = ectx;
3369 tv->vval.v_instr->instr_instr = iptr->isn_arg.instr;
3370 }
3371 break;
3372
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003373 case ISN_SOURCE:
3374 {
Bram Moolenaar89445512022-04-14 12:58:23 +01003375 int notused;
LemonBoy77142312022-04-15 20:50:46 +01003376
Bram Moolenaar89445512022-04-14 12:58:23 +01003377 SOURCING_LNUM = iptr->isn_lnum;
3378 if (may_load_script((int)iptr->isn_arg.number, &notused)
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003379 == FAIL)
Bram Moolenaar89445512022-04-14 12:58:23 +01003380 goto on_error;
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003381 }
3382 break;
3383
Bram Moolenaar4c137212021-04-19 16:48:48 +02003384 // execute :substitute with an expression
3385 case ISN_SUBSTITUTE:
3386 {
3387 subs_T *subs = &iptr->isn_arg.subs;
3388 source_cookie_T cookie;
3389 struct subs_expr_S *save_instr = substitute_instr;
3390 struct subs_expr_S subs_instr;
3391 int res;
3392
3393 subs_instr.subs_ectx = ectx;
3394 subs_instr.subs_instr = subs->subs_instr;
3395 subs_instr.subs_status = OK;
3396 substitute_instr = &subs_instr;
3397
3398 SOURCING_LNUM = iptr->isn_lnum;
3399 // This is very much like ISN_EXEC
3400 CLEAR_FIELD(cookie);
3401 cookie.sourcing_lnum = iptr->isn_lnum - 1;
3402 res = do_cmdline(subs->subs_cmd,
3403 getsourceline, &cookie,
3404 DOCMD_VERBOSE|DOCMD_NOWAIT|DOCMD_KEYTYPED);
3405 substitute_instr = save_instr;
3406
3407 if (res == FAIL || did_emsg
3408 || subs_instr.subs_status == FAIL)
3409 goto on_error;
3410 }
3411 break;
3412
3413 case ISN_FINISH:
3414 goto done;
3415
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02003416 case ISN_REDIRSTART:
3417 // create a dummy entry for var_redir_str()
3418 if (alloc_redir_lval() == FAIL)
3419 goto on_error;
3420
3421 // The output is stored in growarray "redir_ga" until
3422 // redirection ends.
3423 init_redir_ga();
3424 redir_vname = 1;
3425 break;
3426
3427 case ISN_REDIREND:
3428 {
3429 char_u *res = get_clear_redir_ga();
3430
3431 // End redirection, put redirected text on the stack.
3432 clear_redir_lval();
3433 redir_vname = 0;
3434
Bram Moolenaar35578162021-08-02 19:10:38 +02003435 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02003436 {
3437 vim_free(res);
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003438 goto theend;
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02003439 }
3440 tv = STACK_TV_BOT(0);
3441 tv->v_type = VAR_STRING;
3442 tv->vval.v_string = res;
3443 ++ectx->ec_stack.ga_len;
3444 }
3445 break;
3446
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02003447 case ISN_CEXPR_AUCMD:
Bram Moolenaarb7c97812021-05-05 22:51:39 +02003448#ifdef FEAT_QUICKFIX
Bram Moolenaar397a87a2022-03-20 21:14:15 +00003449 force_abort = TRUE;
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02003450 if (trigger_cexpr_autocmd(iptr->isn_arg.number) == FAIL)
3451 goto on_error;
Bram Moolenaar397a87a2022-03-20 21:14:15 +00003452 force_abort = FALSE;
Bram Moolenaarb7c97812021-05-05 22:51:39 +02003453#endif
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02003454 break;
3455
3456 case ISN_CEXPR_CORE:
Bram Moolenaarb7c97812021-05-05 22:51:39 +02003457#ifdef FEAT_QUICKFIX
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02003458 {
3459 exarg_T ea;
3460 int res;
3461
3462 CLEAR_FIELD(ea);
3463 ea.cmdidx = iptr->isn_arg.cexpr.cexpr_ref->cer_cmdidx;
3464 ea.forceit = iptr->isn_arg.cexpr.cexpr_ref->cer_forceit;
3465 ea.cmdlinep = &iptr->isn_arg.cexpr.cexpr_ref->cer_cmdline;
3466 --ectx->ec_stack.ga_len;
3467 tv = STACK_TV_BOT(0);
Bram Moolenaarbd683e32022-07-18 17:49:03 +01003468 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02003469 res = cexpr_core(&ea, tv);
3470 clear_tv(tv);
3471 if (res == FAIL)
3472 goto on_error;
3473 }
Bram Moolenaarb7c97812021-05-05 22:51:39 +02003474#endif
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02003475 break;
3476
Bram Moolenaarcfe435d2020-04-25 20:02:55 +02003477 // execute Ex command from pieces on the stack
3478 case ISN_EXECCONCAT:
3479 {
3480 int count = iptr->isn_arg.number;
Bram Moolenaar7f6f56f2020-04-30 20:21:43 +02003481 size_t len = 0;
Bram Moolenaarcfe435d2020-04-25 20:02:55 +02003482 int pass;
3483 int i;
3484 char_u *cmd = NULL;
3485 char_u *str;
3486
3487 for (pass = 1; pass <= 2; ++pass)
3488 {
3489 for (i = 0; i < count; ++i)
3490 {
3491 tv = STACK_TV_BOT(i - count);
3492 str = tv->vval.v_string;
3493 if (str != NULL && *str != NUL)
3494 {
3495 if (pass == 2)
3496 STRCPY(cmd + len, str);
3497 len += STRLEN(str);
3498 }
3499 if (pass == 2)
3500 clear_tv(tv);
3501 }
3502 if (pass == 1)
3503 {
3504 cmd = alloc(len + 1);
Dominique Pelle5a9e5842021-07-24 19:32:12 +02003505 if (unlikely(cmd == NULL))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003506 goto theend;
Bram Moolenaarcfe435d2020-04-25 20:02:55 +02003507 len = 0;
3508 }
3509 }
3510
Bram Moolenaar6378c4f2020-04-26 13:50:41 +02003511 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaarcfe435d2020-04-25 20:02:55 +02003512 do_cmdline_cmd(cmd);
3513 vim_free(cmd);
3514 }
3515 break;
3516
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003517 // execute :echo {string} ...
3518 case ISN_ECHO:
3519 {
3520 int count = iptr->isn_arg.echo.echo_count;
3521 int atstart = TRUE;
3522 int needclr = TRUE;
Bram Moolenaar4c137212021-04-19 16:48:48 +02003523 int idx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003524
3525 for (idx = 0; idx < count; ++idx)
3526 {
3527 tv = STACK_TV_BOT(idx - count);
3528 echo_one(tv, iptr->isn_arg.echo.echo_with_white,
3529 &atstart, &needclr);
3530 clear_tv(tv);
3531 }
Bram Moolenaare0807ea2020-02-20 22:18:06 +01003532 if (needclr)
3533 msg_clr_eos();
Bram Moolenaar4c137212021-04-19 16:48:48 +02003534 ectx->ec_stack.ga_len -= count;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003535 }
3536 break;
3537
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +02003538 // :execute {string} ...
3539 // :echomsg {string} ...
Bram Moolenaar7d7ad7b2022-09-01 16:00:53 +01003540 // :echowindow {string} ...
Bram Moolenaar7de62622021-08-07 15:05:47 +02003541 // :echoconsole {string} ...
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +02003542 // :echoerr {string} ...
Bram Moolenaarad39c092020-02-26 18:23:43 +01003543 case ISN_EXECUTE:
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +02003544 case ISN_ECHOMSG:
Bram Moolenaar7d7ad7b2022-09-01 16:00:53 +01003545 case ISN_ECHOWINDOW:
Bram Moolenaar7de62622021-08-07 15:05:47 +02003546 case ISN_ECHOCONSOLE:
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +02003547 case ISN_ECHOERR:
Bram Moolenaarad39c092020-02-26 18:23:43 +01003548 {
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003549 int count;
Bram Moolenaarad39c092020-02-26 18:23:43 +01003550 garray_T ga;
3551 char_u buf[NUMBUFLEN];
3552 char_u *p;
3553 int len;
3554 int failed = FALSE;
Bram Moolenaar4c137212021-04-19 16:48:48 +02003555 int idx;
Bram Moolenaarad39c092020-02-26 18:23:43 +01003556
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003557 if (iptr->isn_type == ISN_ECHOWINDOW)
3558 count = iptr->isn_arg.echowin.ewin_count;
3559 else
3560 count = iptr->isn_arg.number;
Bram Moolenaarad39c092020-02-26 18:23:43 +01003561 ga_init2(&ga, 1, 80);
3562 for (idx = 0; idx < count; ++idx)
3563 {
3564 tv = STACK_TV_BOT(idx - count);
Bram Moolenaare5abf7a2020-08-16 18:29:35 +02003565 if (iptr->isn_type == ISN_EXECUTE)
Bram Moolenaarad39c092020-02-26 18:23:43 +01003566 {
Bram Moolenaare5abf7a2020-08-16 18:29:35 +02003567 if (tv->v_type == VAR_CHANNEL
3568 || tv->v_type == VAR_JOB)
3569 {
3570 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar68db9962021-05-09 23:19:22 +02003571 semsg(_(e_using_invalid_value_as_string_str),
3572 vartype_name(tv->v_type));
Bram Moolenaare5abf7a2020-08-16 18:29:35 +02003573 break;
3574 }
3575 else
3576 p = tv_get_string_buf(tv, buf);
Bram Moolenaarad39c092020-02-26 18:23:43 +01003577 }
3578 else
Ernie Raelbe828252024-07-26 18:37:02 +02003579 {
3580 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaare5abf7a2020-08-16 18:29:35 +02003581 p = tv_stringify(tv, buf);
Ernie Raelbe828252024-07-26 18:37:02 +02003582 }
Bram Moolenaarad39c092020-02-26 18:23:43 +01003583
3584 len = (int)STRLEN(p);
Bram Moolenaar35578162021-08-02 19:10:38 +02003585 if (GA_GROW_FAILS(&ga, len + 2))
Bram Moolenaarad39c092020-02-26 18:23:43 +01003586 failed = TRUE;
3587 else
3588 {
3589 if (ga.ga_len > 0)
3590 ((char_u *)(ga.ga_data))[ga.ga_len++] = ' ';
3591 STRCPY((char_u *)(ga.ga_data) + ga.ga_len, p);
3592 ga.ga_len += len;
3593 }
3594 clear_tv(tv);
3595 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02003596 ectx->ec_stack.ga_len -= count;
Bram Moolenaare5abf7a2020-08-16 18:29:35 +02003597 if (failed)
Bram Moolenaarc71ee822020-11-21 11:45:50 +01003598 {
3599 ga_clear(&ga);
Bram Moolenaare5abf7a2020-08-16 18:29:35 +02003600 goto on_error;
Bram Moolenaarc71ee822020-11-21 11:45:50 +01003601 }
Bram Moolenaarad39c092020-02-26 18:23:43 +01003602
Bram Moolenaare5abf7a2020-08-16 18:29:35 +02003603 if (ga.ga_data != NULL)
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +02003604 {
3605 if (iptr->isn_type == ISN_EXECUTE)
Bram Moolenaar430deb12020-08-23 16:29:11 +02003606 {
3607 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +02003608 do_cmdline_cmd((char_u *)ga.ga_data);
Bram Moolenaareeece9e2020-11-20 19:26:48 +01003609 if (did_emsg)
Bram Moolenaarc71ee822020-11-21 11:45:50 +01003610 {
3611 ga_clear(&ga);
Bram Moolenaareeece9e2020-11-20 19:26:48 +01003612 goto on_error;
Bram Moolenaarc71ee822020-11-21 11:45:50 +01003613 }
Bram Moolenaar430deb12020-08-23 16:29:11 +02003614 }
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +02003615 else
3616 {
3617 msg_sb_eol();
3618 if (iptr->isn_type == ISN_ECHOMSG)
3619 {
3620 msg_attr(ga.ga_data, echo_attr);
3621 out_flush();
3622 }
Bram Moolenaar7d7ad7b2022-09-01 16:00:53 +01003623#ifdef HAS_MESSAGE_WINDOW
3624 else if (iptr->isn_type == ISN_ECHOWINDOW)
3625 {
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003626 start_echowindow(
3627 iptr->isn_arg.echowin.ewin_time);
Bram Moolenaar7d7ad7b2022-09-01 16:00:53 +01003628 msg_attr(ga.ga_data, echo_attr);
3629 end_echowindow();
3630 }
3631#endif
Bram Moolenaar7de62622021-08-07 15:05:47 +02003632 else if (iptr->isn_type == ISN_ECHOCONSOLE)
3633 {
3634 ui_write(ga.ga_data, (int)STRLEN(ga.ga_data),
3635 TRUE);
3636 ui_write((char_u *)"\r\n", 2, TRUE);
3637 }
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +02003638 else
3639 {
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +02003640 SOURCING_LNUM = iptr->isn_lnum;
3641 emsg(ga.ga_data);
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +02003642 }
3643 }
3644 }
Bram Moolenaarad39c092020-02-26 18:23:43 +01003645 ga_clear(&ga);
3646 }
3647 break;
3648
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003649 // load local variable or argument
3650 case ISN_LOAD:
Bram Moolenaar35578162021-08-02 19:10:38 +02003651 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003652 goto theend;
Bram Moolenaar2ed57ac2023-04-01 22:05:38 +01003653 tv = STACK_TV_VAR(iptr->isn_arg.number);
3654 if (tv->v_type == VAR_UNKNOWN)
3655 {
3656 // missing argument or default value v:none
3657 STACK_TV_BOT(0)->v_type = VAR_SPECIAL;
3658 STACK_TV_BOT(0)->vval.v_number = VVAL_NONE;
3659 }
3660 else
3661 copy_tv(tv, STACK_TV_BOT(0));
Bram Moolenaar4c137212021-04-19 16:48:48 +02003662 ++ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003663 break;
3664
3665 // load v: variable
3666 case ISN_LOADV:
Bram Moolenaar35578162021-08-02 19:10:38 +02003667 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003668 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003669 copy_tv(get_vim_var_tv(iptr->isn_arg.number), STACK_TV_BOT(0));
Bram Moolenaar4c137212021-04-19 16:48:48 +02003670 ++ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003671 break;
3672
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01003673 // load s: variable in Vim9 script
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003674 case ISN_LOADSCRIPT:
3675 {
Bram Moolenaar4aab88d2020-12-24 21:56:41 +01003676 scriptref_T *sref = iptr->isn_arg.script.scriptref;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003677 svar_T *sv;
3678
Bram Moolenaar6db660b2021-08-01 14:08:54 +02003679 sv = get_script_svar(sref, ectx->ec_dfunc_idx);
Bram Moolenaar07a65d22020-12-26 20:09:15 +01003680 if (sv == NULL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003681 goto theend;
Bram Moolenaar859cc212022-03-28 15:22:35 +01003682 allocate_if_null(sv);
Bram Moolenaar35578162021-08-02 19:10:38 +02003683 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003684 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003685 copy_tv(sv->sv_tv, STACK_TV_BOT(0));
Bram Moolenaar4c137212021-04-19 16:48:48 +02003686 ++ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003687 }
3688 break;
3689
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003690 // load s: variable in old script or autoload import
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003691 case ISN_LOADS:
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003692 case ISN_LOADEXPORT:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003693 {
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003694 int sid = iptr->isn_arg.loadstore.ls_sid;
3695 hashtab_T *ht = &SCRIPT_VARS(sid);
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01003696 char_u *name = iptr->isn_arg.loadstore.ls_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003697 dictitem_T *di = find_var_in_ht(ht, 0, name, TRUE);
Bram Moolenaar0bbf7222020-02-19 22:31:48 +01003698
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003699 if (di == NULL)
3700 {
Bram Moolenaar7517ffd2020-08-14 18:35:07 +02003701 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003702 semsg(_(e_undefined_variable_str), name);
Bram Moolenaarf0b9f432020-07-17 23:03:17 +02003703 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003704 }
3705 else
3706 {
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003707 if (iptr->isn_type == ISN_LOADEXPORT)
3708 {
3709 int idx = get_script_item_idx(sid, name, 0,
3710 NULL, NULL);
3711 svar_T *sv;
3712
3713 if (idx >= 0)
3714 {
3715 sv = ((svar_T *)SCRIPT_ITEM(sid)
3716 ->sn_var_vals.ga_data) + idx;
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003717 if ((sv->sv_flags & SVFLAG_EXPORTED) == 0)
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003718 {
3719 SOURCING_LNUM = iptr->isn_lnum;
3720 semsg(_(e_item_not_exported_in_script_str),
3721 name);
3722 goto on_error;
3723 }
3724 }
3725 }
Bram Moolenaar35578162021-08-02 19:10:38 +02003726 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003727 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003728 copy_tv(&di->di_tv, STACK_TV_BOT(0));
Bram Moolenaar4c137212021-04-19 16:48:48 +02003729 ++ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003730 }
3731 }
3732 break;
3733
Bram Moolenaard3aac292020-04-19 14:32:17 +02003734 // load g:/b:/w:/t: variable
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003735 case ISN_LOADG:
Bram Moolenaard3aac292020-04-19 14:32:17 +02003736 case ISN_LOADB:
3737 case ISN_LOADW:
3738 case ISN_LOADT:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003739 {
Bram Moolenaar06b77222022-01-25 15:51:56 +00003740 int res = load_namespace_var(ectx, iptr->isn_type, iptr);
Bram Moolenaar2f8ce0a2020-07-19 19:47:35 +02003741
Bram Moolenaar06b77222022-01-25 15:51:56 +00003742 if (res == NOTDONE)
Bram Moolenaarcbbc48f2022-01-18 12:58:28 +00003743 goto theend;
Bram Moolenaar06b77222022-01-25 15:51:56 +00003744 if (res == FAIL)
Bram Moolenaarf0b9f432020-07-17 23:03:17 +02003745 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003746 }
Bram Moolenaar06b77222022-01-25 15:51:56 +00003747
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003748 break;
3749
Bram Moolenaar03290b82020-12-19 16:30:44 +01003750 // load autoload variable
3751 case ISN_LOADAUTO:
3752 {
3753 char_u *name = iptr->isn_arg.string;
3754
Bram Moolenaar35578162021-08-02 19:10:38 +02003755 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003756 goto theend;
Bram Moolenaar03290b82020-12-19 16:30:44 +01003757 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003758 if (eval_variable(name, (int)STRLEN(name), 0,
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01003759 STACK_TV_BOT(0), NULL, EVAL_VAR_VERBOSE) == FAIL)
Bram Moolenaar03290b82020-12-19 16:30:44 +01003760 goto on_error;
Bram Moolenaar4c137212021-04-19 16:48:48 +02003761 ++ectx->ec_stack.ga_len;
Bram Moolenaar03290b82020-12-19 16:30:44 +01003762 }
3763 break;
3764
Bram Moolenaar2f8ce0a2020-07-19 19:47:35 +02003765 // load g:/b:/w:/t: namespace
3766 case ISN_LOADGDICT:
3767 case ISN_LOADBDICT:
3768 case ISN_LOADWDICT:
3769 case ISN_LOADTDICT:
3770 {
3771 dict_T *d = NULL;
3772
3773 switch (iptr->isn_type)
3774 {
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003775 case ISN_LOADGDICT: d = get_globvar_dict(); break;
3776 case ISN_LOADBDICT: d = curbuf->b_vars; break;
3777 case ISN_LOADWDICT: d = curwin->w_vars; break;
3778 case ISN_LOADTDICT: d = curtab->tp_vars; break;
Bram Moolenaar2f8ce0a2020-07-19 19:47:35 +02003779 default: // Cannot reach here
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003780 goto theend;
Bram Moolenaar2f8ce0a2020-07-19 19:47:35 +02003781 }
Bram Moolenaar35578162021-08-02 19:10:38 +02003782 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003783 goto theend;
Bram Moolenaar2f8ce0a2020-07-19 19:47:35 +02003784 tv = STACK_TV_BOT(0);
3785 tv->v_type = VAR_DICT;
3786 tv->v_lock = 0;
3787 tv->vval.v_dict = d;
Bram Moolenaar1bd3cb22021-02-24 12:27:31 +01003788 ++d->dv_refcount;
Bram Moolenaar4c137212021-04-19 16:48:48 +02003789 ++ectx->ec_stack.ga_len;
Bram Moolenaar2f8ce0a2020-07-19 19:47:35 +02003790 }
3791 break;
3792
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003793 // load &option
3794 case ISN_LOADOPT:
3795 {
3796 typval_T optval;
3797 char_u *name = iptr->isn_arg.string;
3798
Bram Moolenaara8c17702020-04-01 21:17:24 +02003799 // This is not expected to fail, name is checked during
3800 // compilation: don't set SOURCING_LNUM.
Bram Moolenaar35578162021-08-02 19:10:38 +02003801 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003802 goto theend;
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02003803 if (eval_option(&name, &optval, TRUE) == FAIL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003804 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003805 *STACK_TV_BOT(0) = optval;
Bram Moolenaar4c137212021-04-19 16:48:48 +02003806 ++ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003807 }
3808 break;
3809
3810 // load $ENV
3811 case ISN_LOADENV:
3812 {
3813 typval_T optval;
3814 char_u *name = iptr->isn_arg.string;
3815
Bram Moolenaar35578162021-08-02 19:10:38 +02003816 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003817 goto theend;
Bram Moolenaar0bbf7222020-02-19 22:31:48 +01003818 // name is always valid, checked when compiling
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02003819 (void)eval_env_var(&name, &optval, TRUE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003820 *STACK_TV_BOT(0) = optval;
Bram Moolenaar4c137212021-04-19 16:48:48 +02003821 ++ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003822 }
3823 break;
3824
3825 // load @register
3826 case ISN_LOADREG:
Bram Moolenaar35578162021-08-02 19:10:38 +02003827 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003828 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003829 tv = STACK_TV_BOT(0);
3830 tv->v_type = VAR_STRING;
Bram Moolenaar2f8ce0a2020-07-19 19:47:35 +02003831 tv->v_lock = 0;
Bram Moolenaar1e021e62020-10-16 20:25:23 +02003832 // This may result in NULL, which should be equivalent to an
3833 // empty string.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003834 tv->vval.v_string = get_reg_contents(
3835 iptr->isn_arg.number, GREG_EXPR_SRC);
Bram Moolenaar4c137212021-04-19 16:48:48 +02003836 ++ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003837 break;
3838
3839 // store local variable
3840 case ISN_STORE:
Bram Moolenaar4c137212021-04-19 16:48:48 +02003841 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003842 tv = STACK_TV_VAR(iptr->isn_arg.number);
Ernie Rael9ed53752023-12-11 17:40:46 +01003843 if (check_typval_is_value(STACK_TV_BOT(0)) == FAIL)
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02003844 {
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02003845 clear_tv(STACK_TV_BOT(0));
3846 goto on_error;
3847 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003848 clear_tv(tv);
3849 *tv = *STACK_TV_BOT(0);
3850 break;
3851
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003852 // store s: variable in old script or autoload import
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01003853 case ISN_STORES:
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003854 case ISN_STOREEXPORT:
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01003855 {
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003856 int sid = iptr->isn_arg.loadstore.ls_sid;
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01003857 char_u *name = iptr->isn_arg.loadstore.ls_name;
Ernie Rael3f821d62024-04-24 20:07:50 +02003858 dictitem_T *di = NULL;
3859 // First check for a variable from an exported autoload
3860 // with an autoload_prefix; it would be in globals.
3861 if (iptr->isn_type == ISN_STOREEXPORT)
3862 di = find_var_autoload_prefix(name, sid, NULL, NULL);
3863 // Then look for a variable in the script's variables.
3864 if (di == NULL)
3865 {
3866 hashtab_T *ht = &SCRIPT_VARS(sid);
3867 di = find_var_in_ht(ht, 0, STRNCMP("s:", name, 2) == 0
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003868 ? name + 2 : name, TRUE);
Ernie Rael3f821d62024-04-24 20:07:50 +02003869 }
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01003870
Bram Moolenaar4c137212021-04-19 16:48:48 +02003871 --ectx->ec_stack.ga_len;
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003872 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar0bbf7222020-02-19 22:31:48 +01003873 if (di == NULL)
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003874 {
3875 if (iptr->isn_type == ISN_STOREEXPORT)
3876 {
3877 semsg(_(e_undefined_variable_str), name);
Bram Moolenaard1d26842022-03-31 10:13:47 +01003878 clear_tv(STACK_TV_BOT(0));
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003879 goto on_error;
3880 }
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003881 store_var(name, STACK_TV_BOT(0));
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003882 }
Bram Moolenaar0bbf7222020-02-19 22:31:48 +01003883 else
3884 {
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003885 if (iptr->isn_type == ISN_STOREEXPORT)
3886 {
3887 int idx = get_script_item_idx(sid, name, 0,
3888 NULL, NULL);
3889
Bram Moolenaar06651632022-04-27 17:54:25 +01003890 // can this ever fail?
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003891 if (idx >= 0)
3892 {
3893 svar_T *sv = ((svar_T *)SCRIPT_ITEM(sid)
3894 ->sn_var_vals.ga_data) + idx;
3895
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003896 if ((sv->sv_flags & SVFLAG_EXPORTED) == 0)
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003897 {
3898 semsg(_(e_item_not_exported_in_script_str),
3899 name);
Bram Moolenaard1d26842022-03-31 10:13:47 +01003900 clear_tv(STACK_TV_BOT(0));
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003901 goto on_error;
3902 }
3903 }
3904 }
Bram Moolenaardcf29ac2021-04-02 14:44:02 +02003905 if (var_check_permission(di, name) == FAIL)
Bram Moolenaar6e50ec22021-04-03 19:32:44 +02003906 {
3907 clear_tv(STACK_TV_BOT(0));
Bram Moolenaardcf29ac2021-04-02 14:44:02 +02003908 goto on_error;
Bram Moolenaar6e50ec22021-04-03 19:32:44 +02003909 }
Bram Moolenaar0bbf7222020-02-19 22:31:48 +01003910 clear_tv(&di->di_tv);
3911 di->di_tv = *STACK_TV_BOT(0);
3912 }
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01003913 }
3914 break;
3915
3916 // store script-local variable in Vim9 script
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003917 case ISN_STORESCRIPT:
3918 {
Bram Moolenaar07a65d22020-12-26 20:09:15 +01003919 scriptref_T *sref = iptr->isn_arg.script.scriptref;
3920 svar_T *sv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003921
Bram Moolenaar6db660b2021-08-01 14:08:54 +02003922 sv = get_script_svar(sref, ectx->ec_dfunc_idx);
Bram Moolenaar07a65d22020-12-26 20:09:15 +01003923 if (sv == NULL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003924 goto theend;
Bram Moolenaar4c137212021-04-19 16:48:48 +02003925 --ectx->ec_stack.ga_len;
Bram Moolenaarf5906aa2021-04-02 14:35:15 +02003926
3927 // "const" and "final" are checked at compile time, locking
3928 // the value needs to be checked here.
3929 SOURCING_LNUM = iptr->isn_lnum;
3930 if (value_check_lock(sv->sv_tv->v_lock, sv->sv_name, FALSE))
Bram Moolenaar6e50ec22021-04-03 19:32:44 +02003931 {
3932 clear_tv(STACK_TV_BOT(0));
Bram Moolenaarf5906aa2021-04-02 14:35:15 +02003933 goto on_error;
Bram Moolenaar6e50ec22021-04-03 19:32:44 +02003934 }
Bram Moolenaarf5906aa2021-04-02 14:35:15 +02003935
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003936 clear_tv(sv->sv_tv);
3937 *sv->sv_tv = *STACK_TV_BOT(0);
3938 }
3939 break;
3940
3941 // store option
3942 case ISN_STOREOPT:
Bram Moolenaardcb53be2021-12-09 14:23:43 +00003943 case ISN_STOREFUNCOPT:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003944 {
Bram Moolenaardcb53be2021-12-09 14:23:43 +00003945 char_u *opt_name = iptr->isn_arg.storeopt.so_name;
3946 int opt_flags = iptr->isn_arg.storeopt.so_flags;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003947 long n = 0;
3948 char_u *s = NULL;
3949 char *msg;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003950 char_u numbuf[NUMBUFLEN];
3951 char_u *tofree = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003952
Bram Moolenaar4c137212021-04-19 16:48:48 +02003953 --ectx->ec_stack.ga_len;
LemonBoy32f34612023-09-02 21:52:05 +02003954 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003955 tv = STACK_TV_BOT(0);
3956 if (tv->v_type == VAR_STRING)
Bram Moolenaar97a2af32020-01-28 22:52:48 +01003957 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003958 s = tv->vval.v_string;
Bram Moolenaar97a2af32020-01-28 22:52:48 +01003959 if (s == NULL)
3960 s = (char_u *)"";
3961 }
Bram Moolenaardcb53be2021-12-09 14:23:43 +00003962 else if (iptr->isn_type == ISN_STOREFUNCOPT)
3963 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003964 // If the option can be set to a function reference or
3965 // a lambda and the passed value is a function
3966 // reference, then convert it to the name (string) of
3967 // the function reference.
3968 s = tv2string(tv, &tofree, numbuf, 0);
3969 if (s == NULL || *s == NUL)
Bram Moolenaardcb53be2021-12-09 14:23:43 +00003970 {
Bram Moolenaar397a87a2022-03-20 21:14:15 +00003971 // cannot happen?
Bram Moolenaardcb53be2021-12-09 14:23:43 +00003972 clear_tv(tv);
Bram Moolenaar397a87a2022-03-20 21:14:15 +00003973 vim_free(tofree);
Bram Moolenaardcb53be2021-12-09 14:23:43 +00003974 goto on_error;
3975 }
Bram Moolenaardcb53be2021-12-09 14:23:43 +00003976 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003977 else
Bram Moolenaara6e67e42020-05-15 23:36:40 +02003978 // must be VAR_NUMBER, CHECKTYPE makes sure
3979 n = tv->vval.v_number;
Bram Moolenaardcb53be2021-12-09 14:23:43 +00003980 msg = set_option_value(opt_name, n, s, opt_flags);
Bram Moolenaare75ba262020-05-16 15:43:31 +02003981 clear_tv(tv);
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003982 vim_free(tofree);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003983 if (msg != NULL)
3984 {
Bram Moolenaar7517ffd2020-08-14 18:35:07 +02003985 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003986 emsg(_(msg));
Bram Moolenaare8593122020-07-18 15:17:02 +02003987 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003988 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003989 }
3990 break;
3991
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01003992 // store $ENV
3993 case ISN_STOREENV:
Bram Moolenaar4c137212021-04-19 16:48:48 +02003994 --ectx->ec_stack.ga_len;
Bram Moolenaar20431c92020-03-20 18:39:46 +01003995 tv = STACK_TV_BOT(0);
3996 vim_setenv_ext(iptr->isn_arg.string, tv_get_string(tv));
3997 clear_tv(tv);
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01003998 break;
3999
4000 // store @r
4001 case ISN_STOREREG:
4002 {
4003 int reg = iptr->isn_arg.number;
4004
Bram Moolenaar4c137212021-04-19 16:48:48 +02004005 --ectx->ec_stack.ga_len;
Bram Moolenaar401d9ff2020-02-19 18:14:44 +01004006 tv = STACK_TV_BOT(0);
Bram Moolenaar74f4a962021-06-17 21:03:07 +02004007 write_reg_contents(reg, tv_get_string(tv), -1, FALSE);
Bram Moolenaar401d9ff2020-02-19 18:14:44 +01004008 clear_tv(tv);
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01004009 }
4010 break;
4011
4012 // store v: variable
4013 case ISN_STOREV:
Bram Moolenaar4c137212021-04-19 16:48:48 +02004014 --ectx->ec_stack.ga_len;
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01004015 if (set_vim_var_tv(iptr->isn_arg.number, STACK_TV_BOT(0))
4016 == FAIL)
Bram Moolenaare8593122020-07-18 15:17:02 +02004017 // should not happen, type is checked when compiling
4018 goto on_error;
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01004019 break;
4020
Bram Moolenaard3aac292020-04-19 14:32:17 +02004021 // store g:/b:/w:/t: variable
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004022 case ISN_STOREG:
Bram Moolenaard3aac292020-04-19 14:32:17 +02004023 case ISN_STOREB:
4024 case ISN_STOREW:
4025 case ISN_STORET:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004026 {
Bram Moolenaar3bdc90b2020-12-22 20:35:40 +01004027 dictitem_T *di;
4028 hashtab_T *ht;
4029 char_u *name = iptr->isn_arg.string + 2;
4030
Bram Moolenaard3aac292020-04-19 14:32:17 +02004031 switch (iptr->isn_type)
4032 {
4033 case ISN_STOREG:
4034 ht = get_globvar_ht();
4035 break;
4036 case ISN_STOREB:
4037 ht = &curbuf->b_vars->dv_hashtab;
4038 break;
4039 case ISN_STOREW:
4040 ht = &curwin->w_vars->dv_hashtab;
4041 break;
4042 case ISN_STORET:
4043 ht = &curtab->tp_vars->dv_hashtab;
4044 break;
4045 default: // Cannot reach here
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004046 goto theend;
Bram Moolenaard3aac292020-04-19 14:32:17 +02004047 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004048
Bram Moolenaar4c137212021-04-19 16:48:48 +02004049 --ectx->ec_stack.ga_len;
Bram Moolenaar3bdc90b2020-12-22 20:35:40 +01004050 di = find_var_in_ht(ht, 0, name, TRUE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004051 if (di == NULL)
Bram Moolenaar0bbf7222020-02-19 22:31:48 +01004052 store_var(iptr->isn_arg.string, STACK_TV_BOT(0));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004053 else
4054 {
Bram Moolenaar3bdc90b2020-12-22 20:35:40 +01004055 SOURCING_LNUM = iptr->isn_lnum;
4056 if (var_check_permission(di, name) == FAIL)
4057 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004058 clear_tv(&di->di_tv);
4059 di->di_tv = *STACK_TV_BOT(0);
4060 }
4061 }
4062 break;
4063
Bram Moolenaar03290b82020-12-19 16:30:44 +01004064 // store an autoload variable
4065 case ISN_STOREAUTO:
4066 SOURCING_LNUM = iptr->isn_lnum;
4067 set_var(iptr->isn_arg.string, STACK_TV_BOT(-1), TRUE);
4068 clear_tv(STACK_TV_BOT(-1));
Bram Moolenaar4c137212021-04-19 16:48:48 +02004069 --ectx->ec_stack.ga_len;
Bram Moolenaar03290b82020-12-19 16:30:44 +01004070 break;
4071
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004072 // store number in local variable
4073 case ISN_STORENR:
Bram Moolenaara471eea2020-03-04 22:20:26 +01004074 tv = STACK_TV_VAR(iptr->isn_arg.storenr.stnr_idx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004075 clear_tv(tv);
4076 tv->v_type = VAR_NUMBER;
Bram Moolenaara471eea2020-03-04 22:20:26 +01004077 tv->vval.v_number = iptr->isn_arg.storenr.stnr_val;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004078 break;
4079
Bram Moolenaar590162c2022-12-24 21:24:06 +00004080 // Store a value in a list, dict, blob or object variable.
Bram Moolenaar4f5e3972020-12-21 17:30:50 +01004081 case ISN_STOREINDEX:
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02004082 {
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00004083 int res = execute_storeindex(iptr, ectx);
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02004084
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00004085 if (res == FAIL)
Bram Moolenaar8e4c8c82020-08-01 15:38:38 +02004086 goto on_error;
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00004087 if (res == NOTDONE)
4088 goto theend;
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02004089 }
4090 break;
4091
Bram Moolenaarea5c8982022-02-17 14:42:02 +00004092 // store value in list or blob range
Bram Moolenaar68452172021-04-12 21:21:02 +02004093 case ISN_STORERANGE:
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00004094 if (execute_storerange(iptr, ectx) == FAIL)
4095 goto on_error;
Bram Moolenaar68452172021-04-12 21:21:02 +02004096 break;
4097
Bram Moolenaard505d172022-12-18 21:42:55 +00004098 case ISN_LOAD_CLASSMEMBER:
4099 {
4100 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
4101 goto theend;
4102 classmember_T *cm = &iptr->isn_arg.classmember;
Bram Moolenaar4e2406c2023-06-24 19:22:21 +01004103 copy_tv(cm->cm_class->class_members_tv + cm->cm_idx,
4104 STACK_TV_BOT(0));
Bram Moolenaard505d172022-12-18 21:42:55 +00004105 ++ectx->ec_stack.ga_len;
4106 }
4107 break;
4108
4109 case ISN_STORE_CLASSMEMBER:
4110 {
4111 classmember_T *cm = &iptr->isn_arg.classmember;
4112 tv = &cm->cm_class->class_members_tv[cm->cm_idx];
4113 clear_tv(tv);
4114 *tv = *STACK_TV_BOT(-1);
4115 --ectx->ec_stack.ga_len;
4116 }
4117 break;
4118
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01004119 // Load or store variable or argument from outer scope.
Bram Moolenaar0186e582021-01-10 18:33:11 +01004120 case ISN_LOADOUTER:
4121 case ISN_STOREOUTER:
4122 {
4123 int depth = iptr->isn_arg.outer.outer_depth;
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02004124 outer_T *outer = ectx->ec_outer_ref == NULL ? NULL
4125 : ectx->ec_outer_ref->or_outer;
Bram Moolenaar0186e582021-01-10 18:33:11 +01004126
4127 while (depth > 1 && outer != NULL)
4128 {
4129 outer = outer->out_up;
4130 --depth;
4131 }
4132 if (outer == NULL)
4133 {
4134 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar69c76172021-12-02 16:38:52 +00004135 if (ectx->ec_frame_idx == ectx->ec_initial_frame_idx
4136 || ectx->ec_outer_ref == NULL)
4137 // Possibly :def function called from legacy
4138 // context.
4139 emsg(_(e_closure_called_from_invalid_context));
4140 else
4141 iemsg("LOADOUTER depth more than scope levels");
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004142 goto theend;
Bram Moolenaar0186e582021-01-10 18:33:11 +01004143 }
Bram Moolenaarcc341812022-09-19 15:54:34 +01004144 if (depth < 0)
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01004145 // Variable declared in loop. May be copied if the
4146 // loop block has already ended.
Bram Moolenaarcc341812022-09-19 15:54:34 +01004147 tv = ((typval_T *)outer->out_loop[-depth - 1]
4148 .stack->ga_data)
4149 + outer->out_loop[-depth - 1].var_idx
4150 + iptr->isn_arg.outer.outer_idx;
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01004151 else
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01004152 // Variable declared in a function. May be copied if
4153 // the function has already returned.
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01004154 tv = ((typval_T *)outer->out_stack->ga_data)
4155 + outer->out_frame_idx + STACK_FRAME_SIZE
4156 + iptr->isn_arg.outer.outer_idx;
Bram Moolenaar0186e582021-01-10 18:33:11 +01004157 if (iptr->isn_type == ISN_LOADOUTER)
4158 {
Christian Brabandt5dd41d42023-12-04 22:52:23 +01004159 typval_T *copy;
Bram Moolenaar35578162021-08-02 19:10:38 +02004160 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004161 goto theend;
Christian Brabandt5dd41d42023-12-04 22:52:23 +01004162 // careful: ga_grow_inner may re-alloc the stack
4163 if (depth < 0)
4164 copy = ((typval_T *)outer->out_loop[-depth - 1]
4165 .stack->ga_data)
4166 + outer->out_loop[-depth - 1].var_idx
4167 + iptr->isn_arg.outer.outer_idx;
4168 else
4169 copy = ((typval_T *)outer->out_stack->ga_data)
4170 + outer->out_frame_idx + STACK_FRAME_SIZE
4171 + iptr->isn_arg.outer.outer_idx;
4172 // memory was freed, get tv again
4173 if (copy != tv)
4174 tv = copy;
Bram Moolenaar0186e582021-01-10 18:33:11 +01004175 copy_tv(tv, STACK_TV_BOT(0));
Bram Moolenaar4c137212021-04-19 16:48:48 +02004176 ++ectx->ec_stack.ga_len;
Bram Moolenaar0186e582021-01-10 18:33:11 +01004177 }
4178 else
4179 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02004180 --ectx->ec_stack.ga_len;
Bram Moolenaar0186e582021-01-10 18:33:11 +01004181 clear_tv(tv);
4182 *tv = *STACK_TV_BOT(0);
4183 }
4184 }
4185 break;
4186
Bram Moolenaar752fc692021-01-04 21:57:11 +01004187 // unlet item in list or dict variable
4188 case ISN_UNLETINDEX:
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00004189 if (execute_unletindex(iptr, ectx) == FAIL)
4190 goto on_error;
Bram Moolenaar752fc692021-01-04 21:57:11 +01004191 break;
4192
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01004193 // unlet range of items in list variable
4194 case ISN_UNLETRANGE:
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00004195 if (execute_unletrange(iptr, ectx) == FAIL)
4196 goto on_error;
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01004197 break;
4198
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004199 // push constant
4200 case ISN_PUSHNR:
4201 case ISN_PUSHBOOL:
4202 case ISN_PUSHSPEC:
4203 case ISN_PUSHF:
4204 case ISN_PUSHS:
4205 case ISN_PUSHBLOB:
Bram Moolenaar42a480b2020-02-29 23:23:47 +01004206 case ISN_PUSHFUNC:
Bram Moolenaar42a480b2020-02-29 23:23:47 +01004207 case ISN_PUSHCHANNEL:
4208 case ISN_PUSHJOB:
Bram Moolenaarc4e1b862023-02-26 18:58:23 +00004209 case ISN_PUSHOBJ:
4210 case ISN_PUSHCLASS:
Bram Moolenaar35578162021-08-02 19:10:38 +02004211 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004212 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004213 tv = STACK_TV_BOT(0);
Bram Moolenaar2f8ce0a2020-07-19 19:47:35 +02004214 tv->v_lock = 0;
Bram Moolenaar4c137212021-04-19 16:48:48 +02004215 ++ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004216 switch (iptr->isn_type)
4217 {
4218 case ISN_PUSHNR:
4219 tv->v_type = VAR_NUMBER;
4220 tv->vval.v_number = iptr->isn_arg.number;
4221 break;
4222 case ISN_PUSHBOOL:
4223 tv->v_type = VAR_BOOL;
4224 tv->vval.v_number = iptr->isn_arg.number;
4225 break;
4226 case ISN_PUSHSPEC:
4227 tv->v_type = VAR_SPECIAL;
4228 tv->vval.v_number = iptr->isn_arg.number;
4229 break;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004230 case ISN_PUSHF:
4231 tv->v_type = VAR_FLOAT;
4232 tv->vval.v_float = iptr->isn_arg.fnumber;
4233 break;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004234 case ISN_PUSHBLOB:
4235 blob_copy(iptr->isn_arg.blob, tv);
4236 break;
Bram Moolenaar42a480b2020-02-29 23:23:47 +01004237 case ISN_PUSHFUNC:
4238 tv->v_type = VAR_FUNC;
Bram Moolenaar087d2e12020-03-01 15:36:42 +01004239 if (iptr->isn_arg.string == NULL)
4240 tv->vval.v_string = NULL;
4241 else
4242 tv->vval.v_string =
4243 vim_strsave(iptr->isn_arg.string);
Bram Moolenaar42a480b2020-02-29 23:23:47 +01004244 break;
Bram Moolenaar42a480b2020-02-29 23:23:47 +01004245 case ISN_PUSHCHANNEL:
4246#ifdef FEAT_JOB_CHANNEL
4247 tv->v_type = VAR_CHANNEL;
Bram Moolenaar397a87a2022-03-20 21:14:15 +00004248 tv->vval.v_channel = NULL;
Bram Moolenaar42a480b2020-02-29 23:23:47 +01004249#endif
4250 break;
4251 case ISN_PUSHJOB:
4252#ifdef FEAT_JOB_CHANNEL
4253 tv->v_type = VAR_JOB;
Bram Moolenaar397a87a2022-03-20 21:14:15 +00004254 tv->vval.v_job = NULL;
Bram Moolenaar42a480b2020-02-29 23:23:47 +01004255#endif
4256 break;
Bram Moolenaarc4e1b862023-02-26 18:58:23 +00004257 case ISN_PUSHOBJ:
4258 tv->v_type = VAR_OBJECT;
4259 tv->vval.v_object = NULL;
4260 break;
4261 case ISN_PUSHCLASS:
4262 tv->v_type = VAR_CLASS;
Bram Moolenaar30a84472023-02-27 08:07:14 +00004263 tv->vval.v_class = iptr->isn_arg.classarg;
Bram Moolenaarc4e1b862023-02-26 18:58:23 +00004264 break;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004265 default:
4266 tv->v_type = VAR_STRING;
Bram Moolenaarf8691002022-03-10 12:20:53 +00004267 tv->vval.v_string = iptr->isn_arg.string == NULL
4268 ? NULL : vim_strsave(iptr->isn_arg.string);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004269 }
4270 break;
4271
Bram Moolenaar06b77222022-01-25 15:51:56 +00004272 case ISN_AUTOLOAD:
4273 {
4274 char_u *name = iptr->isn_arg.string;
4275
4276 (void)script_autoload(name, FALSE);
4277 if (find_func(name, TRUE))
4278 {
4279 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
4280 goto theend;
4281 tv = STACK_TV_BOT(0);
4282 tv->v_lock = 0;
4283 ++ectx->ec_stack.ga_len;
4284 tv->v_type = VAR_FUNC;
4285 tv->vval.v_string = vim_strsave(name);
4286 }
4287 else
4288 {
4289 int res = load_namespace_var(ectx, ISN_LOADG, iptr);
4290
4291 if (res == NOTDONE)
4292 goto theend;
4293 if (res == FAIL)
4294 goto on_error;
4295 }
4296 }
4297 break;
4298
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02004299 case ISN_UNLET:
4300 if (do_unlet(iptr->isn_arg.unlet.ul_name,
4301 iptr->isn_arg.unlet.ul_forceit) == FAIL)
Bram Moolenaare8593122020-07-18 15:17:02 +02004302 goto on_error;
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02004303 break;
Bram Moolenaar7bdaea62020-04-19 18:27:26 +02004304 case ISN_UNLETENV:
LemonBoy77142312022-04-15 20:50:46 +01004305 vim_unsetenv_ext(iptr->isn_arg.unlet.ul_name);
Bram Moolenaar7bdaea62020-04-19 18:27:26 +02004306 break;
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02004307
Bram Moolenaaraacc9662021-08-13 19:40:51 +02004308 case ISN_LOCKUNLOCK:
4309 {
Ernie Raelee865f32023-09-29 19:53:55 +02004310#ifdef LOG_LOCKVAR
4311 ch_log(NULL, "LKVAR: execute INS_LOCKUNLOCK isn_arg %s",
4312 iptr->isn_arg.string);
4313#endif
Ernie Rael4c8da022023-10-11 21:35:11 +02004314 lval_root_T *lval_root_save = lval_root;
Bram Moolenaaraacc9662021-08-13 19:40:51 +02004315
4316 // Stack has the local variable, argument the whole :lock
4317 // or :unlock command, like ISN_EXEC.
4318 --ectx->ec_stack.ga_len;
Ernie Rael4c8da022023-10-11 21:35:11 +02004319 lval_root_T root = { .lr_tv = STACK_TV_BOT(0),
4320 .lr_cl_exec = iptr->isn_arg.lockunlock.lu_cl_exec,
4321 .lr_is_arg = iptr->isn_arg.lockunlock.lu_is_arg };
Ernie Rael64885642023-10-04 20:16:22 +02004322 lval_root = &root;
Ernie Rael4c8da022023-10-11 21:35:11 +02004323 int res = exec_command(iptr,
Ernie Rael64885642023-10-04 20:16:22 +02004324 iptr->isn_arg.lockunlock.lu_string);
4325 clear_tv(root.lr_tv);
Bram Moolenaaraacc9662021-08-13 19:40:51 +02004326 lval_root = lval_root_save;
4327 if (res == FAIL)
4328 goto on_error;
4329 }
4330 break;
4331
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +02004332 case ISN_LOCKCONST:
4333 item_lock(STACK_TV_BOT(-1), 100, TRUE, TRUE);
4334 break;
4335
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004336 // create a list from items on the stack; uses a single allocation
4337 // for the list header and the items
4338 case ISN_NEWLIST:
Bram Moolenaar4c137212021-04-19 16:48:48 +02004339 if (exe_newlist(iptr->isn_arg.number, ectx) == FAIL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004340 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004341 break;
4342
4343 // create a dict from items on the stack
4344 case ISN_NEWDICT:
4345 {
Bram Moolenaarec15b1c2022-03-27 16:29:53 +01004346 int res;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004347
Bram Moolenaarec15b1c2022-03-27 16:29:53 +01004348 SOURCING_LNUM = iptr->isn_lnum;
4349 res = exe_newdict(iptr->isn_arg.number, ectx);
4350 if (res == FAIL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004351 goto theend;
Bram Moolenaarec15b1c2022-03-27 16:29:53 +01004352 if (res == MAYBE)
4353 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004354 }
4355 break;
4356
LemonBoy372bcce2022-04-25 12:43:20 +01004357 case ISN_CONCAT:
4358 if (exe_concat(iptr->isn_arg.number, ectx) == FAIL)
4359 goto theend;
4360 break;
4361
Bram Moolenaar8acb9cc2022-03-08 13:18:55 +00004362 // create a partial with NULL value
4363 case ISN_NEWPARTIAL:
4364 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
4365 goto theend;
4366 ++ectx->ec_stack.ga_len;
4367 tv = STACK_TV_BOT(-1);
4368 tv->v_type = VAR_PARTIAL;
4369 tv->v_lock = 0;
4370 tv->vval.v_partial = NULL;
4371 break;
4372
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004373 // call a :def function
4374 case ISN_DCALL:
Bram Moolenaardfa3d552020-09-10 22:05:08 +02004375 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar2fecb532021-03-24 22:00:56 +01004376 if (call_dfunc(iptr->isn_arg.dfunc.cdf_idx,
4377 NULL,
4378 iptr->isn_arg.dfunc.cdf_argcount,
Bram Moolenaar4c137212021-04-19 16:48:48 +02004379 ectx) == FAIL)
Bram Moolenaare8593122020-07-18 15:17:02 +02004380 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004381 break;
4382
Bram Moolenaard0200c82023-01-28 15:19:40 +00004383 // call a method on an interface
4384 case ISN_METHODCALL:
4385 {
Bram Moolenaar094cf9f2023-02-10 15:52:25 +00004386 cmfunc_T *mfunc = iptr->isn_arg.mfunc;
4387
Bram Moolenaard0200c82023-01-28 15:19:40 +00004388 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar094cf9f2023-02-10 15:52:25 +00004389 tv = STACK_TV_BOT(-1 - mfunc->cmf_argcount);
Bram Moolenaard0200c82023-01-28 15:19:40 +00004390 if (tv->v_type != VAR_OBJECT)
4391 {
4392 object_required_error(tv);
4393 goto on_error;
4394 }
Ernie Raelbe828252024-07-26 18:37:02 +02004395
Bram Moolenaard0200c82023-01-28 15:19:40 +00004396 object_T *obj = tv->vval.v_object;
Ernie Raelbe828252024-07-26 18:37:02 +02004397 if (obj == NULL)
4398 {
4399 emsg(_(e_using_null_object));
4400 goto on_error;
4401 }
4402
Bram Moolenaard0200c82023-01-28 15:19:40 +00004403 class_T *cl = obj->obj_class;
4404
4405 // convert the interface index to the object index
Bram Moolenaard0200c82023-01-28 15:19:40 +00004406 int idx = object_index_from_itf_index(mfunc->cmf_itf,
Yegappan Lakshmanan5a05d372023-09-29 19:43:11 +02004407 TRUE, mfunc->cmf_idx, cl);
Bram Moolenaard0200c82023-01-28 15:19:40 +00004408
4409 if (call_ufunc(cl->class_obj_methods[idx], NULL,
4410 mfunc->cmf_argcount, ectx, NULL, NULL) == FAIL)
4411 goto on_error;
4412 }
4413 break;
4414
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004415 // call a builtin function
4416 case ISN_BCALL:
4417 SOURCING_LNUM = iptr->isn_lnum;
4418 if (call_bfunc(iptr->isn_arg.bfunc.cbf_idx,
4419 iptr->isn_arg.bfunc.cbf_argcount,
Bram Moolenaar4c137212021-04-19 16:48:48 +02004420 ectx) == FAIL)
Bram Moolenaard032f342020-07-18 18:13:02 +02004421 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004422 break;
4423
4424 // call a funcref or partial
4425 case ISN_PCALL:
4426 {
4427 cpfunc_T *pfunc = &iptr->isn_arg.pfunc;
4428 int r;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02004429 typval_T partial_tv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004430
4431 SOURCING_LNUM = iptr->isn_lnum;
4432 if (pfunc->cpf_top)
4433 {
4434 // funcref is above the arguments
4435 tv = STACK_TV_BOT(-pfunc->cpf_argcount - 1);
4436 }
4437 else
4438 {
4439 // Get the funcref from the stack.
Bram Moolenaar4c137212021-04-19 16:48:48 +02004440 --ectx->ec_stack.ga_len;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02004441 partial_tv = *STACK_TV_BOT(0);
4442 tv = &partial_tv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004443 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02004444 r = call_partial(tv, pfunc->cpf_argcount, ectx);
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02004445 if (tv == &partial_tv)
4446 clear_tv(&partial_tv);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004447 if (r == FAIL)
Bram Moolenaard032f342020-07-18 18:13:02 +02004448 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004449 }
4450 break;
4451
Bram Moolenaarbd5da372020-03-31 23:13:10 +02004452 case ISN_PCALL_END:
4453 // PCALL finished, arguments have been consumed and replaced by
4454 // the return value. Now clear the funcref from the stack,
4455 // and move the return value in its place.
Bram Moolenaar4c137212021-04-19 16:48:48 +02004456 --ectx->ec_stack.ga_len;
Bram Moolenaarbd5da372020-03-31 23:13:10 +02004457 clear_tv(STACK_TV_BOT(-1));
4458 *STACK_TV_BOT(-1) = *STACK_TV_BOT(0);
4459 break;
4460
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004461 // call a user defined function or funcref/partial
4462 case ISN_UCALL:
4463 {
4464 cufunc_T *cufunc = &iptr->isn_arg.ufunc;
4465
4466 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar2fecb532021-03-24 22:00:56 +01004467 if (call_eval_func(cufunc->cuf_name, cufunc->cuf_argcount,
Bram Moolenaar4c137212021-04-19 16:48:48 +02004468 ectx, iptr) == FAIL)
Bram Moolenaard032f342020-07-18 18:13:02 +02004469 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004470 }
4471 break;
4472
Bram Moolenaar1d84f762022-09-03 21:35:53 +01004473 // :defer func(arg)
4474 case ISN_DEFER:
Bram Moolenaar806a2732022-09-04 15:40:36 +01004475 if (defer_command(iptr->isn_arg.defer.defer_var_idx,
Bram Moolenaar1d84f762022-09-03 21:35:53 +01004476 iptr->isn_arg.defer.defer_argcount, ectx) == FAIL)
4477 goto on_error;
4478 break;
4479
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004480 // Return from a :def function call without a value.
4481 // Return from a constructor.
Bram Moolenaarf57b43c2021-06-15 22:13:27 +02004482 case ISN_RETURN_VOID:
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004483 case ISN_RETURN_OBJECT:
Bram Moolenaar35578162021-08-02 19:10:38 +02004484 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004485 goto theend;
Bram Moolenaar299f3032021-01-08 20:53:09 +01004486 tv = STACK_TV_BOT(0);
Bram Moolenaar4c137212021-04-19 16:48:48 +02004487 ++ectx->ec_stack.ga_len;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004488 if (iptr->isn_type == ISN_RETURN_VOID)
4489 {
4490 tv->v_type = VAR_VOID;
4491 tv->vval.v_number = 0;
4492 tv->v_lock = 0;
4493 }
4494 else
4495 {
4496 *tv = *STACK_TV_VAR(0);
Yegappan Lakshmanane5437c52023-12-16 14:11:19 +01004497 object_T *obj = tv->vval.v_object;
4498 ++obj->obj_refcount;
4499
4500 // Lock all the constant object variables
4501 obj_lock_const_vars(obj);
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004502 }
Bram Moolenaar299f3032021-01-08 20:53:09 +01004503 // FALLTHROUGH
4504
Bram Moolenaarf57b43c2021-06-15 22:13:27 +02004505 // return from a :def function call with what is on the stack
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004506 case ISN_RETURN:
4507 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02004508 garray_T *trystack = &ectx->ec_trystack;
Bram Moolenaar20431c92020-03-20 18:39:46 +01004509 trycmd_T *trycmd = NULL;
Bram Moolenaar8cbd6df2020-01-28 22:59:45 +01004510
Ernie Raelb077b582023-12-14 20:11:44 +01004511 ///////////////////////////////////////////////////
4512 // TODO: If FAIL, line number in output not correct
4513 ///////////////////////////////////////////////////
4514 if (check_typval_is_value(STACK_TV_BOT(-1)) == FAIL)
4515 goto theend;
4516
Bram Moolenaar8cbd6df2020-01-28 22:59:45 +01004517 if (trystack->ga_len > 0)
4518 trycmd = ((trycmd_T *)trystack->ga_data)
4519 + trystack->ga_len - 1;
Bram Moolenaarbf67ea12020-05-02 17:52:42 +02004520 if (trycmd != NULL
Bram Moolenaar4c137212021-04-19 16:48:48 +02004521 && trycmd->tcd_frame_idx == ectx->ec_frame_idx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004522 {
Bram Moolenaar9cb577a2021-02-22 22:45:10 +01004523 // jump to ":finally" or ":endtry"
4524 if (trycmd->tcd_finally_idx != 0)
Bram Moolenaar4c137212021-04-19 16:48:48 +02004525 ectx->ec_iidx = trycmd->tcd_finally_idx;
Bram Moolenaar9cb577a2021-02-22 22:45:10 +01004526 else
Bram Moolenaar4c137212021-04-19 16:48:48 +02004527 ectx->ec_iidx = trycmd->tcd_endtry_idx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004528 trycmd->tcd_return = TRUE;
4529 }
4530 else
Bram Moolenaard032f342020-07-18 18:13:02 +02004531 goto func_return;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004532 }
4533 break;
4534
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02004535 // push a partial, a reference to a compiled function
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004536 case ISN_FUNCREF:
4537 {
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01004538 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
4539 ufunc_T *ufunc;
4540 funcref_T *funcref = &iptr->isn_arg.funcref;
4541 funcref_extra_T *extra = funcref->fr_extra;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004542
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004543 if (pt == NULL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004544 goto theend;
Bram Moolenaar35578162021-08-02 19:10:38 +02004545 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +02004546 {
Bram Moolenaarbf67ea12020-05-02 17:52:42 +02004547 vim_free(pt);
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004548 goto theend;
Bram Moolenaarbf67ea12020-05-02 17:52:42 +02004549 }
Bram Moolenaar313e4722023-02-08 20:55:27 +00004550 if (extra != NULL && extra->fre_class != NULL)
4551 {
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02004552 class_T *cl;
4553 if (extra->fre_object_method)
Bram Moolenaar313e4722023-02-08 20:55:27 +00004554 {
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02004555 tv = STACK_TV_BOT(-1);
4556 if (tv->v_type != VAR_OBJECT)
4557 {
Ernie Raelbe828252024-07-26 18:37:02 +02004558 SOURCING_LNUM = iptr->isn_lnum;
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02004559 object_required_error(tv);
4560 vim_free(pt);
4561 goto on_error;
4562 }
Bram Moolenaar313e4722023-02-08 20:55:27 +00004563
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02004564 object_T *obj = tv->vval.v_object;
Ernie Raelbe828252024-07-26 18:37:02 +02004565 if (obj == NULL)
4566 {
4567 SOURCING_LNUM = iptr->isn_lnum;
4568 emsg(_(e_using_null_object));
4569 vim_free(pt);
4570 goto on_error;
4571 }
4572
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02004573 cl = obj->obj_class;
4574 // drop the value from the stack
4575 clear_tv(tv);
4576 --ectx->ec_stack.ga_len;
4577
4578 pt->pt_obj = obj;
4579 ++obj->obj_refcount;
4580 }
4581 else
4582 cl = extra->fre_class;
4583
4584 if (extra->fre_object_method)
4585 {
4586 // object method
4587 // convert the interface index to the object index
4588 int idx =
4589 object_index_from_itf_index(extra->fre_class,
4590 TRUE, extra->fre_method_idx, cl);
4591 ufunc = cl->class_obj_methods[idx];
4592 }
4593 else
4594 {
4595 // class method
4596 ufunc =
4597 cl->class_class_functions[extra->fre_method_idx];
4598 }
Bram Moolenaar313e4722023-02-08 20:55:27 +00004599 }
4600 else if (extra == NULL || extra->fre_func_name == NULL)
Bram Moolenaar38453522021-11-28 22:00:12 +00004601 {
4602 dfunc_T *pt_dfunc = ((dfunc_T *)def_functions.ga_data)
4603 + funcref->fr_dfunc_idx;
4604
4605 ufunc = pt_dfunc->df_ufunc;
4606 }
4607 else
Bram Moolenaar313e4722023-02-08 20:55:27 +00004608 {
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01004609 ufunc = find_func(extra->fre_func_name, FALSE);
Bram Moolenaar313e4722023-02-08 20:55:27 +00004610 }
Bram Moolenaar56acd1f2022-02-18 13:24:52 +00004611 if (ufunc == NULL)
4612 {
4613 SOURCING_LNUM = iptr->isn_lnum;
4614 iemsg("ufunc unexpectedly NULL for FUNCREF");
Christian Brabandt915f3bf2024-04-05 20:12:19 +02004615 vim_free(pt);
Bram Moolenaar56acd1f2022-02-18 13:24:52 +00004616 goto theend;
4617 }
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01004618 if (fill_partial_and_closure(pt, ufunc,
Bram Moolenaarcc341812022-09-19 15:54:34 +01004619 extra == NULL ? NULL : &extra->fre_loopvar_info,
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01004620 ectx) == FAIL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004621 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004622 tv = STACK_TV_BOT(0);
Bram Moolenaar4c137212021-04-19 16:48:48 +02004623 ++ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004624 tv->vval.v_partial = pt;
4625 tv->v_type = VAR_PARTIAL;
Bram Moolenaar2f8ce0a2020-07-19 19:47:35 +02004626 tv->v_lock = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004627 }
4628 break;
4629
Bram Moolenaar38ddf332020-07-31 22:05:04 +02004630 // Create a global function from a lambda.
4631 case ISN_NEWFUNC:
4632 {
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01004633 newfuncarg_T *arg = iptr->isn_arg.newfunc.nf_arg;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02004634
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01004635 if (copy_lambda_to_global_func(arg->nfa_lambda,
Bram Moolenaarcc341812022-09-19 15:54:34 +01004636 arg->nfa_global, &arg->nfa_loopvar_info,
4637 ectx) == FAIL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004638 goto theend;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02004639 }
4640 break;
4641
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01004642 // List functions
4643 case ISN_DEF:
4644 if (iptr->isn_arg.string == NULL)
4645 list_functions(NULL);
4646 else
4647 {
Bram Moolenaar14336722022-01-08 16:02:59 +00004648 exarg_T ea;
4649 garray_T lines_to_free;
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01004650
4651 CLEAR_FIELD(ea);
4652 ea.cmd = ea.arg = iptr->isn_arg.string;
Bram Moolenaar14336722022-01-08 16:02:59 +00004653 ga_init2(&lines_to_free, sizeof(char_u *), 50);
Bram Moolenaard4a9b7f2023-05-23 14:48:42 +01004654 SOURCING_LNUM = iptr->isn_lnum;
h-eastb895b0f2023-09-24 15:46:31 +02004655 define_function(&ea, NULL, &lines_to_free, 0, NULL, 0);
Bram Moolenaar14336722022-01-08 16:02:59 +00004656 ga_clear_strings(&lines_to_free);
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01004657 }
4658 break;
4659
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004660 // jump if a condition is met
4661 case ISN_JUMP:
4662 {
4663 jumpwhen_T when = iptr->isn_arg.jump.jump_when;
Bram Moolenaar2bb26582020-10-03 22:52:39 +02004664 int error = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004665 int jump = TRUE;
4666
4667 if (when != JUMP_ALWAYS)
4668 {
4669 tv = STACK_TV_BOT(-1);
Bram Moolenaar2bb26582020-10-03 22:52:39 +02004670 if (when == JUMP_IF_COND_FALSE
Bram Moolenaar13106602020-10-04 16:06:05 +02004671 || when == JUMP_IF_FALSE
Bram Moolenaar2bb26582020-10-03 22:52:39 +02004672 || when == JUMP_IF_COND_TRUE)
4673 {
4674 SOURCING_LNUM = iptr->isn_lnum;
4675 jump = tv_get_bool_chk(tv, &error);
4676 if (error)
4677 goto on_error;
4678 }
4679 else
4680 jump = tv2bool(tv);
Bram Moolenaarf6ced982022-04-28 12:00:49 +01004681 if (when == JUMP_IF_FALSE || when == JUMP_IF_COND_FALSE)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004682 jump = !jump;
Bram Moolenaar777770f2020-02-06 21:27:08 +01004683 if (when == JUMP_IF_FALSE || !jump)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004684 {
4685 // drop the value from the stack
4686 clear_tv(tv);
Bram Moolenaar4c137212021-04-19 16:48:48 +02004687 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004688 }
4689 }
4690 if (jump)
Bram Moolenaar4c137212021-04-19 16:48:48 +02004691 ectx->ec_iidx = iptr->isn_arg.jump.jump_where;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004692 }
4693 break;
4694
Bram Moolenaarb46c0832022-09-15 17:19:37 +01004695 // "while": jump to end if a condition is false
4696 case ISN_WHILE:
4697 {
4698 int error = FALSE;
4699 int jump = TRUE;
4700
4701 tv = STACK_TV_BOT(-1);
4702 SOURCING_LNUM = iptr->isn_lnum;
4703 jump = !tv_get_bool_chk(tv, &error);
4704 if (error)
4705 goto on_error;
4706 // drop the value from the stack
4707 clear_tv(tv);
4708 --ectx->ec_stack.ga_len;
4709 if (jump)
4710 ectx->ec_iidx = iptr->isn_arg.whileloop.while_end;
4711
Bram Moolenaar87b4e5c2022-10-01 15:32:46 +01004712 // Store the current funcref count, may be used by
Bram Moolenaarcc341812022-09-19 15:54:34 +01004713 // ISN_ENDLOOP later
Bram Moolenaarb46c0832022-09-15 17:19:37 +01004714 tv = STACK_TV_VAR(
4715 iptr->isn_arg.whileloop.while_funcref_idx);
4716 tv->vval.v_number = ectx->ec_funcrefs.ga_len;
4717 }
4718 break;
4719
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +02004720 // Jump if an argument with a default value was already set and not
4721 // v:none.
4722 case ISN_JUMP_IF_ARG_SET:
Bram Moolenaar65b0d162022-12-13 18:43:22 +00004723 case ISN_JUMP_IF_ARG_NOT_SET:
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +02004724 tv = STACK_TV_VAR(iptr->isn_arg.jumparg.jump_arg_off);
Bram Moolenaar65b0d162022-12-13 18:43:22 +00004725 int arg_set = tv->v_type != VAR_UNKNOWN
4726 && !(tv->v_type == VAR_SPECIAL
4727 && tv->vval.v_number == VVAL_NONE);
4728 if (iptr->isn_type == ISN_JUMP_IF_ARG_SET ? arg_set : !arg_set)
Bram Moolenaar4c137212021-04-19 16:48:48 +02004729 ectx->ec_iidx = iptr->isn_arg.jumparg.jump_where;
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +02004730 break;
4731
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004732 // top of a for loop
4733 case ISN_FOR:
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00004734 if (execute_for(iptr, ectx) == FAIL)
4735 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004736 break;
4737
Bram Moolenaarb46c0832022-09-15 17:19:37 +01004738 // end of a for or while loop
4739 case ISN_ENDLOOP:
4740 if (execute_endloop(iptr, ectx) == FAIL)
4741 goto theend;
4742 break;
4743
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004744 // start of ":try" block
4745 case ISN_TRY:
4746 {
Bram Moolenaar20431c92020-03-20 18:39:46 +01004747 trycmd_T *trycmd = NULL;
4748
Bram Moolenaar35578162021-08-02 19:10:38 +02004749 if (GA_GROW_FAILS(&ectx->ec_trystack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004750 goto theend;
Bram Moolenaar4c137212021-04-19 16:48:48 +02004751 trycmd = ((trycmd_T *)ectx->ec_trystack.ga_data)
4752 + ectx->ec_trystack.ga_len;
4753 ++ectx->ec_trystack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004754 ++trylevel;
Bram Moolenaar8d4be892021-02-13 18:33:02 +01004755 CLEAR_POINTER(trycmd);
Bram Moolenaar4c137212021-04-19 16:48:48 +02004756 trycmd->tcd_frame_idx = ectx->ec_frame_idx;
4757 trycmd->tcd_stack_len = ectx->ec_stack.ga_len;
Bram Moolenaara91a7132021-03-25 21:12:15 +01004758 trycmd->tcd_catch_idx =
Bram Moolenaar0d807102021-12-21 09:42:09 +00004759 iptr->isn_arg.tryref.try_ref->try_catch;
Bram Moolenaara91a7132021-03-25 21:12:15 +01004760 trycmd->tcd_finally_idx =
Bram Moolenaar0d807102021-12-21 09:42:09 +00004761 iptr->isn_arg.tryref.try_ref->try_finally;
Bram Moolenaara91a7132021-03-25 21:12:15 +01004762 trycmd->tcd_endtry_idx =
Bram Moolenaar0d807102021-12-21 09:42:09 +00004763 iptr->isn_arg.tryref.try_ref->try_endtry;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004764 }
4765 break;
4766
4767 case ISN_PUSHEXC:
4768 if (current_exception == NULL)
4769 {
Bram Moolenaar7517ffd2020-08-14 18:35:07 +02004770 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004771 iemsg("Evaluating catch while current_exception is NULL");
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004772 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004773 }
Bram Moolenaar35578162021-08-02 19:10:38 +02004774 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004775 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004776 tv = STACK_TV_BOT(0);
Bram Moolenaar4c137212021-04-19 16:48:48 +02004777 ++ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004778 tv->v_type = VAR_STRING;
Bram Moolenaar2f8ce0a2020-07-19 19:47:35 +02004779 tv->v_lock = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004780 tv->vval.v_string = vim_strsave(
4781 (char_u *)current_exception->value);
4782 break;
4783
4784 case ISN_CATCH:
4785 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02004786 garray_T *trystack = &ectx->ec_trystack;
Bram Moolenaar06651632022-04-27 17:54:25 +01004787 trycmd_T *trycmd;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004788
Bram Moolenaar4c137212021-04-19 16:48:48 +02004789 may_restore_cmdmod(&ectx->ec_funclocal);
Bram Moolenaar06651632022-04-27 17:54:25 +01004790 trycmd = ((trycmd_T *)trystack->ga_data)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004791 + trystack->ga_len - 1;
Bram Moolenaar06651632022-04-27 17:54:25 +01004792 trycmd->tcd_caught = TRUE;
4793 trycmd->tcd_did_throw = FALSE;
4794
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004795 did_emsg = got_int = did_throw = FALSE;
Bram Moolenaar1430cee2021-01-17 19:20:32 +01004796 force_abort = need_rethrow = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004797 catch_exception(current_exception);
4798 }
4799 break;
4800
Bram Moolenaarc150c092021-02-13 15:02:46 +01004801 case ISN_TRYCONT:
4802 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02004803 garray_T *trystack = &ectx->ec_trystack;
Bram Moolenaarc150c092021-02-13 15:02:46 +01004804 trycont_T *trycont = &iptr->isn_arg.trycont;
4805 int i;
4806 trycmd_T *trycmd;
4807 int iidx = trycont->tct_where;
4808
4809 if (trystack->ga_len < trycont->tct_levels)
4810 {
4811 siemsg("TRYCONT: expected %d levels, found %d",
4812 trycont->tct_levels, trystack->ga_len);
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004813 goto theend;
Bram Moolenaarc150c092021-02-13 15:02:46 +01004814 }
4815 // Make :endtry jump to any outer try block and the last
4816 // :endtry inside the loop to the loop start.
4817 for (i = trycont->tct_levels; i > 0; --i)
4818 {
4819 trycmd = ((trycmd_T *)trystack->ga_data)
4820 + trystack->ga_len - i;
Bram Moolenaar2e34c342021-03-14 12:13:33 +01004821 // Add one to tcd_cont to be able to jump to
4822 // instruction with index zero.
4823 trycmd->tcd_cont = iidx + 1;
Bram Moolenaar7e82c5f2021-02-21 21:32:45 +01004824 iidx = trycmd->tcd_finally_idx == 0
4825 ? trycmd->tcd_endtry_idx : trycmd->tcd_finally_idx;
Bram Moolenaarc150c092021-02-13 15:02:46 +01004826 }
4827 // jump to :finally or :endtry of current try statement
Bram Moolenaar4c137212021-04-19 16:48:48 +02004828 ectx->ec_iidx = iidx;
Bram Moolenaarc150c092021-02-13 15:02:46 +01004829 }
4830 break;
4831
Bram Moolenaar7e82c5f2021-02-21 21:32:45 +01004832 case ISN_FINALLY:
4833 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02004834 garray_T *trystack = &ectx->ec_trystack;
Bram Moolenaar7e82c5f2021-02-21 21:32:45 +01004835 trycmd_T *trycmd = ((trycmd_T *)trystack->ga_data)
4836 + trystack->ga_len - 1;
4837
4838 // Reset the index to avoid a return statement jumps here
4839 // again.
4840 trycmd->tcd_finally_idx = 0;
4841 break;
4842 }
4843
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004844 // end of ":try" block
4845 case ISN_ENDTRY:
4846 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02004847 garray_T *trystack = &ectx->ec_trystack;
Bram Moolenaar06651632022-04-27 17:54:25 +01004848 trycmd_T *trycmd;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004849
Bram Moolenaar06651632022-04-27 17:54:25 +01004850 --trystack->ga_len;
4851 --trylevel;
4852 trycmd = ((trycmd_T *)trystack->ga_data) + trystack->ga_len;
4853 if (trycmd->tcd_did_throw)
4854 did_throw = TRUE;
4855 if (trycmd->tcd_caught && current_exception != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004856 {
Bram Moolenaar06651632022-04-27 17:54:25 +01004857 // discard the exception
4858 if (caught_stack == current_exception)
4859 caught_stack = caught_stack->caught;
4860 discard_current_exception();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004861 }
Bram Moolenaar06651632022-04-27 17:54:25 +01004862
4863 if (trycmd->tcd_return)
4864 goto func_return;
4865
4866 while (ectx->ec_stack.ga_len > trycmd->tcd_stack_len)
4867 {
4868 --ectx->ec_stack.ga_len;
4869 clear_tv(STACK_TV_BOT(0));
4870 }
4871 if (trycmd->tcd_cont != 0)
4872 // handling :continue: jump to outer try block or
4873 // start of the loop
4874 ectx->ec_iidx = trycmd->tcd_cont - 1;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004875 }
4876 break;
4877
4878 case ISN_THROW:
Bram Moolenaar8f81b222021-01-14 21:47:06 +01004879 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02004880 garray_T *trystack = &ectx->ec_trystack;
Bram Moolenaar1e021e62020-10-16 20:25:23 +02004881
Bram Moolenaar107e9ce2021-01-24 20:52:00 +01004882 if (trystack->ga_len == 0 && trylevel == 0 && emsg_silent)
4883 {
Bram Moolenaar3ef2e412023-04-30 18:50:48 +01004884 // Throwing an exception while using "silent!" causes
Bram Moolenaar107e9ce2021-01-24 20:52:00 +01004885 // the function to abort but not display an error.
4886 tv = STACK_TV_BOT(-1);
4887 clear_tv(tv);
4888 tv->v_type = VAR_NUMBER;
4889 tv->vval.v_number = 0;
4890 goto done;
4891 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02004892 --ectx->ec_stack.ga_len;
Bram Moolenaar107e9ce2021-01-24 20:52:00 +01004893 tv = STACK_TV_BOT(0);
4894 if (tv->vval.v_string == NULL
4895 || *skipwhite(tv->vval.v_string) == NUL)
4896 {
4897 vim_free(tv->vval.v_string);
4898 SOURCING_LNUM = iptr->isn_lnum;
4899 emsg(_(e_throw_with_empty_string));
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004900 goto theend;
Bram Moolenaar107e9ce2021-01-24 20:52:00 +01004901 }
4902
4903 // Inside a "catch" we need to first discard the caught
4904 // exception.
4905 if (trystack->ga_len > 0)
4906 {
4907 trycmd_T *trycmd = ((trycmd_T *)trystack->ga_data)
4908 + trystack->ga_len - 1;
4909 if (trycmd->tcd_caught && current_exception != NULL)
4910 {
4911 // discard the exception
4912 if (caught_stack == current_exception)
4913 caught_stack = caught_stack->caught;
4914 discard_current_exception();
4915 trycmd->tcd_caught = FALSE;
4916 }
4917 }
4918
Bram Moolenaar90a57162022-02-12 14:23:17 +00004919 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar107e9ce2021-01-24 20:52:00 +01004920 if (throw_exception(tv->vval.v_string, ET_USER, NULL)
4921 == FAIL)
4922 {
4923 vim_free(tv->vval.v_string);
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004924 goto theend;
Bram Moolenaar107e9ce2021-01-24 20:52:00 +01004925 }
4926 did_throw = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004927 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004928 break;
4929
4930 // compare with special values
4931 case ISN_COMPAREBOOL:
4932 case ISN_COMPARESPECIAL:
4933 {
4934 typval_T *tv1 = STACK_TV_BOT(-2);
4935 typval_T *tv2 = STACK_TV_BOT(-1);
4936 varnumber_T arg1 = tv1->vval.v_number;
4937 varnumber_T arg2 = tv2->vval.v_number;
4938 int res;
4939
Bram Moolenaar06651632022-04-27 17:54:25 +01004940 if (iptr->isn_arg.op.op_type == EXPR_EQUAL)
4941 res = arg1 == arg2;
4942 else
4943 res = arg1 != arg2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004944
Bram Moolenaar4c137212021-04-19 16:48:48 +02004945 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004946 tv1->v_type = VAR_BOOL;
4947 tv1->vval.v_number = res ? VVAL_TRUE : VVAL_FALSE;
4948 }
4949 break;
4950
Bram Moolenaar7a222242022-03-01 19:23:24 +00004951 case ISN_COMPARENULL:
4952 {
4953 typval_T *tv1 = STACK_TV_BOT(-2);
4954 typval_T *tv2 = STACK_TV_BOT(-1);
4955 int res;
4956
4957 res = typval_compare_null(tv1, tv2);
4958 if (res == MAYBE)
4959 goto on_error;
4960 if (iptr->isn_arg.op.op_type == EXPR_NEQUAL)
4961 res = !res;
4962 clear_tv(tv1);
4963 clear_tv(tv2);
4964 --ectx->ec_stack.ga_len;
4965 tv1->v_type = VAR_BOOL;
4966 tv1->vval.v_number = res ? VVAL_TRUE : VVAL_FALSE;
4967 }
4968 break;
4969
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004970 // Operation with two number arguments
4971 case ISN_OPNR:
4972 case ISN_COMPARENR:
4973 {
4974 typval_T *tv1 = STACK_TV_BOT(-2);
4975 typval_T *tv2 = STACK_TV_BOT(-1);
4976 varnumber_T arg1 = tv1->vval.v_number;
4977 varnumber_T arg2 = tv2->vval.v_number;
Bram Moolenaarfbeefb12021-08-07 15:50:23 +02004978 varnumber_T res = 0;
4979 int div_zero = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004980
Yegappan Lakshmanana061f342022-05-22 19:13:49 +01004981 if (iptr->isn_arg.op.op_type == EXPR_LSHIFT
4982 || iptr->isn_arg.op.op_type == EXPR_RSHIFT)
4983 {
4984 if (arg2 < 0)
4985 {
4986 SOURCING_LNUM = iptr->isn_lnum;
dundargocc57b5bc2022-11-02 13:30:51 +00004987 emsg(_(e_bitshift_ops_must_be_positive));
Yegappan Lakshmanana061f342022-05-22 19:13:49 +01004988 goto on_error;
4989 }
4990 }
4991
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004992 switch (iptr->isn_arg.op.op_type)
4993 {
4994 case EXPR_MULT: res = arg1 * arg2; break;
Bram Moolenaarfbeefb12021-08-07 15:50:23 +02004995 case EXPR_DIV: if (arg2 == 0)
4996 div_zero = TRUE;
4997 else
4998 res = arg1 / arg2;
4999 break;
5000 case EXPR_REM: if (arg2 == 0)
5001 div_zero = TRUE;
5002 else
5003 res = arg1 % arg2;
5004 break;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005005 case EXPR_SUB: res = arg1 - arg2; break;
5006 case EXPR_ADD: res = arg1 + arg2; break;
5007
5008 case EXPR_EQUAL: res = arg1 == arg2; break;
5009 case EXPR_NEQUAL: res = arg1 != arg2; break;
5010 case EXPR_GREATER: res = arg1 > arg2; break;
5011 case EXPR_GEQUAL: res = arg1 >= arg2; break;
5012 case EXPR_SMALLER: res = arg1 < arg2; break;
5013 case EXPR_SEQUAL: res = arg1 <= arg2; break;
Yegappan Lakshmanana061f342022-05-22 19:13:49 +01005014 case EXPR_LSHIFT: if (arg2 > MAX_LSHIFT_BITS)
5015 res = 0;
5016 else
Bram Moolenaar68e64d22022-05-22 22:07:52 +01005017 res = (uvarnumber_T)arg1 << arg2;
Yegappan Lakshmanana061f342022-05-22 19:13:49 +01005018 break;
5019 case EXPR_RSHIFT: if (arg2 > MAX_LSHIFT_BITS)
5020 res = 0;
5021 else
Bram Moolenaar338bf582022-05-22 20:16:32 +01005022 res = (uvarnumber_T)arg1 >> arg2;
Yegappan Lakshmanana061f342022-05-22 19:13:49 +01005023 break;
Bram Moolenaarfbeefb12021-08-07 15:50:23 +02005024 default: break;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005025 }
5026
Bram Moolenaar4c137212021-04-19 16:48:48 +02005027 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005028 if (iptr->isn_type == ISN_COMPARENR)
5029 {
5030 tv1->v_type = VAR_BOOL;
5031 tv1->vval.v_number = res ? VVAL_TRUE : VVAL_FALSE;
5032 }
5033 else
5034 tv1->vval.v_number = res;
Bram Moolenaarfbeefb12021-08-07 15:50:23 +02005035 if (div_zero)
5036 {
5037 SOURCING_LNUM = iptr->isn_lnum;
5038 emsg(_(e_divide_by_zero));
5039 goto on_error;
5040 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005041 }
5042 break;
5043
5044 // Computation with two float arguments
5045 case ISN_OPFLOAT:
5046 case ISN_COMPAREFLOAT:
5047 {
5048 typval_T *tv1 = STACK_TV_BOT(-2);
5049 typval_T *tv2 = STACK_TV_BOT(-1);
5050 float_T arg1 = tv1->vval.v_float;
5051 float_T arg2 = tv2->vval.v_float;
5052 float_T res = 0;
5053 int cmp = FALSE;
5054
5055 switch (iptr->isn_arg.op.op_type)
5056 {
5057 case EXPR_MULT: res = arg1 * arg2; break;
5058 case EXPR_DIV: res = arg1 / arg2; break;
5059 case EXPR_SUB: res = arg1 - arg2; break;
5060 case EXPR_ADD: res = arg1 + arg2; break;
5061
5062 case EXPR_EQUAL: cmp = arg1 == arg2; break;
5063 case EXPR_NEQUAL: cmp = arg1 != arg2; break;
5064 case EXPR_GREATER: cmp = arg1 > arg2; break;
5065 case EXPR_GEQUAL: cmp = arg1 >= arg2; break;
5066 case EXPR_SMALLER: cmp = arg1 < arg2; break;
5067 case EXPR_SEQUAL: cmp = arg1 <= arg2; break;
5068 default: cmp = 0; break;
5069 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02005070 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005071 if (iptr->isn_type == ISN_COMPAREFLOAT)
5072 {
5073 tv1->v_type = VAR_BOOL;
5074 tv1->vval.v_number = cmp ? VVAL_TRUE : VVAL_FALSE;
5075 }
5076 else
5077 tv1->vval.v_float = res;
5078 }
5079 break;
5080
5081 case ISN_COMPARELIST:
Bram Moolenaar265f8112021-12-19 12:33:05 +00005082 case ISN_COMPAREDICT:
5083 case ISN_COMPAREFUNC:
5084 case ISN_COMPARESTRING:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005085 case ISN_COMPAREBLOB:
Bram Moolenaarbcf31ec2023-01-02 20:32:24 +00005086 case ISN_COMPAREOBJECT:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005087 {
5088 typval_T *tv1 = STACK_TV_BOT(-2);
5089 typval_T *tv2 = STACK_TV_BOT(-1);
Bram Moolenaar265f8112021-12-19 12:33:05 +00005090 exprtype_T exprtype = iptr->isn_arg.op.op_type;
5091 int ic = iptr->isn_arg.op.op_ic;
5092 int res = FALSE;
5093 int status = OK;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005094
Bram Moolenaar265f8112021-12-19 12:33:05 +00005095 SOURCING_LNUM = iptr->isn_lnum;
5096 if (iptr->isn_type == ISN_COMPARELIST)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005097 {
Bram Moolenaar265f8112021-12-19 12:33:05 +00005098 status = typval_compare_list(tv1, tv2,
5099 exprtype, ic, &res);
5100 }
5101 else if (iptr->isn_type == ISN_COMPAREDICT)
5102 {
5103 status = typval_compare_dict(tv1, tv2,
5104 exprtype, ic, &res);
5105 }
5106 else if (iptr->isn_type == ISN_COMPAREFUNC)
5107 {
5108 status = typval_compare_func(tv1, tv2,
5109 exprtype, ic, &res);
5110 }
5111 else if (iptr->isn_type == ISN_COMPARESTRING)
5112 {
5113 status = typval_compare_string(tv1, tv2,
5114 exprtype, ic, &res);
5115 }
Bram Moolenaarbcf31ec2023-01-02 20:32:24 +00005116 else if (iptr->isn_type == ISN_COMPAREBLOB)
Bram Moolenaar265f8112021-12-19 12:33:05 +00005117 {
5118 status = typval_compare_blob(tv1, tv2, exprtype, &res);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005119 }
Bram Moolenaarbcf31ec2023-01-02 20:32:24 +00005120 else // ISN_COMPAREOBJECT
5121 {
5122 status = typval_compare_object(tv1, tv2,
Bram Moolenaar03ff0c62023-01-02 20:38:01 +00005123 exprtype, FALSE, &res);
Bram Moolenaarbcf31ec2023-01-02 20:32:24 +00005124 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02005125 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005126 clear_tv(tv1);
5127 clear_tv(tv2);
5128 tv1->v_type = VAR_BOOL;
Bram Moolenaar265f8112021-12-19 12:33:05 +00005129 tv1->vval.v_number = res ? VVAL_TRUE : VVAL_FALSE;
5130 if (status == FAIL)
5131 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005132 }
5133 break;
5134
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005135 case ISN_COMPAREANY:
5136 {
5137 typval_T *tv1 = STACK_TV_BOT(-2);
5138 typval_T *tv2 = STACK_TV_BOT(-1);
Bram Moolenaar657137c2021-01-09 15:45:23 +01005139 exprtype_T exprtype = iptr->isn_arg.op.op_type;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005140 int ic = iptr->isn_arg.op.op_ic;
Bram Moolenaar265f8112021-12-19 12:33:05 +00005141 int status;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005142
Bram Moolenaareb26f432020-09-14 16:50:05 +02005143 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar265f8112021-12-19 12:33:05 +00005144 status = typval_compare(tv1, tv2, exprtype, ic);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005145 clear_tv(tv2);
Bram Moolenaar4c137212021-04-19 16:48:48 +02005146 --ectx->ec_stack.ga_len;
Bram Moolenaar265f8112021-12-19 12:33:05 +00005147 if (status == FAIL)
5148 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005149 }
5150 break;
5151
5152 case ISN_ADDLIST:
5153 case ISN_ADDBLOB:
5154 {
5155 typval_T *tv1 = STACK_TV_BOT(-2);
5156 typval_T *tv2 = STACK_TV_BOT(-1);
5157
Bram Moolenaar1dcae592020-10-19 19:02:42 +02005158 // add two lists or blobs
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005159 if (iptr->isn_type == ISN_ADDLIST)
Bram Moolenaar07802042021-09-09 23:01:14 +02005160 {
5161 if (iptr->isn_arg.op.op_type == EXPR_APPEND
5162 && tv1->vval.v_list != NULL)
5163 list_extend(tv1->vval.v_list, tv2->vval.v_list,
5164 NULL);
5165 else
5166 eval_addlist(tv1, tv2);
5167 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005168 else
5169 eval_addblob(tv1, tv2);
5170 clear_tv(tv2);
Bram Moolenaar4c137212021-04-19 16:48:48 +02005171 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005172 }
5173 break;
5174
Bram Moolenaar1dcae592020-10-19 19:02:42 +02005175 case ISN_LISTAPPEND:
5176 {
5177 typval_T *tv1 = STACK_TV_BOT(-2);
5178 typval_T *tv2 = STACK_TV_BOT(-1);
5179 list_T *l = tv1->vval.v_list;
5180
5181 // add an item to a list
Bram Moolenaar1f4a3452022-01-01 18:29:21 +00005182 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar1dcae592020-10-19 19:02:42 +02005183 if (l == NULL)
5184 {
Bram Moolenaar1dcae592020-10-19 19:02:42 +02005185 emsg(_(e_cannot_add_to_null_list));
5186 goto on_error;
5187 }
Bram Moolenaar1f4a3452022-01-01 18:29:21 +00005188 if (value_check_lock(l->lv_lock, NULL, FALSE))
5189 goto on_error;
Bram Moolenaar1dcae592020-10-19 19:02:42 +02005190 if (list_append_tv(l, tv2) == FAIL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02005191 goto theend;
Bram Moolenaar955347c2020-10-19 23:01:46 +02005192 clear_tv(tv2);
Bram Moolenaar4c137212021-04-19 16:48:48 +02005193 --ectx->ec_stack.ga_len;
Bram Moolenaar1dcae592020-10-19 19:02:42 +02005194 }
5195 break;
5196
Bram Moolenaar80b0e5e2020-10-19 20:45:36 +02005197 case ISN_BLOBAPPEND:
5198 {
5199 typval_T *tv1 = STACK_TV_BOT(-2);
5200 typval_T *tv2 = STACK_TV_BOT(-1);
5201 blob_T *b = tv1->vval.v_blob;
5202 int error = FALSE;
5203 varnumber_T n;
5204
5205 // add a number to a blob
5206 if (b == NULL)
5207 {
5208 SOURCING_LNUM = iptr->isn_lnum;
5209 emsg(_(e_cannot_add_to_null_blob));
5210 goto on_error;
5211 }
5212 n = tv_get_number_chk(tv2, &error);
5213 if (error)
5214 goto on_error;
5215 ga_append(&b->bv_ga, (int)n);
Bram Moolenaar4c137212021-04-19 16:48:48 +02005216 --ectx->ec_stack.ga_len;
Bram Moolenaar80b0e5e2020-10-19 20:45:36 +02005217 }
5218 break;
5219
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005220 // Computation with two arguments of unknown type
5221 case ISN_OPANY:
5222 {
5223 typval_T *tv1 = STACK_TV_BOT(-2);
5224 typval_T *tv2 = STACK_TV_BOT(-1);
5225 varnumber_T n1, n2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005226 float_T f1 = 0, f2 = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005227 int error = FALSE;
5228
5229 if (iptr->isn_arg.op.op_type == EXPR_ADD)
5230 {
5231 if (tv1->v_type == VAR_LIST && tv2->v_type == VAR_LIST)
5232 {
5233 eval_addlist(tv1, tv2);
5234 clear_tv(tv2);
Bram Moolenaar4c137212021-04-19 16:48:48 +02005235 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005236 break;
5237 }
5238 else if (tv1->v_type == VAR_BLOB
5239 && tv2->v_type == VAR_BLOB)
5240 {
5241 eval_addblob(tv1, tv2);
5242 clear_tv(tv2);
Bram Moolenaar4c137212021-04-19 16:48:48 +02005243 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005244 break;
5245 }
5246 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005247 if (tv1->v_type == VAR_FLOAT)
5248 {
5249 f1 = tv1->vval.v_float;
5250 n1 = 0;
5251 }
5252 else
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005253 {
Bram Moolenaarf665e972020-12-05 19:17:16 +01005254 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005255 n1 = tv_get_number_chk(tv1, &error);
5256 if (error)
Bram Moolenaard032f342020-07-18 18:13:02 +02005257 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005258 if (tv2->v_type == VAR_FLOAT)
5259 f1 = n1;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005260 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005261 if (tv2->v_type == VAR_FLOAT)
5262 {
5263 f2 = tv2->vval.v_float;
5264 n2 = 0;
5265 }
5266 else
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005267 {
5268 n2 = tv_get_number_chk(tv2, &error);
5269 if (error)
Bram Moolenaard032f342020-07-18 18:13:02 +02005270 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005271 if (tv1->v_type == VAR_FLOAT)
5272 f2 = n2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005273 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005274 // if there is a float on either side the result is a float
5275 if (tv1->v_type == VAR_FLOAT || tv2->v_type == VAR_FLOAT)
5276 {
5277 switch (iptr->isn_arg.op.op_type)
5278 {
5279 case EXPR_MULT: f1 = f1 * f2; break;
5280 case EXPR_DIV: f1 = f1 / f2; break;
5281 case EXPR_SUB: f1 = f1 - f2; break;
5282 case EXPR_ADD: f1 = f1 + f2; break;
Bram Moolenaar7517ffd2020-08-14 18:35:07 +02005283 default: SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005284 emsg(_(e_cannot_use_percent_with_float));
Bram Moolenaarf0b9f432020-07-17 23:03:17 +02005285 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005286 }
5287 clear_tv(tv1);
5288 clear_tv(tv2);
5289 tv1->v_type = VAR_FLOAT;
5290 tv1->vval.v_float = f1;
Bram Moolenaar4c137212021-04-19 16:48:48 +02005291 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005292 }
5293 else
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005294 {
Bram Moolenaarb1f28572021-01-21 13:03:20 +01005295 int failed = FALSE;
5296
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005297 switch (iptr->isn_arg.op.op_type)
5298 {
5299 case EXPR_MULT: n1 = n1 * n2; break;
Bram Moolenaarb1f28572021-01-21 13:03:20 +01005300 case EXPR_DIV: n1 = num_divide(n1, n2, &failed);
5301 if (failed)
Bram Moolenaar99880f92021-01-20 21:23:14 +01005302 goto on_error;
5303 break;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005304 case EXPR_SUB: n1 = n1 - n2; break;
5305 case EXPR_ADD: n1 = n1 + n2; break;
Bram Moolenaarb1f28572021-01-21 13:03:20 +01005306 default: n1 = num_modulus(n1, n2, &failed);
5307 if (failed)
Bram Moolenaar99880f92021-01-20 21:23:14 +01005308 goto on_error;
5309 break;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005310 }
5311 clear_tv(tv1);
5312 clear_tv(tv2);
5313 tv1->v_type = VAR_NUMBER;
5314 tv1->vval.v_number = n1;
Bram Moolenaar4c137212021-04-19 16:48:48 +02005315 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005316 }
5317 }
5318 break;
5319
Bram Moolenaarbf9d8c32020-07-19 17:55:44 +02005320 case ISN_STRINDEX:
Bram Moolenaar11107ba2020-08-15 21:10:16 +02005321 case ISN_STRSLICE:
Bram Moolenaarbf9d8c32020-07-19 17:55:44 +02005322 {
Bram Moolenaar11107ba2020-08-15 21:10:16 +02005323 int is_slice = iptr->isn_type == ISN_STRSLICE;
5324 varnumber_T n1 = 0, n2;
Bram Moolenaarbf9d8c32020-07-19 17:55:44 +02005325 char_u *res;
5326
5327 // string index: string is at stack-2, index at stack-1
Bram Moolenaar11107ba2020-08-15 21:10:16 +02005328 // string slice: string is at stack-3, first index at
5329 // stack-2, second index at stack-1
Bram Moolenaar11107ba2020-08-15 21:10:16 +02005330 if (is_slice)
5331 {
5332 tv = STACK_TV_BOT(-2);
Bram Moolenaar11107ba2020-08-15 21:10:16 +02005333 n1 = tv->vval.v_number;
5334 }
5335
Bram Moolenaarbf9d8c32020-07-19 17:55:44 +02005336 tv = STACK_TV_BOT(-1);
Bram Moolenaar11107ba2020-08-15 21:10:16 +02005337 n2 = tv->vval.v_number;
Bram Moolenaarbf9d8c32020-07-19 17:55:44 +02005338
Bram Moolenaar4c137212021-04-19 16:48:48 +02005339 ectx->ec_stack.ga_len -= is_slice ? 2 : 1;
Bram Moolenaarbf9d8c32020-07-19 17:55:44 +02005340 tv = STACK_TV_BOT(-1);
Bram Moolenaar11107ba2020-08-15 21:10:16 +02005341 if (is_slice)
5342 // Slice: Select the characters from the string
Bram Moolenaar6601b622021-01-13 21:47:15 +01005343 res = string_slice(tv->vval.v_string, n1, n2, FALSE);
Bram Moolenaar11107ba2020-08-15 21:10:16 +02005344 else
5345 // Index: The resulting variable is a string of a
Bram Moolenaar0289a092021-03-14 18:40:19 +01005346 // single character (including composing characters).
5347 // If the index is too big or negative the result is
5348 // empty.
Bram Moolenaar11107ba2020-08-15 21:10:16 +02005349 res = char_from_string(tv->vval.v_string, n2);
Bram Moolenaarbf9d8c32020-07-19 17:55:44 +02005350 vim_free(tv->vval.v_string);
5351 tv->vval.v_string = res;
5352 }
5353 break;
5354
5355 case ISN_LISTINDEX:
Bram Moolenaared591872020-08-15 22:14:53 +02005356 case ISN_LISTSLICE:
Bram Moolenaarcfc30232021-04-11 20:26:34 +02005357 case ISN_BLOBINDEX:
5358 case ISN_BLOBSLICE:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005359 {
Bram Moolenaarcfc30232021-04-11 20:26:34 +02005360 int is_slice = iptr->isn_type == ISN_LISTSLICE
5361 || iptr->isn_type == ISN_BLOBSLICE;
5362 int is_blob = iptr->isn_type == ISN_BLOBINDEX
5363 || iptr->isn_type == ISN_BLOBSLICE;
Bram Moolenaared591872020-08-15 22:14:53 +02005364 varnumber_T n1, n2;
Bram Moolenaarcfc30232021-04-11 20:26:34 +02005365 typval_T *val_tv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005366
5367 // list index: list is at stack-2, index at stack-1
Bram Moolenaared591872020-08-15 22:14:53 +02005368 // list slice: list is at stack-3, indexes at stack-2 and
5369 // stack-1
Bram Moolenaarcfc30232021-04-11 20:26:34 +02005370 // Same for blob.
5371 val_tv = is_slice ? STACK_TV_BOT(-3) : STACK_TV_BOT(-2);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005372
5373 tv = STACK_TV_BOT(-1);
Bram Moolenaared591872020-08-15 22:14:53 +02005374 n1 = n2 = tv->vval.v_number;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005375 clear_tv(tv);
Bram Moolenaared591872020-08-15 22:14:53 +02005376
5377 if (is_slice)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005378 {
Bram Moolenaared591872020-08-15 22:14:53 +02005379 tv = STACK_TV_BOT(-2);
Bram Moolenaared591872020-08-15 22:14:53 +02005380 n1 = tv->vval.v_number;
5381 clear_tv(tv);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005382 }
Bram Moolenaared591872020-08-15 22:14:53 +02005383
Bram Moolenaar4c137212021-04-19 16:48:48 +02005384 ectx->ec_stack.ga_len -= is_slice ? 2 : 1;
Bram Moolenaar435d8972020-07-05 16:42:13 +02005385 tv = STACK_TV_BOT(-1);
Bram Moolenaar1d634542020-08-18 13:41:50 +02005386 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaarcfc30232021-04-11 20:26:34 +02005387 if (is_blob)
5388 {
5389 if (blob_slice_or_index(val_tv->vval.v_blob, is_slice,
5390 n1, n2, FALSE, tv) == FAIL)
5391 goto on_error;
5392 }
5393 else
5394 {
5395 if (list_slice_or_index(val_tv->vval.v_list, is_slice,
5396 n1, n2, FALSE, tv, TRUE) == FAIL)
5397 goto on_error;
5398 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005399 }
5400 break;
5401
Bram Moolenaarcc673e72020-08-16 17:33:35 +02005402 case ISN_ANYINDEX:
5403 case ISN_ANYSLICE:
5404 {
5405 int is_slice = iptr->isn_type == ISN_ANYSLICE;
5406 typval_T *var1, *var2;
5407 int res;
5408
5409 // index: composite is at stack-2, index at stack-1
5410 // slice: composite is at stack-3, indexes at stack-2 and
5411 // stack-1
5412 tv = is_slice ? STACK_TV_BOT(-3) : STACK_TV_BOT(-2);
Bram Moolenaar3affe7a2020-08-18 20:34:13 +02005413 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaarcc673e72020-08-16 17:33:35 +02005414 if (check_can_index(tv, TRUE, TRUE) == FAIL)
5415 goto on_error;
5416 var1 = is_slice ? STACK_TV_BOT(-2) : STACK_TV_BOT(-1);
5417 var2 = is_slice ? STACK_TV_BOT(-1) : NULL;
Bram Moolenaar6601b622021-01-13 21:47:15 +01005418 res = eval_index_inner(tv, is_slice, var1, var2,
5419 FALSE, NULL, -1, TRUE);
Bram Moolenaarcc673e72020-08-16 17:33:35 +02005420 clear_tv(var1);
5421 if (is_slice)
5422 clear_tv(var2);
Bram Moolenaar4c137212021-04-19 16:48:48 +02005423 ectx->ec_stack.ga_len -= is_slice ? 2 : 1;
Bram Moolenaarcc673e72020-08-16 17:33:35 +02005424 if (res == FAIL)
5425 goto on_error;
5426 }
5427 break;
5428
Bram Moolenaar9af78762020-06-16 11:34:42 +02005429 case ISN_SLICE:
5430 {
5431 list_T *list;
5432 int count = iptr->isn_arg.number;
5433
Bram Moolenaarc5b1c202020-06-18 22:43:27 +02005434 // type will have been checked to be a list
Bram Moolenaar9af78762020-06-16 11:34:42 +02005435 tv = STACK_TV_BOT(-1);
Bram Moolenaar9af78762020-06-16 11:34:42 +02005436 list = tv->vval.v_list;
5437
5438 // no error for short list, expect it to be checked earlier
5439 if (list != NULL && list->lv_len >= count)
5440 {
5441 list_T *newlist = list_slice(list,
5442 count, list->lv_len - 1);
5443
5444 if (newlist != NULL)
5445 {
5446 list_unref(list);
5447 tv->vval.v_list = newlist;
5448 ++newlist->lv_refcount;
5449 }
5450 }
5451 }
5452 break;
5453
Bram Moolenaar47a519a2020-06-14 23:05:10 +02005454 case ISN_GETITEM:
5455 {
5456 listitem_T *li;
Bram Moolenaar035bd1c2021-06-21 19:44:11 +02005457 getitem_T *gi = &iptr->isn_arg.getitem;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02005458
Bram Moolenaarc785b9a2020-06-19 18:34:15 +02005459 // Get list item: list is at stack-1, push item.
5460 // List type and length is checked for when compiling.
Bram Moolenaar035bd1c2021-06-21 19:44:11 +02005461 tv = STACK_TV_BOT(-1 - gi->gi_with_op);
5462 li = list_find(tv->vval.v_list, gi->gi_index);
Bram Moolenaar47a519a2020-06-14 23:05:10 +02005463
Bram Moolenaar35578162021-08-02 19:10:38 +02005464 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02005465 goto theend;
Bram Moolenaar4c137212021-04-19 16:48:48 +02005466 ++ectx->ec_stack.ga_len;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02005467 copy_tv(&li->li_tv, STACK_TV_BOT(-1));
Bram Moolenaarf785aa12021-02-11 21:19:34 +01005468
5469 // Useful when used in unpack assignment. Reset at
5470 // ISN_DROP.
Bram Moolenaar035bd1c2021-06-21 19:44:11 +02005471 ectx->ec_where.wt_index = gi->gi_index + 1;
LemonBoyc5d27442023-08-19 13:02:35 +02005472 ectx->ec_where.wt_kind = WT_VARIABLE;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02005473 }
5474 break;
5475
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005476 case ISN_MEMBER:
5477 {
5478 dict_T *dict;
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02005479 char_u *key;
5480 dictitem_T *di;
5481
5482 // dict member: dict is at stack-2, key at stack-1
5483 tv = STACK_TV_BOT(-2);
Bram Moolenaar4dac32c2020-05-15 21:44:19 +02005484 // no need to check for VAR_DICT, CHECKTYPE will check.
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02005485 dict = tv->vval.v_dict;
5486
5487 tv = STACK_TV_BOT(-1);
Bram Moolenaar4dac32c2020-05-15 21:44:19 +02005488 // no need to check for VAR_STRING, 2STRING will check.
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02005489 key = tv->vval.v_string;
Bram Moolenaar086fc9a2020-10-30 18:33:02 +01005490 if (key == NULL)
5491 key = (char_u *)"";
Bram Moolenaar4dac32c2020-05-15 21:44:19 +02005492
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02005493 if ((di = dict_find(dict, key, -1)) == NULL)
5494 {
Bram Moolenaar7517ffd2020-08-14 18:35:07 +02005495 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00005496 semsg(_(e_key_not_present_in_dictionary_str), key);
Bram Moolenaar4029cab2020-12-05 18:13:27 +01005497
5498 // If :silent! is used we will continue, make sure the
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02005499 // stack contents makes sense and the dict stack is
5500 // updated.
Bram Moolenaar4029cab2020-12-05 18:13:27 +01005501 clear_tv(tv);
Bram Moolenaar4c137212021-04-19 16:48:48 +02005502 --ectx->ec_stack.ga_len;
Bram Moolenaar4029cab2020-12-05 18:13:27 +01005503 tv = STACK_TV_BOT(-1);
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02005504 (void) dict_stack_save(tv);
Bram Moolenaar4029cab2020-12-05 18:13:27 +01005505 tv->v_type = VAR_NUMBER;
5506 tv->vval.v_number = 0;
Bram Moolenaaraf0df472020-12-02 20:51:22 +01005507 goto on_fatal_error;
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02005508 }
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02005509 clear_tv(tv);
Bram Moolenaar4c137212021-04-19 16:48:48 +02005510 --ectx->ec_stack.ga_len;
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02005511 // Put the dict used on the dict stack, it might be used by
5512 // a dict function later.
Bram Moolenaar50788ef2020-07-05 16:51:26 +02005513 tv = STACK_TV_BOT(-1);
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02005514 if (dict_stack_save(tv) == FAIL)
5515 goto on_fatal_error;
Bram Moolenaar50788ef2020-07-05 16:51:26 +02005516 copy_tv(&di->di_tv, tv);
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02005517 }
5518 break;
5519
5520 // dict member with string key
5521 case ISN_STRINGMEMBER:
5522 {
5523 dict_T *dict;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005524 dictitem_T *di;
5525
5526 tv = STACK_TV_BOT(-1);
5527 if (tv->v_type != VAR_DICT || tv->vval.v_dict == NULL)
5528 {
Bram Moolenaar7517ffd2020-08-14 18:35:07 +02005529 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005530 emsg(_(e_dictionary_required));
Bram Moolenaard032f342020-07-18 18:13:02 +02005531 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005532 }
5533 dict = tv->vval.v_dict;
5534
5535 if ((di = dict_find(dict, iptr->isn_arg.string, -1))
5536 == NULL)
5537 {
Bram Moolenaar7517ffd2020-08-14 18:35:07 +02005538 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00005539 semsg(_(e_key_not_present_in_dictionary_str),
Bram Moolenaar381692b2022-02-02 20:01:27 +00005540 iptr->isn_arg.string);
Bram Moolenaard032f342020-07-18 18:13:02 +02005541 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005542 }
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02005543 // Put the dict used on the dict stack, it might be used by
5544 // a dict function later.
5545 if (dict_stack_save(tv) == FAIL)
5546 goto on_fatal_error;
5547
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005548 copy_tv(&di->di_tv, tv);
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02005549 }
5550 break;
5551
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00005552 case ISN_GET_OBJ_MEMBER:
Bram Moolenaar29ac5df2023-01-16 19:43:47 +00005553 case ISN_GET_ITF_MEMBER:
Bram Moolenaarffdaca92022-12-09 21:41:48 +00005554 {
5555 tv = STACK_TV_BOT(-1);
5556 if (tv->v_type != VAR_OBJECT)
5557 {
5558 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaard0200c82023-01-28 15:19:40 +00005559 object_required_error(tv);
Bram Moolenaarffdaca92022-12-09 21:41:48 +00005560 goto on_error;
5561 }
Bram Moolenaar29ac5df2023-01-16 19:43:47 +00005562
Bram Moolenaarffdaca92022-12-09 21:41:48 +00005563 object_T *obj = tv->vval.v_object;
Bram Moolenaarc3f971f2023-03-02 17:38:33 +00005564 if (obj == NULL)
5565 {
5566 SOURCING_LNUM = iptr->isn_lnum;
5567 emsg(_(e_using_null_object));
5568 goto on_error;
5569 }
5570
Bram Moolenaar29ac5df2023-01-16 19:43:47 +00005571 int idx;
5572 if (iptr->isn_type == ISN_GET_OBJ_MEMBER)
Ernie Rael18143d32023-09-04 22:30:41 +02005573 idx = iptr->isn_arg.classmember.cm_idx;
Bram Moolenaar29ac5df2023-01-16 19:43:47 +00005574 else
5575 {
5576 idx = iptr->isn_arg.classmember.cm_idx;
5577 // convert the interface index to the object index
5578 idx = object_index_from_itf_index(
Ernie Rael18143d32023-09-04 22:30:41 +02005579 iptr->isn_arg.classmember.cm_class,
Yegappan Lakshmanan5a05d372023-09-29 19:43:11 +02005580 FALSE, idx, obj->obj_class);
Bram Moolenaar29ac5df2023-01-16 19:43:47 +00005581 }
5582
Ernie Rael18143d32023-09-04 22:30:41 +02005583 // The members are located right after the object struct.
Yegappan Lakshmanan5a05d372023-09-29 19:43:11 +02005584 typval_T *mtv = ((typval_T *)(obj + 1)) + idx;
Bram Moolenaar590162c2022-12-24 21:24:06 +00005585 copy_tv(mtv, tv);
Bram Moolenaarffdaca92022-12-09 21:41:48 +00005586
5587 // Unreference the object after getting the member, it may
5588 // be freed.
5589 object_unref(obj);
5590 }
5591 break;
5592
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00005593 case ISN_STORE_THIS:
5594 {
5595 int idx = iptr->isn_arg.number;
5596 object_T *obj = STACK_TV_VAR(0)->vval.v_object;
5597 // the members are located right after the object struct
5598 typval_T *mtv = ((typval_T *)(obj + 1)) + idx;
5599 clear_tv(mtv);
5600 *mtv = *STACK_TV_BOT(-1);
5601 --ectx->ec_stack.ga_len;
5602 }
5603 break;
5604
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02005605 case ISN_CLEARDICT:
5606 dict_stack_drop();
5607 break;
5608
5609 case ISN_USEDICT:
5610 {
5611 typval_T *dict_tv = dict_stack_get_tv();
5612
5613 // Turn "dict.Func" into a partial for "Func" bound to
5614 // "dict". Don't do this when "Func" is already a partial
5615 // that was bound explicitly (pt_auto is FALSE).
5616 tv = STACK_TV_BOT(-1);
5617 if (dict_tv != NULL
5618 && dict_tv->v_type == VAR_DICT
5619 && dict_tv->vval.v_dict != NULL
5620 && (tv->v_type == VAR_FUNC
5621 || (tv->v_type == VAR_PARTIAL
5622 && (tv->vval.v_partial->pt_auto
5623 || tv->vval.v_partial->pt_dict == NULL))))
5624 dict_tv->vval.v_dict =
5625 make_partial(dict_tv->vval.v_dict, tv);
5626 dict_stack_drop();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005627 }
5628 break;
5629
5630 case ISN_NEGATENR:
5631 tv = STACK_TV_BOT(-1);
Bram Moolenaar0c7f2612022-02-17 19:44:07 +00005632 // CHECKTYPE should have checked the variable type
Bram Moolenaarc58164c2020-03-29 18:40:30 +02005633 if (tv->v_type == VAR_FLOAT)
5634 tv->vval.v_float = -tv->vval.v_float;
5635 else
Bram Moolenaarc58164c2020-03-29 18:40:30 +02005636 tv->vval.v_number = -tv->vval.v_number;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005637 break;
5638
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005639 case ISN_CHECKTYPE:
5640 {
5641 checktype_T *ct = &iptr->isn_arg.type;
Bram Moolenaarb1040dc2022-05-18 11:00:48 +01005642 int r;
LemonBoyc5d27442023-08-19 13:02:35 +02005643 where_T where = WHERE_INIT;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005644
Bram Moolenaarb3005ce2021-01-22 17:51:06 +01005645 tv = STACK_TV_BOT((int)ct->ct_off);
Bram Moolenaar5e654232020-09-16 15:22:00 +02005646 SOURCING_LNUM = iptr->isn_lnum;
LemonBoyc5d27442023-08-19 13:02:35 +02005647 if (ct->ct_arg_idx > 0)
5648 {
5649 where.wt_index = ct->ct_arg_idx;
5650 where.wt_kind = ct->ct_is_var ? WT_VARIABLE : WT_ARGUMENT;
LemonBoyc5d27442023-08-19 13:02:35 +02005651 }
LemonBoyf244b2f2023-08-19 16:02:04 +02005652 where.wt_func_name = ectx->ec_where.wt_func_name;
LemonBoyc5d27442023-08-19 13:02:35 +02005653 r = check_typval_type(ct->ct_type, tv, where);
Bram Moolenaarb1040dc2022-05-18 11:00:48 +01005654 if (r == FAIL)
5655 goto on_error;
Bram Moolenaar5e654232020-09-16 15:22:00 +02005656
5657 // number 0 is FALSE, number 1 is TRUE
5658 if (tv->v_type == VAR_NUMBER
5659 && ct->ct_type->tt_type == VAR_BOOL
5660 && (tv->vval.v_number == 0
5661 || tv->vval.v_number == 1))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005662 {
Bram Moolenaar5e654232020-09-16 15:22:00 +02005663 tv->v_type = VAR_BOOL;
5664 tv->vval.v_number = tv->vval.v_number
Bram Moolenaardadaddd2020-09-12 19:11:23 +02005665 ? VVAL_TRUE : VVAL_FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005666 }
5667 }
5668 break;
5669
Bram Moolenaar9af78762020-06-16 11:34:42 +02005670 case ISN_CHECKLEN:
5671 {
5672 int min_len = iptr->isn_arg.checklen.cl_min_len;
5673 list_T *list = NULL;
5674
5675 tv = STACK_TV_BOT(-1);
5676 if (tv->v_type == VAR_LIST)
5677 list = tv->vval.v_list;
5678 if (list == NULL || list->lv_len < min_len
5679 || (list->lv_len > min_len
5680 && !iptr->isn_arg.checklen.cl_more_OK))
5681 {
Bram Moolenaar7517ffd2020-08-14 18:35:07 +02005682 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar451c2e32020-08-15 16:33:28 +02005683 semsg(_(e_expected_nr_items_but_got_nr),
Bram Moolenaar9af78762020-06-16 11:34:42 +02005684 min_len, list == NULL ? 0 : list->lv_len);
Bram Moolenaarf0b9f432020-07-17 23:03:17 +02005685 goto on_error;
Bram Moolenaar9af78762020-06-16 11:34:42 +02005686 }
5687 }
5688 break;
5689
Bram Moolenaaraa210a32021-01-02 15:41:03 +01005690 case ISN_SETTYPE:
Bram Moolenaar381692b2022-02-02 20:01:27 +00005691 set_tv_type(STACK_TV_BOT(-1), iptr->isn_arg.type.ct_type);
Bram Moolenaaraa210a32021-01-02 15:41:03 +01005692 break;
5693
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005694 case ISN_2BOOL:
Bram Moolenaar2bb26582020-10-03 22:52:39 +02005695 case ISN_COND2BOOL:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005696 {
5697 int n;
Bram Moolenaar2bb26582020-10-03 22:52:39 +02005698 int error = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005699
Bram Moolenaar2bb26582020-10-03 22:52:39 +02005700 if (iptr->isn_type == ISN_2BOOL)
5701 {
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02005702 tv = STACK_TV_BOT(iptr->isn_arg.tobool.offset);
Bram Moolenaar2bb26582020-10-03 22:52:39 +02005703 n = tv2bool(tv);
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02005704 if (iptr->isn_arg.tobool.invert)
Bram Moolenaar2bb26582020-10-03 22:52:39 +02005705 n = !n;
5706 }
5707 else
5708 {
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02005709 tv = STACK_TV_BOT(-1);
Bram Moolenaar2bb26582020-10-03 22:52:39 +02005710 SOURCING_LNUM = iptr->isn_lnum;
5711 n = tv_get_bool_chk(tv, &error);
5712 if (error)
5713 goto on_error;
5714 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005715 clear_tv(tv);
5716 tv->v_type = VAR_BOOL;
5717 tv->vval.v_number = n ? VVAL_TRUE : VVAL_FALSE;
5718 }
5719 break;
5720
5721 case ISN_2STRING:
Bram Moolenaar418f1df2020-08-12 21:34:49 +02005722 case ISN_2STRING_ANY:
Bram Moolenaar0acbf5a2021-01-05 20:58:25 +01005723 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02005724 if (do_2string(STACK_TV_BOT(iptr->isn_arg.tostring.offset),
5725 iptr->isn_type == ISN_2STRING_ANY,
Yegappan Lakshmananbce51d92024-04-15 19:19:52 +02005726 iptr->isn_arg.tostring.flags) == FAIL)
Bram Moolenaar4f5e3972020-12-21 17:30:50 +01005727 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005728 break;
5729
Bram Moolenaar08597872020-12-10 19:43:40 +01005730 case ISN_RANGE:
5731 {
5732 exarg_T ea;
5733 char *errormsg;
5734
Bram Moolenaarece0b872021-01-08 20:40:45 +01005735 ea.line2 = 0;
Bram Moolenaard1510ee2021-01-04 16:15:58 +01005736 ea.addr_count = 0;
Bram Moolenaar08597872020-12-10 19:43:40 +01005737 ea.addr_type = ADDR_LINES;
5738 ea.cmd = iptr->isn_arg.string;
Bram Moolenaarece0b872021-01-08 20:40:45 +01005739 ea.skip = FALSE;
Bram Moolenaar08597872020-12-10 19:43:40 +01005740 if (parse_cmd_address(&ea, &errormsg, FALSE) == FAIL)
Bram Moolenaarece0b872021-01-08 20:40:45 +01005741 goto on_error;
Bram Moolenaara28639e2021-01-19 22:48:09 +01005742
Bram Moolenaar35578162021-08-02 19:10:38 +02005743 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02005744 goto theend;
Bram Moolenaar4c137212021-04-19 16:48:48 +02005745 ++ectx->ec_stack.ga_len;
Bram Moolenaara28639e2021-01-19 22:48:09 +01005746 tv = STACK_TV_BOT(-1);
5747 tv->v_type = VAR_NUMBER;
5748 tv->v_lock = 0;
Bram Moolenaar06651632022-04-27 17:54:25 +01005749 tv->vval.v_number = ea.line2;
Bram Moolenaar08597872020-12-10 19:43:40 +01005750 }
5751 break;
5752
Bram Moolenaarc3516f72020-09-08 22:45:35 +02005753 case ISN_PUT:
5754 {
5755 int regname = iptr->isn_arg.put.put_regname;
5756 linenr_T lnum = iptr->isn_arg.put.put_lnum;
5757 char_u *expr = NULL;
5758 int dir = FORWARD;
5759
Bram Moolenaar08597872020-12-10 19:43:40 +01005760 if (lnum < -2)
5761 {
5762 // line number was put on the stack by ISN_RANGE
5763 tv = STACK_TV_BOT(-1);
5764 curwin->w_cursor.lnum = tv->vval.v_number;
5765 if (lnum == LNUM_VARIABLE_RANGE_ABOVE)
5766 dir = BACKWARD;
Bram Moolenaar4c137212021-04-19 16:48:48 +02005767 --ectx->ec_stack.ga_len;
Bram Moolenaar08597872020-12-10 19:43:40 +01005768 }
5769 else if (lnum == -2)
Bram Moolenaarc3516f72020-09-08 22:45:35 +02005770 // :put! above cursor
5771 dir = BACKWARD;
5772 else if (lnum >= 0)
Bram Moolenaar4e713ba2022-02-07 15:31:37 +00005773 {
5774 curwin->w_cursor.lnum = lnum;
5775 if (lnum == 0)
5776 // check_cursor() below will move to line 1
5777 dir = BACKWARD;
5778 }
Bram Moolenaara28639e2021-01-19 22:48:09 +01005779
5780 if (regname == '=')
5781 {
5782 tv = STACK_TV_BOT(-1);
5783 if (tv->v_type == VAR_STRING)
5784 expr = tv->vval.v_string;
5785 else
5786 {
5787 expr = typval2string(tv, TRUE); // allocates value
5788 clear_tv(tv);
5789 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02005790 --ectx->ec_stack.ga_len;
Bram Moolenaara28639e2021-01-19 22:48:09 +01005791 }
Bram Moolenaarc3516f72020-09-08 22:45:35 +02005792 check_cursor();
5793 do_put(regname, expr, dir, 1L, PUT_LINE|PUT_CURSLINE);
5794 vim_free(expr);
5795 }
5796 break;
5797
Bram Moolenaar02194d22020-10-24 23:08:38 +02005798 case ISN_CMDMOD:
Bram Moolenaar4c137212021-04-19 16:48:48 +02005799 ectx->ec_funclocal.floc_save_cmdmod = cmdmod;
5800 ectx->ec_funclocal.floc_restore_cmdmod = TRUE;
5801 ectx->ec_funclocal.floc_restore_cmdmod_stacklen =
5802 ectx->ec_stack.ga_len;
Bram Moolenaar02194d22020-10-24 23:08:38 +02005803 cmdmod = *iptr->isn_arg.cmdmod.cf_cmdmod;
5804 apply_cmdmod(&cmdmod);
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +02005805 break;
5806
Bram Moolenaar02194d22020-10-24 23:08:38 +02005807 case ISN_CMDMOD_REV:
5808 // filter regprog is owned by the instruction, don't free it
5809 cmdmod.cmod_filter_regmatch.regprog = NULL;
5810 undo_cmdmod(&cmdmod);
Bram Moolenaar4c137212021-04-19 16:48:48 +02005811 cmdmod = ectx->ec_funclocal.floc_save_cmdmod;
5812 ectx->ec_funclocal.floc_restore_cmdmod = FALSE;
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +02005813 break;
5814
Bram Moolenaar792f7862020-11-23 08:31:18 +01005815 case ISN_UNPACK:
5816 {
5817 int count = iptr->isn_arg.unpack.unp_count;
5818 int semicolon = iptr->isn_arg.unpack.unp_semicolon;
5819 list_T *l;
5820 listitem_T *li;
5821 int i;
5822
5823 // Check there is a valid list to unpack.
5824 tv = STACK_TV_BOT(-1);
5825 if (tv->v_type != VAR_LIST)
5826 {
5827 SOURCING_LNUM = iptr->isn_lnum;
5828 emsg(_(e_for_argument_must_be_sequence_of_lists));
5829 goto on_error;
5830 }
5831 l = tv->vval.v_list;
5832 if (l == NULL
5833 || l->lv_len < (semicolon ? count - 1 : count))
5834 {
5835 SOURCING_LNUM = iptr->isn_lnum;
5836 emsg(_(e_list_value_does_not_have_enough_items));
5837 goto on_error;
5838 }
5839 else if (!semicolon && l->lv_len > count)
5840 {
5841 SOURCING_LNUM = iptr->isn_lnum;
5842 emsg(_(e_list_value_has_more_items_than_targets));
5843 goto on_error;
5844 }
5845
5846 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar35578162021-08-02 19:10:38 +02005847 if (GA_GROW_FAILS(&ectx->ec_stack, count - 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02005848 goto theend;
Bram Moolenaar4c137212021-04-19 16:48:48 +02005849 ectx->ec_stack.ga_len += count - 1;
Bram Moolenaar792f7862020-11-23 08:31:18 +01005850
5851 // Variable after semicolon gets a list with the remaining
5852 // items.
5853 if (semicolon)
5854 {
5855 list_T *rem_list =
5856 list_alloc_with_items(l->lv_len - count + 1);
5857
5858 if (rem_list == NULL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02005859 goto theend;
Bram Moolenaar792f7862020-11-23 08:31:18 +01005860 tv = STACK_TV_BOT(-count);
5861 tv->vval.v_list = rem_list;
5862 ++rem_list->lv_refcount;
5863 tv->v_lock = 0;
5864 li = l->lv_first;
5865 for (i = 0; i < count - 1; ++i)
5866 li = li->li_next;
5867 for (i = 0; li != NULL; ++i)
5868 {
Bram Moolenaar61efa162022-03-18 13:10:48 +00005869 typval_T tvcopy;
5870
5871 copy_tv(&li->li_tv, &tvcopy);
5872 list_set_item(rem_list, i, &tvcopy);
Bram Moolenaar792f7862020-11-23 08:31:18 +01005873 li = li->li_next;
5874 }
5875 --count;
5876 }
5877
5878 // Produce the values in reverse order, first item last.
5879 li = l->lv_first;
5880 for (i = 0; i < count; ++i)
5881 {
5882 tv = STACK_TV_BOT(-i - 1);
5883 copy_tv(&li->li_tv, tv);
5884 li = li->li_next;
5885 }
5886
5887 list_unref(l);
5888 }
5889 break;
5890
Bram Moolenaarb2049902021-01-24 12:53:53 +01005891 case ISN_PROF_START:
5892 case ISN_PROF_END:
5893 {
Bram Moolenaarf002a412021-01-24 13:34:18 +01005894#ifdef FEAT_PROFILE
Bram Moolenaarca16c602022-09-06 18:57:08 +01005895 funccall_T cookie;
5896 ufunc_T *cur_ufunc =
Bram Moolenaarb2049902021-01-24 12:53:53 +01005897 (((dfunc_T *)def_functions.ga_data)
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02005898 + ectx->ec_dfunc_idx)->df_ufunc;
Bram Moolenaarb2049902021-01-24 12:53:53 +01005899
Bram Moolenaarca16c602022-09-06 18:57:08 +01005900 cookie.fc_func = cur_ufunc;
Bram Moolenaarb2049902021-01-24 12:53:53 +01005901 if (iptr->isn_type == ISN_PROF_START)
5902 {
5903 func_line_start(&cookie, iptr->isn_lnum);
5904 // if we get here the instruction is executed
5905 func_line_exec(&cookie);
5906 }
5907 else
5908 func_line_end(&cookie);
Bram Moolenaarf002a412021-01-24 13:34:18 +01005909#endif
Bram Moolenaarb2049902021-01-24 12:53:53 +01005910 }
5911 break;
5912
Bram Moolenaare99d4222021-06-13 14:01:26 +02005913 case ISN_DEBUG:
Bram Moolenaar4f8f5422021-06-20 19:28:14 +02005914 handle_debug(iptr, ectx);
Bram Moolenaare99d4222021-06-13 14:01:26 +02005915 break;
5916
Bram Moolenaar389df252020-07-09 21:20:47 +02005917 case ISN_SHUFFLE:
5918 {
Bram Moolenaar792f7862020-11-23 08:31:18 +01005919 typval_T tmp_tv;
5920 int item = iptr->isn_arg.shuffle.shfl_item;
5921 int up = iptr->isn_arg.shuffle.shfl_up;
Bram Moolenaar389df252020-07-09 21:20:47 +02005922
5923 tmp_tv = *STACK_TV_BOT(-item);
5924 for ( ; up > 0 && item > 1; --up)
5925 {
5926 *STACK_TV_BOT(-item) = *STACK_TV_BOT(-item + 1);
5927 --item;
5928 }
5929 *STACK_TV_BOT(-item) = tmp_tv;
5930 }
5931 break;
5932
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005933 case ISN_DROP:
Bram Moolenaar4c137212021-04-19 16:48:48 +02005934 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005935 clear_tv(STACK_TV_BOT(0));
LemonBoyc5d27442023-08-19 13:02:35 +02005936 ectx->ec_where = (where_T)WHERE_INIT;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005937 break;
5938 }
Bram Moolenaarf0b9f432020-07-17 23:03:17 +02005939 continue;
5940
Bram Moolenaard032f342020-07-18 18:13:02 +02005941func_return:
Bram Moolenaar7cbfaa52020-09-18 21:25:32 +02005942 // Restore previous function. If the frame pointer is where we started
5943 // then there is none and we are done.
Bram Moolenaar4c137212021-04-19 16:48:48 +02005944 if (ectx->ec_frame_idx == ectx->ec_initial_frame_idx)
Bram Moolenaard032f342020-07-18 18:13:02 +02005945 goto done;
Bram Moolenaar7cbfaa52020-09-18 21:25:32 +02005946
Bram Moolenaar4c137212021-04-19 16:48:48 +02005947 if (func_return(ectx) == FAIL)
Bram Moolenaard032f342020-07-18 18:13:02 +02005948 // only fails when out of memory
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02005949 goto theend;
Bram Moolenaarc7db5772020-07-21 20:55:50 +02005950 continue;
Bram Moolenaard032f342020-07-18 18:13:02 +02005951
Bram Moolenaarf0b9f432020-07-17 23:03:17 +02005952on_error:
Bram Moolenaaraf0df472020-12-02 20:51:22 +01005953 // Jump here for an error that does not require aborting execution.
Bram Moolenaar56602ba2020-12-05 21:22:08 +01005954 // If "emsg_silent" is set then ignore the error, unless it was set
5955 // when calling the function.
Bram Moolenaar4c137212021-04-19 16:48:48 +02005956 if (did_emsg_cumul + did_emsg == ectx->ec_did_emsg_before
Bram Moolenaar56602ba2020-12-05 21:22:08 +01005957 && emsg_silent && did_emsg_def == 0)
Bram Moolenaarf9041332021-01-21 19:41:16 +01005958 {
5959 // If a sequence of instructions causes an error while ":silent!"
5960 // was used, restore the stack length and jump ahead to restoring
5961 // the cmdmod.
Bram Moolenaar4c137212021-04-19 16:48:48 +02005962 if (ectx->ec_funclocal.floc_restore_cmdmod)
Bram Moolenaarf9041332021-01-21 19:41:16 +01005963 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02005964 while (ectx->ec_stack.ga_len
5965 > ectx->ec_funclocal.floc_restore_cmdmod_stacklen)
Bram Moolenaarf9041332021-01-21 19:41:16 +01005966 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02005967 --ectx->ec_stack.ga_len;
Bram Moolenaarf9041332021-01-21 19:41:16 +01005968 clear_tv(STACK_TV_BOT(0));
5969 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02005970 while (ectx->ec_instr[ectx->ec_iidx].isn_type != ISN_CMDMOD_REV)
5971 ++ectx->ec_iidx;
Bram Moolenaarf9041332021-01-21 19:41:16 +01005972 }
Bram Moolenaarcd030c42020-10-30 21:49:40 +01005973 continue;
Bram Moolenaarf9041332021-01-21 19:41:16 +01005974 }
Bram Moolenaaraf0df472020-12-02 20:51:22 +01005975on_fatal_error:
5976 // Jump here for an error that messes up the stack.
Bram Moolenaar171fb922020-10-28 16:54:47 +01005977 // If we are not inside a try-catch started here, abort execution.
Bram Moolenaar4c137212021-04-19 16:48:48 +02005978 if (trylevel <= ectx->ec_trylevel_at_start)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02005979 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005980 }
5981
5982done:
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02005983 ret = OK;
5984theend:
Bram Moolenaar58779852022-09-06 18:31:14 +01005985 may_invoke_defer_funcs(ectx);
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005986
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02005987 dict_stack_clear(dict_stack_len_at_start);
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02005988 ectx->ec_trylevel_at_start = save_trylevel_at_start;
5989 return ret;
Bram Moolenaar4c137212021-04-19 16:48:48 +02005990}
5991
5992/*
Bram Moolenaar806a2732022-09-04 15:40:36 +01005993 * Execute the instructions from a VAR_INSTR typval and put the result in
Bram Moolenaarf18332f2021-05-07 17:55:55 +02005994 * "rettv".
5995 * Return OK or FAIL.
5996 */
5997 int
5998exe_typval_instr(typval_T *tv, typval_T *rettv)
5999{
6000 ectx_T *ectx = tv->vval.v_instr->instr_ectx;
6001 isn_T *save_instr = ectx->ec_instr;
6002 int save_iidx = ectx->ec_iidx;
6003 int res;
6004
LemonBoyf3b48952022-05-05 13:53:03 +01006005 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
6006 // even when the compilation fails.
6007 rettv->v_type = VAR_UNKNOWN;
6008
Bram Moolenaarf18332f2021-05-07 17:55:55 +02006009 ectx->ec_instr = tv->vval.v_instr->instr_instr;
6010 res = exec_instructions(ectx);
6011 if (res == OK)
6012 {
6013 *rettv = *STACK_TV_BOT(-1);
6014 --ectx->ec_stack.ga_len;
6015 }
6016
6017 ectx->ec_instr = save_instr;
6018 ectx->ec_iidx = save_iidx;
6019
6020 return res;
6021}
6022
6023/*
Bram Moolenaar4c137212021-04-19 16:48:48 +02006024 * Execute the instructions from an ISN_SUBSTITUTE command, which are in
6025 * "substitute_instr".
6026 */
6027 char_u *
6028exe_substitute_instr(void)
6029{
6030 ectx_T *ectx = substitute_instr->subs_ectx;
6031 isn_T *save_instr = ectx->ec_instr;
6032 int save_iidx = ectx->ec_iidx;
6033 char_u *res;
6034
6035 ectx->ec_instr = substitute_instr->subs_instr;
6036 if (exec_instructions(ectx) == OK)
Bram Moolenaar90193e62021-04-04 20:49:50 +02006037 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02006038 typval_T *tv = STACK_TV_BOT(-1);
6039
Bram Moolenaar27523602021-06-05 21:36:19 +02006040 res = typval2string(tv, TRUE);
Bram Moolenaar4c137212021-04-19 16:48:48 +02006041 --ectx->ec_stack.ga_len;
6042 clear_tv(tv);
Bram Moolenaar90193e62021-04-04 20:49:50 +02006043 }
6044 else
6045 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02006046 substitute_instr->subs_status = FAIL;
6047 res = vim_strsave((char_u *)"");
Bram Moolenaar90193e62021-04-04 20:49:50 +02006048 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006049
Bram Moolenaar4c137212021-04-19 16:48:48 +02006050 ectx->ec_instr = save_instr;
6051 ectx->ec_iidx = save_iidx;
6052
6053 return res;
6054}
6055
6056/*
6057 * Call a "def" function from old Vim script.
6058 * Return OK or FAIL.
6059 */
6060 int
6061call_def_function(
6062 ufunc_T *ufunc,
6063 int argc_arg, // nr of arguments
6064 typval_T *argv, // arguments
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01006065 int flags, // DEF_ flags
Bram Moolenaar4c137212021-04-19 16:48:48 +02006066 partial_T *partial, // optional partial for context
Bram Moolenaarffdaca92022-12-09 21:41:48 +00006067 object_T *object, // object, e.g. for this.Func()
Bram Moolenaar58779852022-09-06 18:31:14 +01006068 funccall_T *funccal,
Bram Moolenaar4c137212021-04-19 16:48:48 +02006069 typval_T *rettv) // return value
6070{
6071 ectx_T ectx; // execution context
6072 int argc = argc_arg;
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01006073 int partial_argc = partial == NULL
6074 || (flags & DEF_USE_PT_ARGV) == 0
6075 ? 0 : partial->pt_argc;
6076 int total_argc = argc + partial_argc;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006077 typval_T *tv;
6078 int idx;
6079 int ret = FAIL;
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01006080 int defcount = ufunc->uf_args.ga_len - total_argc;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006081 sctx_T save_current_sctx = current_sctx;
6082 int did_emsg_before = did_emsg_cumul + did_emsg;
6083 int save_suppress_errthrow = suppress_errthrow;
6084 msglist_T **saved_msg_list = NULL;
6085 msglist_T *private_msg_list = NULL;
6086 int save_emsg_silent_def = emsg_silent_def;
6087 int save_did_emsg_def = did_emsg_def;
6088 int orig_funcdepth;
Bram Moolenaare99d4222021-06-13 14:01:26 +02006089 int orig_nesting_level = ex_nesting_level;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006090
6091// Get pointer to item in the stack.
6092#undef STACK_TV
6093#define STACK_TV(idx) (((typval_T *)ectx.ec_stack.ga_data) + idx)
6094
6095// Get pointer to item at the bottom of the stack, -1 is the bottom.
6096#undef STACK_TV_BOT
6097#define STACK_TV_BOT(idx) (((typval_T *)ectx.ec_stack.ga_data) + ectx.ec_stack.ga_len + idx)
6098
6099// Get pointer to a local variable on the stack. Negative for arguments.
6100#undef STACK_TV_VAR
6101#define STACK_TV_VAR(idx) (((typval_T *)ectx.ec_stack.ga_data) + ectx.ec_frame_idx + STACK_FRAME_SIZE + idx)
6102
6103 if (ufunc->uf_def_status == UF_NOT_COMPILED
6104 || ufunc->uf_def_status == UF_COMPILE_ERROR
Bram Moolenaar139575d2022-03-15 19:29:30 +00006105 || (func_needs_compiling(ufunc, get_compile_type(ufunc))
6106 && compile_def_function(ufunc, FALSE,
6107 get_compile_type(ufunc), NULL) == FAIL))
Bram Moolenaar4c137212021-04-19 16:48:48 +02006108 {
6109 if (did_emsg_cumul + did_emsg == did_emsg_before)
6110 semsg(_(e_function_is_not_compiled_str),
6111 printable_func_name(ufunc));
6112 return FAIL;
6113 }
6114
6115 {
6116 // Check the function was really compiled.
6117 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
6118 + ufunc->uf_dfunc_idx;
Bram Moolenaarcc341812022-09-19 15:54:34 +01006119 if (dfunc->df_ufunc == NULL)
6120 {
6121 semsg(_(e_function_was_deleted_str), printable_func_name(ufunc));
6122 return FAIL;
6123 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02006124 if (INSTRUCTIONS(dfunc) == NULL)
6125 {
6126 iemsg("using call_def_function() on not compiled function");
6127 return FAIL;
6128 }
6129 }
6130
6131 // If depth of calling is getting too high, don't execute the function.
6132 orig_funcdepth = funcdepth_get();
6133 if (funcdepth_increment() == FAIL)
6134 return FAIL;
6135
6136 CLEAR_FIELD(ectx);
6137 ectx.ec_dfunc_idx = ufunc->uf_dfunc_idx;
6138 ga_init2(&ectx.ec_stack, sizeof(typval_T), 500);
Bram Moolenaar35578162021-08-02 19:10:38 +02006139 if (GA_GROW_FAILS(&ectx.ec_stack, 20))
Bram Moolenaar4c137212021-04-19 16:48:48 +02006140 {
6141 funcdepth_decrement();
6142 return FAIL;
6143 }
6144 ga_init2(&ectx.ec_trystack, sizeof(trycmd_T), 10);
6145 ga_init2(&ectx.ec_funcrefs, sizeof(partial_T *), 10);
6146 ectx.ec_did_emsg_before = did_emsg_before;
Bram Moolenaare99d4222021-06-13 14:01:26 +02006147 ++ex_nesting_level;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006148
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01006149 idx = total_argc - ufunc->uf_args.ga_len;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006150 if (idx > 0 && ufunc->uf_va_name == NULL)
6151 {
Matvey Tarasovd14bb1a2022-06-29 13:18:27 +01006152 semsg(NGETTEXT(e_one_argument_too_many, e_nr_arguments_too_many,
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01006153 idx), idx);
Bram Moolenaar4c137212021-04-19 16:48:48 +02006154 goto failed_early;
6155 }
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01006156 idx = total_argc - ufunc->uf_args.ga_len + ufunc->uf_def_args.ga_len;
Bram Moolenaarc6d71532021-06-05 18:49:38 +02006157 if (idx < 0)
Bram Moolenaar8da6d6d2021-06-05 18:15:09 +02006158 {
Matvey Tarasovd14bb1a2022-06-29 13:18:27 +01006159 semsg(NGETTEXT(e_one_argument_too_few, e_nr_arguments_too_few,
Bram Moolenaar98aff652022-09-06 21:02:35 +01006160 -idx), -idx);
Bram Moolenaar8da6d6d2021-06-05 18:15:09 +02006161 goto failed_early;
6162 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02006163
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01006164 // Put values from the partial and arguments on the stack, but no more than
6165 // what the function expects. A lambda can be called with more arguments
6166 // than it uses.
6167 for (idx = 0; idx < total_argc
Bram Moolenaar4c137212021-04-19 16:48:48 +02006168 && (ufunc->uf_va_name != NULL || idx < ufunc->uf_args.ga_len);
6169 ++idx)
6170 {
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01006171 int argv_idx = idx - partial_argc;
6172
6173 tv = idx < partial_argc ? partial->pt_argv + idx : argv + argv_idx;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006174 if (idx >= ufunc->uf_args.ga_len - ufunc->uf_def_args.ga_len
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01006175 && tv->v_type == VAR_SPECIAL
6176 && tv->vval.v_number == VVAL_NONE)
Bram Moolenaar4c137212021-04-19 16:48:48 +02006177 {
6178 // Use the default value.
6179 STACK_TV_BOT(0)->v_type = VAR_UNKNOWN;
6180 }
6181 else
6182 {
Bram Moolenaar47bba532023-01-20 18:49:46 +00006183 int done = FALSE;
6184 if (ufunc->uf_arg_types != NULL && idx < ufunc->uf_args.ga_len)
6185 {
6186 type_T *expected = ufunc->uf_arg_types[idx];
6187 if (expected->tt_type == VAR_FLOAT && tv->v_type == VAR_NUMBER)
6188 {
6189 // When a float is expected and a number was given, convert
6190 // the value.
6191 STACK_TV_BOT(0)->v_type = VAR_FLOAT;
6192 STACK_TV_BOT(0)->v_lock = 0;
6193 STACK_TV_BOT(0)->vval.v_float = tv->vval.v_number;
6194 done = TRUE;
6195 }
6196 else if (check_typval_arg_type(expected, tv,
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01006197 NULL, argv_idx + 1) == FAIL)
Bram Moolenaar47bba532023-01-20 18:49:46 +00006198 goto failed_early;
6199 }
6200 if (!done)
6201 copy_tv(tv, STACK_TV_BOT(0));
Bram Moolenaar4c137212021-04-19 16:48:48 +02006202 }
6203 ++ectx.ec_stack.ga_len;
6204 }
6205
6206 // Turn varargs into a list. Empty list if no args.
6207 if (ufunc->uf_va_name != NULL)
6208 {
6209 int vararg_count = argc - ufunc->uf_args.ga_len;
6210
6211 if (vararg_count < 0)
6212 vararg_count = 0;
6213 else
6214 argc -= vararg_count;
6215 if (exe_newlist(vararg_count, &ectx) == FAIL)
6216 goto failed_early;
6217
6218 // Check the type of the list items.
6219 tv = STACK_TV_BOT(-1);
6220 if (ufunc->uf_va_type != NULL
6221 && ufunc->uf_va_type != &t_list_any
6222 && ufunc->uf_va_type->tt_member != &t_any
6223 && tv->vval.v_list != NULL)
6224 {
6225 type_T *expected = ufunc->uf_va_type->tt_member;
6226 listitem_T *li = tv->vval.v_list->lv_first;
6227
6228 for (idx = 0; idx < vararg_count; ++idx)
6229 {
6230 if (check_typval_arg_type(expected, &li->li_tv,
Bram Moolenaar7a3fe3e2021-07-22 14:58:47 +02006231 NULL, argc + idx + 1) == FAIL)
Bram Moolenaar4c137212021-04-19 16:48:48 +02006232 goto failed_early;
6233 li = li->li_next;
6234 }
6235 }
6236
6237 if (defcount > 0)
6238 // Move varargs list to below missing default arguments.
6239 *STACK_TV_BOT(defcount - 1) = *STACK_TV_BOT(-1);
6240 --ectx.ec_stack.ga_len;
6241 }
6242
6243 // Make space for omitted arguments, will store default value below.
6244 // Any varargs list goes after them.
6245 if (defcount > 0)
6246 for (idx = 0; idx < defcount; ++idx)
6247 {
6248 STACK_TV_BOT(0)->v_type = VAR_UNKNOWN;
6249 ++ectx.ec_stack.ga_len;
6250 }
6251 if (ufunc->uf_va_name != NULL)
6252 ++ectx.ec_stack.ga_len;
6253
6254 // Frame pointer points to just after arguments.
6255 ectx.ec_frame_idx = ectx.ec_stack.ga_len;
6256 ectx.ec_initial_frame_idx = ectx.ec_frame_idx;
6257
6258 {
6259 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
6260 + ufunc->uf_dfunc_idx;
6261 ufunc_T *base_ufunc = dfunc->df_ufunc;
6262
6263 // "uf_partial" is on the ufunc that "df_ufunc" points to, as is done
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01006264 // by copy_lambda_to_global_func().
Bram Moolenaar4c137212021-04-19 16:48:48 +02006265 if (partial != NULL || base_ufunc->uf_partial != NULL)
6266 {
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02006267 ectx.ec_outer_ref = ALLOC_CLEAR_ONE(outer_ref_T);
6268 if (ectx.ec_outer_ref == NULL)
Bram Moolenaar4c137212021-04-19 16:48:48 +02006269 goto failed_early;
6270 if (partial != NULL)
6271 {
Bram Moolenaar7aca5ca2022-02-07 19:56:43 +00006272 outer_T *outer = get_pt_outer(partial);
6273
Bram Moolenaar6d313be2022-09-22 16:36:25 +01006274 if (outer->out_stack == NULL && outer->out_loop_size == 0)
Bram Moolenaar4c137212021-04-19 16:48:48 +02006275 {
Bram Moolenaar6d313be2022-09-22 16:36:25 +01006276 // no stack was set
Bram Moolenaarfe1bfc92022-02-06 13:55:03 +00006277 if (current_ectx != NULL)
6278 {
6279 if (current_ectx->ec_outer_ref != NULL
6280 && current_ectx->ec_outer_ref->or_outer != NULL)
6281 ectx.ec_outer_ref->or_outer =
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02006282 current_ectx->ec_outer_ref->or_outer;
Bram Moolenaarfe1bfc92022-02-06 13:55:03 +00006283 }
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01006284 // else: should there be an error here?
Bram Moolenaar4c137212021-04-19 16:48:48 +02006285 }
6286 else
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02006287 {
Bram Moolenaar7aca5ca2022-02-07 19:56:43 +00006288 ectx.ec_outer_ref->or_outer = outer;
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02006289 ++partial->pt_refcount;
6290 ectx.ec_outer_ref->or_partial = partial;
6291 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02006292 }
6293 else
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02006294 {
6295 ectx.ec_outer_ref->or_outer = &base_ufunc->uf_partial->pt_outer;
6296 ++base_ufunc->uf_partial->pt_refcount;
6297 ectx.ec_outer_ref->or_partial = base_ufunc->uf_partial;
6298 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02006299 }
6300 }
6301
6302 // dummy frame entries
6303 for (idx = 0; idx < STACK_FRAME_SIZE; ++idx)
6304 {
6305 STACK_TV(ectx.ec_stack.ga_len)->v_type = VAR_UNKNOWN;
6306 ++ectx.ec_stack.ga_len;
6307 }
6308
6309 {
6310 // Reserve space for local variables and any closure reference count.
6311 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
6312 + ufunc->uf_dfunc_idx;
6313
Bram Moolenaar5cd64792021-12-25 18:23:24 +00006314 // Initialize variables to zero. That avoids having to generate
6315 // initializing instructions for "var nr: number", "var x: any", etc.
Bram Moolenaar4c137212021-04-19 16:48:48 +02006316 for (idx = 0; idx < dfunc->df_varcount; ++idx)
Bram Moolenaar5cd64792021-12-25 18:23:24 +00006317 {
6318 STACK_TV_VAR(idx)->v_type = VAR_NUMBER;
6319 STACK_TV_VAR(idx)->vval.v_number = 0;
6320 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02006321 ectx.ec_stack.ga_len += dfunc->df_varcount;
Bram Moolenaarffdaca92022-12-09 21:41:48 +00006322
6323 if (object != NULL)
6324 {
6325 // the object is always the variable at index zero
6326 tv = STACK_TV_VAR(0);
6327 tv->v_type = VAR_OBJECT;
6328 tv->vval.v_object = object;
6329 }
6330
Bram Moolenaar4c137212021-04-19 16:48:48 +02006331 if (dfunc->df_has_closure)
6332 {
Bram Moolenaarcc341812022-09-19 15:54:34 +01006333 // Initialize the variable that counts how many closures were
6334 // created. This is used in handle_closure_in_use().
Bram Moolenaar4c137212021-04-19 16:48:48 +02006335 STACK_TV_VAR(idx)->v_type = VAR_NUMBER;
6336 STACK_TV_VAR(idx)->vval.v_number = 0;
6337 ++ectx.ec_stack.ga_len;
6338 }
6339
6340 ectx.ec_instr = INSTRUCTIONS(dfunc);
6341 }
6342
Bram Moolenaar58779852022-09-06 18:31:14 +01006343 // Store the execution context in funccal, used by invoke_all_defer().
6344 if (funccal != NULL)
6345 funccal->fc_ectx = &ectx;
6346
Bram Moolenaar4c137212021-04-19 16:48:48 +02006347 // Following errors are in the function, not the caller.
6348 // Commands behave like vim9script.
6349 estack_push_ufunc(ufunc, 1);
6350 current_sctx = ufunc->uf_script_ctx;
6351 current_sctx.sc_version = SCRIPT_VERSION_VIM9;
6352
6353 // Use a specific location for storing error messages to be converted to an
6354 // exception.
6355 saved_msg_list = msg_list;
6356 msg_list = &private_msg_list;
6357
6358 // Do turn errors into exceptions.
6359 suppress_errthrow = FALSE;
6360
6361 // Do not delete the function while executing it.
6362 ++ufunc->uf_calls;
6363
6364 // When ":silent!" was used before calling then we still abort the
6365 // function. If ":silent!" is used in the function then we don't.
6366 emsg_silent_def = emsg_silent;
6367 did_emsg_def = 0;
6368
LemonBoyc5d27442023-08-19 13:02:35 +02006369 ectx.ec_where = (where_T)WHERE_INIT;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006370
Bram Moolenaar5800c792022-09-22 17:34:01 +01006371 /*
6372 * Execute the instructions until done.
6373 */
Bram Moolenaar4c137212021-04-19 16:48:48 +02006374 ret = exec_instructions(&ectx);
6375 if (ret == OK)
6376 {
6377 // function finished, get result from the stack.
6378 if (ufunc->uf_ret_type == &t_void)
6379 {
6380 rettv->v_type = VAR_VOID;
6381 }
6382 else
6383 {
6384 tv = STACK_TV_BOT(-1);
6385 *rettv = *tv;
6386 tv->v_type = VAR_UNKNOWN;
6387 }
6388 }
6389
Bram Moolenaar7eeefd42020-02-26 21:24:23 +01006390 // When failed need to unwind the call stack.
Bram Moolenaar58779852022-09-06 18:31:14 +01006391 unwind_def_callstack(&ectx);
Bram Moolenaarbf67ea12020-05-02 17:52:42 +02006392
Bram Moolenaarc70bdab2020-09-26 19:59:38 +02006393 // Deal with any remaining closures, they may be in use somewhere.
6394 if (ectx.ec_funcrefs.ga_len > 0)
Bram Moolenaarf112f302020-12-20 17:47:52 +01006395 {
Bram Moolenaarc70bdab2020-09-26 19:59:38 +02006396 handle_closure_in_use(&ectx, FALSE);
Bram Moolenaardc7c3662021-12-20 15:04:29 +00006397 ga_clear(&ectx.ec_funcrefs);
Bram Moolenaarf112f302020-12-20 17:47:52 +01006398 }
Bram Moolenaarc70bdab2020-09-26 19:59:38 +02006399
Bram Moolenaaree8580e2020-08-28 17:19:07 +02006400 estack_pop();
6401 current_sctx = save_current_sctx;
6402
Bram Moolenaar2336c372021-12-06 15:06:54 +00006403 if (--ufunc->uf_calls <= 0 && ufunc->uf_refcount <= 0)
6404 // Function was unreferenced while being used, free it now.
6405 func_clear_free(ufunc, FALSE);
Bram Moolenaarc970e422021-03-17 15:03:04 +01006406
Bram Moolenaar352134b2020-10-17 22:04:08 +02006407 if (*msg_list != NULL && saved_msg_list != NULL)
6408 {
6409 msglist_T **plist = saved_msg_list;
6410
6411 // Append entries from the current msg_list (uncaught exceptions) to
6412 // the saved msg_list.
6413 while (*plist != NULL)
6414 plist = &(*plist)->next;
6415
6416 *plist = *msg_list;
6417 }
6418 msg_list = saved_msg_list;
6419
Bram Moolenaar4c137212021-04-19 16:48:48 +02006420 if (ectx.ec_funclocal.floc_restore_cmdmod)
Bram Moolenaar02194d22020-10-24 23:08:38 +02006421 {
6422 cmdmod.cmod_filter_regmatch.regprog = NULL;
6423 undo_cmdmod(&cmdmod);
Bram Moolenaar4c137212021-04-19 16:48:48 +02006424 cmdmod = ectx.ec_funclocal.floc_save_cmdmod;
Bram Moolenaar02194d22020-10-24 23:08:38 +02006425 }
Bram Moolenaar56602ba2020-12-05 21:22:08 +01006426 emsg_silent_def = save_emsg_silent_def;
6427 did_emsg_def += save_did_emsg_def;
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +02006428
Bram Moolenaaree8580e2020-08-28 17:19:07 +02006429failed_early:
Bram Moolenaar0d1f55c2022-04-05 17:30:29 +01006430 // Free all arguments and local variables.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006431 for (idx = 0; idx < ectx.ec_stack.ga_len; ++idx)
Bram Moolenaar1936c762022-09-28 15:19:10 +01006432 {
6433 tv = STACK_TV(idx);
6434 if (tv->v_type != VAR_NUMBER && tv->v_type != VAR_UNKNOWN)
6435 clear_tv(tv);
6436 }
Bram Moolenaare99d4222021-06-13 14:01:26 +02006437 ex_nesting_level = orig_nesting_level;
Bram Moolenaarbf67ea12020-05-02 17:52:42 +02006438
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006439 vim_free(ectx.ec_stack.ga_data);
Bram Moolenaar20431c92020-03-20 18:39:46 +01006440 vim_free(ectx.ec_trystack.ga_data);
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02006441 if (ectx.ec_outer_ref != NULL)
Bram Moolenaar0186e582021-01-10 18:33:11 +01006442 {
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02006443 if (ectx.ec_outer_ref->or_outer_allocated)
6444 vim_free(ectx.ec_outer_ref->or_outer);
6445 partial_unref(ectx.ec_outer_ref->or_partial);
6446 vim_free(ectx.ec_outer_ref);
Bram Moolenaar0186e582021-01-10 18:33:11 +01006447 }
6448
Bram Moolenaar77e5dcc2020-09-17 21:29:03 +02006449 // Not sure if this is necessary.
6450 suppress_errthrow = save_suppress_errthrow;
6451
Bram Moolenaarb5841b92021-07-15 18:09:53 +02006452 if (ret != OK && did_emsg_cumul + did_emsg == did_emsg_before
6453 && !need_rethrow)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02006454 semsg(_(e_unknown_error_while_executing_str),
Bram Moolenaar682d0a12020-07-19 20:48:59 +02006455 printable_func_name(ufunc));
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01006456 funcdepth_restore(orig_funcdepth);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006457 return ret;
6458}
6459
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006460/*
Bram Moolenaar58779852022-09-06 18:31:14 +01006461 * Called when a def function has finished (possibly failed).
6462 * Invoke all the function returns to clean up and invoke deferred functions,
6463 * except the toplevel one.
6464 */
6465 void
6466unwind_def_callstack(ectx_T *ectx)
6467{
6468 while (ectx->ec_frame_idx != ectx->ec_initial_frame_idx)
6469 func_return(ectx);
6470}
6471
6472/*
dundargocc57b5bc2022-11-02 13:30:51 +00006473 * Invoke any deferred functions for the top function in "ectx".
Bram Moolenaar58779852022-09-06 18:31:14 +01006474 */
6475 void
6476may_invoke_defer_funcs(ectx_T *ectx)
6477{
6478 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data) + ectx->ec_dfunc_idx;
6479
6480 if (dfunc->df_defer_var_idx > 0)
6481 invoke_defer_funcs(ectx);
6482}
6483
6484/*
Bram Moolenaarcc341812022-09-19 15:54:34 +01006485 * Return loopvarinfo in a printable form in allocated memory.
6486 */
6487 static char_u *
6488printable_loopvarinfo(loopvarinfo_T *lvi)
6489{
6490 garray_T ga;
6491 int depth;
6492
6493 ga_init2(&ga, 1, 100);
6494 for (depth = 0; depth < lvi->lvi_depth; ++depth)
6495 {
6496 if (ga_grow(&ga, 50) == FAIL)
6497 break;
6498 if (lvi->lvi_loop[depth].var_idx == 0)
Bram Moolenaarc9e4a6f2022-09-19 16:08:04 +01006499 STRCPY((char *)ga.ga_data + ga.ga_len, " -");
Bram Moolenaarcc341812022-09-19 15:54:34 +01006500 else
Bram Moolenaarc9e4a6f2022-09-19 16:08:04 +01006501 vim_snprintf((char *)ga.ga_data + ga.ga_len, 50, " $%d-$%d",
Bram Moolenaarcc341812022-09-19 15:54:34 +01006502 lvi->lvi_loop[depth].var_idx,
6503 lvi->lvi_loop[depth].var_idx
6504 + lvi->lvi_loop[depth].var_count - 1);
Bram Moolenaarc9e4a6f2022-09-19 16:08:04 +01006505 ga.ga_len = (int)STRLEN(ga.ga_data);
Bram Moolenaarcc341812022-09-19 15:54:34 +01006506 }
6507 return ga.ga_data;
6508}
6509
6510/*
Bram Moolenaar4c137212021-04-19 16:48:48 +02006511 * List instructions "instr" up to "instr_count" or until ISN_FINISH.
6512 * "ufunc" has the source lines, NULL for the instructions of ISN_SUBSTITUTE.
6513 * "pfx" is prefixed to every line.
6514 */
6515 static void
6516list_instructions(char *pfx, isn_T *instr, int instr_count, ufunc_T *ufunc)
6517{
6518 int line_idx = 0;
6519 int prev_current = 0;
6520 int current;
Bram Moolenaar9ce47ec2021-04-20 22:16:39 +02006521 int def_arg_idx = 0;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006522
6523 for (current = 0; current < instr_count; ++current)
6524 {
6525 isn_T *iptr = &instr[current];
6526 char *line;
6527
6528 if (ufunc != NULL)
Bram Moolenaar9ce47ec2021-04-20 22:16:39 +02006529 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02006530 while (line_idx < iptr->isn_lnum
6531 && line_idx < ufunc->uf_lines.ga_len)
6532 {
6533 if (current > prev_current)
6534 {
6535 msg_puts("\n\n");
6536 prev_current = current;
6537 }
6538 line = ((char **)ufunc->uf_lines.ga_data)[line_idx++];
6539 if (line != NULL)
6540 msg(line);
6541 }
Bram Moolenaar9ce47ec2021-04-20 22:16:39 +02006542 if (iptr->isn_type == ISN_JUMP_IF_ARG_SET)
6543 {
6544 int first_def_arg = ufunc->uf_args.ga_len
6545 - ufunc->uf_def_args.ga_len;
6546
6547 if (def_arg_idx > 0)
6548 msg_puts("\n\n");
6549 msg_start();
6550 msg_puts(" ");
6551 msg_puts(((char **)(ufunc->uf_args.ga_data))[
6552 first_def_arg + def_arg_idx]);
6553 msg_puts(" = ");
6554 msg_puts(((char **)(ufunc->uf_def_args.ga_data))[def_arg_idx++]);
6555 msg_clr_eos();
6556 msg_end();
6557 }
6558 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02006559
6560 switch (iptr->isn_type)
6561 {
Bram Moolenaar00b28d62022-12-08 15:32:33 +00006562 case ISN_CONSTRUCT:
6563 smsg("%s%4d NEW %s size %d", pfx, current,
6564 iptr->isn_arg.construct.construct_class->class_name,
6565 (int)iptr->isn_arg.construct.construct_size);
6566 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006567 case ISN_EXEC:
6568 smsg("%s%4d EXEC %s", pfx, current, iptr->isn_arg.string);
6569 break;
Bram Moolenaar20677332021-06-06 17:02:53 +02006570 case ISN_EXEC_SPLIT:
6571 smsg("%s%4d EXEC_SPLIT %s", pfx, current, iptr->isn_arg.string);
6572 break;
Bram Moolenaare4eed8c2021-12-01 15:22:56 +00006573 case ISN_EXECRANGE:
6574 smsg("%s%4d EXECRANGE %s", pfx, current, iptr->isn_arg.string);
6575 break;
Bram Moolenaar3b1373b2021-05-17 00:01:42 +02006576 case ISN_LEGACY_EVAL:
6577 smsg("%s%4d EVAL legacy %s", pfx, current,
6578 iptr->isn_arg.string);
6579 break;
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02006580 case ISN_REDIRSTART:
6581 smsg("%s%4d REDIR", pfx, current);
6582 break;
6583 case ISN_REDIREND:
6584 smsg("%s%4d REDIR END%s", pfx, current,
6585 iptr->isn_arg.number ? " append" : "");
6586 break;
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02006587 case ISN_CEXPR_AUCMD:
Bram Moolenaarb7c97812021-05-05 22:51:39 +02006588#ifdef FEAT_QUICKFIX
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02006589 smsg("%s%4d CEXPR pre %s", pfx, current,
6590 cexpr_get_auname(iptr->isn_arg.number));
Bram Moolenaarb7c97812021-05-05 22:51:39 +02006591#endif
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02006592 break;
6593 case ISN_CEXPR_CORE:
Bram Moolenaarb7c97812021-05-05 22:51:39 +02006594#ifdef FEAT_QUICKFIX
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02006595 {
6596 cexprref_T *cer = iptr->isn_arg.cexpr.cexpr_ref;
6597
6598 smsg("%s%4d CEXPR core %s%s \"%s\"", pfx, current,
6599 cexpr_get_auname(cer->cer_cmdidx),
6600 cer->cer_forceit ? "!" : "",
6601 cer->cer_cmdline);
6602 }
Bram Moolenaarb7c97812021-05-05 22:51:39 +02006603#endif
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02006604 break;
Bram Moolenaarf18332f2021-05-07 17:55:55 +02006605 case ISN_INSTR:
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01006606 smsg("%s%4d INSTR", pfx, current);
6607 list_instructions(" ", iptr->isn_arg.instr, INT_MAX, NULL);
6608 msg(" -------------");
6609 break;
6610 case ISN_SOURCE:
Bram Moolenaarf18332f2021-05-07 17:55:55 +02006611 {
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01006612 scriptitem_T *si = SCRIPT_ITEM(iptr->isn_arg.number);
6613
6614 smsg("%s%4d SOURCE %s", pfx, current, si->sn_name);
Bram Moolenaarf18332f2021-05-07 17:55:55 +02006615 }
6616 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006617 case ISN_SUBSTITUTE:
6618 {
6619 subs_T *subs = &iptr->isn_arg.subs;
6620
6621 smsg("%s%4d SUBSTITUTE %s", pfx, current, subs->subs_cmd);
6622 list_instructions(" ", subs->subs_instr, INT_MAX, NULL);
6623 msg(" -------------");
6624 }
6625 break;
6626 case ISN_EXECCONCAT:
6627 smsg("%s%4d EXECCONCAT %lld", pfx, current,
6628 (varnumber_T)iptr->isn_arg.number);
6629 break;
6630 case ISN_ECHO:
6631 {
6632 echo_T *echo = &iptr->isn_arg.echo;
6633
6634 smsg("%s%4d %s %d", pfx, current,
6635 echo->echo_with_white ? "ECHO" : "ECHON",
6636 echo->echo_count);
6637 }
6638 break;
6639 case ISN_EXECUTE:
6640 smsg("%s%4d EXECUTE %lld", pfx, current,
Bram Moolenaar7de62622021-08-07 15:05:47 +02006641 (varnumber_T)(iptr->isn_arg.number));
Bram Moolenaar4c137212021-04-19 16:48:48 +02006642 break;
6643 case ISN_ECHOMSG:
6644 smsg("%s%4d ECHOMSG %lld", pfx, current,
Bram Moolenaar7de62622021-08-07 15:05:47 +02006645 (varnumber_T)(iptr->isn_arg.number));
6646 break;
Bram Moolenaar7d7ad7b2022-09-01 16:00:53 +01006647 case ISN_ECHOWINDOW:
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01006648 if (iptr->isn_arg.echowin.ewin_time > 0)
6649 smsg("%s%4d ECHOWINDOW %d (%ld sec)", pfx, current,
6650 iptr->isn_arg.echowin.ewin_count,
6651 iptr->isn_arg.echowin.ewin_time);
6652 else
6653 smsg("%s%4d ECHOWINDOW %d", pfx, current,
6654 iptr->isn_arg.echowin.ewin_count);
Bram Moolenaar7d7ad7b2022-09-01 16:00:53 +01006655 break;
Bram Moolenaar7de62622021-08-07 15:05:47 +02006656 case ISN_ECHOCONSOLE:
6657 smsg("%s%4d ECHOCONSOLE %lld", pfx, current,
6658 (varnumber_T)(iptr->isn_arg.number));
Bram Moolenaar4c137212021-04-19 16:48:48 +02006659 break;
6660 case ISN_ECHOERR:
6661 smsg("%s%4d ECHOERR %lld", pfx, current,
Bram Moolenaar7de62622021-08-07 15:05:47 +02006662 (varnumber_T)(iptr->isn_arg.number));
Bram Moolenaar4c137212021-04-19 16:48:48 +02006663 break;
6664 case ISN_LOAD:
6665 {
6666 if (iptr->isn_arg.number < 0)
6667 smsg("%s%4d LOAD arg[%lld]", pfx, current,
6668 (varnumber_T)(iptr->isn_arg.number
6669 + STACK_FRAME_SIZE));
6670 else
6671 smsg("%s%4d LOAD $%lld", pfx, current,
6672 (varnumber_T)(iptr->isn_arg.number));
6673 }
6674 break;
6675 case ISN_LOADOUTER:
6676 {
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01006677 isn_outer_T *outer = &iptr->isn_arg.outer;
6678
6679 if (outer->outer_idx < 0)
Bram Moolenaar4c137212021-04-19 16:48:48 +02006680 smsg("%s%4d LOADOUTER level %d arg[%d]", pfx, current,
Bram Moolenaarcc341812022-09-19 15:54:34 +01006681 outer->outer_depth,
6682 outer->outer_idx + STACK_FRAME_SIZE);
6683 else if (outer->outer_depth < 0)
6684 smsg("%s%4d LOADOUTER $%d in loop level %d",
6685 pfx, current,
6686 outer->outer_idx,
6687 -outer->outer_depth);
Bram Moolenaar4c137212021-04-19 16:48:48 +02006688 else
6689 smsg("%s%4d LOADOUTER level %d $%d", pfx, current,
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01006690 outer->outer_depth,
6691 outer->outer_idx);
Bram Moolenaar4c137212021-04-19 16:48:48 +02006692 }
6693 break;
6694 case ISN_LOADV:
6695 smsg("%s%4d LOADV v:%s", pfx, current,
6696 get_vim_var_name(iptr->isn_arg.number));
6697 break;
6698 case ISN_LOADSCRIPT:
6699 {
Bram Moolenaar6db660b2021-08-01 14:08:54 +02006700 scriptref_T *sref = iptr->isn_arg.script.scriptref;
6701 scriptitem_T *si = SCRIPT_ITEM(sref->sref_sid);
6702 svar_T *sv;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006703
Bram Moolenaar6db660b2021-08-01 14:08:54 +02006704 sv = get_script_svar(sref, -1);
6705 if (sv == NULL)
6706 smsg("%s%4d LOADSCRIPT [deleted] from %s",
6707 pfx, current, si->sn_name);
6708 else
6709 smsg("%s%4d LOADSCRIPT %s-%d from %s", pfx, current,
Bram Moolenaar4c137212021-04-19 16:48:48 +02006710 sv->sv_name,
6711 sref->sref_idx,
6712 si->sn_name);
6713 }
6714 break;
6715 case ISN_LOADS:
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01006716 case ISN_LOADEXPORT:
Bram Moolenaar4c137212021-04-19 16:48:48 +02006717 {
6718 scriptitem_T *si = SCRIPT_ITEM(
6719 iptr->isn_arg.loadstore.ls_sid);
6720
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01006721 smsg("%s%4d %s s:%s from %s", pfx, current,
6722 iptr->isn_type == ISN_LOADS ? "LOADS"
6723 : "LOADEXPORT",
6724 iptr->isn_arg.loadstore.ls_name, si->sn_name);
Bram Moolenaar4c137212021-04-19 16:48:48 +02006725 }
6726 break;
6727 case ISN_LOADAUTO:
6728 smsg("%s%4d LOADAUTO %s", pfx, current, iptr->isn_arg.string);
6729 break;
6730 case ISN_LOADG:
6731 smsg("%s%4d LOADG g:%s", pfx, current, iptr->isn_arg.string);
6732 break;
6733 case ISN_LOADB:
6734 smsg("%s%4d LOADB b:%s", pfx, current, iptr->isn_arg.string);
6735 break;
6736 case ISN_LOADW:
6737 smsg("%s%4d LOADW w:%s", pfx, current, iptr->isn_arg.string);
6738 break;
6739 case ISN_LOADT:
6740 smsg("%s%4d LOADT t:%s", pfx, current, iptr->isn_arg.string);
6741 break;
6742 case ISN_LOADGDICT:
6743 smsg("%s%4d LOAD g:", pfx, current);
6744 break;
6745 case ISN_LOADBDICT:
6746 smsg("%s%4d LOAD b:", pfx, current);
6747 break;
6748 case ISN_LOADWDICT:
6749 smsg("%s%4d LOAD w:", pfx, current);
6750 break;
6751 case ISN_LOADTDICT:
6752 smsg("%s%4d LOAD t:", pfx, current);
6753 break;
6754 case ISN_LOADOPT:
6755 smsg("%s%4d LOADOPT %s", pfx, current, iptr->isn_arg.string);
6756 break;
6757 case ISN_LOADENV:
6758 smsg("%s%4d LOADENV %s", pfx, current, iptr->isn_arg.string);
6759 break;
6760 case ISN_LOADREG:
Bram Moolenaar6db660b2021-08-01 14:08:54 +02006761 smsg("%s%4d LOADREG @%c", pfx, current,
6762 (int)(iptr->isn_arg.number));
Bram Moolenaar4c137212021-04-19 16:48:48 +02006763 break;
6764
6765 case ISN_STORE:
6766 if (iptr->isn_arg.number < 0)
6767 smsg("%s%4d STORE arg[%lld]", pfx, current,
6768 iptr->isn_arg.number + STACK_FRAME_SIZE);
6769 else
Bram Moolenaar6db660b2021-08-01 14:08:54 +02006770 smsg("%s%4d STORE $%lld", pfx, current,
6771 iptr->isn_arg.number);
Bram Moolenaar4c137212021-04-19 16:48:48 +02006772 break;
6773 case ISN_STOREOUTER:
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01006774 {
6775 isn_outer_T *outer = &iptr->isn_arg.outer;
6776
6777 if (outer->outer_depth == OUTER_LOOP_DEPTH)
6778 smsg("%s%4d STOREOUTER level 1 $%d in loop",
6779 pfx, current, outer->outer_idx);
6780 else
6781 smsg("%s%4d STOREOUTER level %d $%d", pfx, current,
6782 outer->outer_depth, outer->outer_idx);
6783 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02006784 break;
6785 case ISN_STOREV:
6786 smsg("%s%4d STOREV v:%s", pfx, current,
6787 get_vim_var_name(iptr->isn_arg.number));
6788 break;
6789 case ISN_STOREAUTO:
6790 smsg("%s%4d STOREAUTO %s", pfx, current, iptr->isn_arg.string);
6791 break;
6792 case ISN_STOREG:
6793 smsg("%s%4d STOREG %s", pfx, current, iptr->isn_arg.string);
6794 break;
6795 case ISN_STOREB:
6796 smsg("%s%4d STOREB %s", pfx, current, iptr->isn_arg.string);
6797 break;
6798 case ISN_STOREW:
6799 smsg("%s%4d STOREW %s", pfx, current, iptr->isn_arg.string);
6800 break;
6801 case ISN_STORET:
6802 smsg("%s%4d STORET %s", pfx, current, iptr->isn_arg.string);
6803 break;
6804 case ISN_STORES:
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01006805 case ISN_STOREEXPORT:
Bram Moolenaar4c137212021-04-19 16:48:48 +02006806 {
6807 scriptitem_T *si = SCRIPT_ITEM(
6808 iptr->isn_arg.loadstore.ls_sid);
6809
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01006810 smsg("%s%4d %s %s in %s", pfx, current,
6811 iptr->isn_type == ISN_STORES
6812 ? "STORES" : "STOREEXPORT",
Bram Moolenaar4c137212021-04-19 16:48:48 +02006813 iptr->isn_arg.loadstore.ls_name, si->sn_name);
6814 }
6815 break;
6816 case ISN_STORESCRIPT:
6817 {
Bram Moolenaar6db660b2021-08-01 14:08:54 +02006818 scriptref_T *sref = iptr->isn_arg.script.scriptref;
6819 scriptitem_T *si = SCRIPT_ITEM(sref->sref_sid);
6820 svar_T *sv;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006821
Bram Moolenaar6db660b2021-08-01 14:08:54 +02006822 sv = get_script_svar(sref, -1);
6823 if (sv == NULL)
6824 smsg("%s%4d STORESCRIPT [deleted] in %s",
6825 pfx, current, si->sn_name);
6826 else
6827 smsg("%s%4d STORESCRIPT %s-%d in %s", pfx, current,
Bram Moolenaar4c137212021-04-19 16:48:48 +02006828 sv->sv_name,
6829 sref->sref_idx,
6830 si->sn_name);
6831 }
6832 break;
6833 case ISN_STOREOPT:
Bram Moolenaardcb53be2021-12-09 14:23:43 +00006834 case ISN_STOREFUNCOPT:
6835 smsg("%s%4d %s &%s", pfx, current,
6836 iptr->isn_type == ISN_STOREOPT ? "STOREOPT" : "STOREFUNCOPT",
Bram Moolenaar4c137212021-04-19 16:48:48 +02006837 iptr->isn_arg.storeopt.so_name);
6838 break;
6839 case ISN_STOREENV:
6840 smsg("%s%4d STOREENV $%s", pfx, current, iptr->isn_arg.string);
6841 break;
6842 case ISN_STOREREG:
Bram Moolenaar6db660b2021-08-01 14:08:54 +02006843 smsg("%s%4d STOREREG @%c", pfx, current,
6844 (int)iptr->isn_arg.number);
Bram Moolenaar4c137212021-04-19 16:48:48 +02006845 break;
6846 case ISN_STORENR:
6847 smsg("%s%4d STORE %lld in $%d", pfx, current,
6848 iptr->isn_arg.storenr.stnr_val,
6849 iptr->isn_arg.storenr.stnr_idx);
6850 break;
6851
6852 case ISN_STOREINDEX:
6853 smsg("%s%4d STOREINDEX %s", pfx, current,
Bram Moolenaarf7d1c6e2023-01-16 20:47:57 +00006854 vartype_name(iptr->isn_arg.storeindex.si_vartype));
Bram Moolenaar4c137212021-04-19 16:48:48 +02006855 break;
6856
6857 case ISN_STORERANGE:
6858 smsg("%s%4d STORERANGE", pfx, current);
6859 break;
6860
Bram Moolenaard505d172022-12-18 21:42:55 +00006861 case ISN_LOAD_CLASSMEMBER:
6862 case ISN_STORE_CLASSMEMBER:
6863 {
6864 class_T *cl = iptr->isn_arg.classmember.cm_class;
6865 int idx = iptr->isn_arg.classmember.cm_idx;
6866 ocmember_T *ocm = &cl->class_class_members[idx];
6867 smsg("%s%4d %s CLASSMEMBER %s.%s", pfx, current,
6868 iptr->isn_type == ISN_LOAD_CLASSMEMBER
6869 ? "LOAD" : "STORE",
6870 cl->class_name, ocm->ocm_name);
6871 }
6872 break;
6873
Bram Moolenaar4c137212021-04-19 16:48:48 +02006874 // constants
6875 case ISN_PUSHNR:
6876 smsg("%s%4d PUSHNR %lld", pfx, current,
6877 (varnumber_T)(iptr->isn_arg.number));
6878 break;
6879 case ISN_PUSHBOOL:
6880 case ISN_PUSHSPEC:
6881 smsg("%s%4d PUSH %s", pfx, current,
6882 get_var_special_name(iptr->isn_arg.number));
6883 break;
6884 case ISN_PUSHF:
Bram Moolenaar4c137212021-04-19 16:48:48 +02006885 smsg("%s%4d PUSHF %g", pfx, current, iptr->isn_arg.fnumber);
Bram Moolenaar4c137212021-04-19 16:48:48 +02006886 break;
6887 case ISN_PUSHS:
6888 smsg("%s%4d PUSHS \"%s\"", pfx, current, iptr->isn_arg.string);
6889 break;
6890 case ISN_PUSHBLOB:
6891 {
6892 char_u *r;
6893 char_u numbuf[NUMBUFLEN];
6894 char_u *tofree;
6895
6896 r = blob2string(iptr->isn_arg.blob, &tofree, numbuf);
6897 smsg("%s%4d PUSHBLOB %s", pfx, current, r);
6898 vim_free(tofree);
6899 }
6900 break;
6901 case ISN_PUSHFUNC:
6902 {
6903 char *name = (char *)iptr->isn_arg.string;
6904
6905 smsg("%s%4d PUSHFUNC \"%s\"", pfx, current,
6906 name == NULL ? "[none]" : name);
6907 }
6908 break;
6909 case ISN_PUSHCHANNEL:
6910#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar397a87a2022-03-20 21:14:15 +00006911 smsg("%s%4d PUSHCHANNEL 0", pfx, current);
Bram Moolenaar4c137212021-04-19 16:48:48 +02006912#endif
6913 break;
6914 case ISN_PUSHJOB:
6915#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar397a87a2022-03-20 21:14:15 +00006916 smsg("%s%4d PUSHJOB \"no process\"", pfx, current);
Bram Moolenaar4c137212021-04-19 16:48:48 +02006917#endif
6918 break;
Bram Moolenaarc4e1b862023-02-26 18:58:23 +00006919 case ISN_PUSHOBJ:
6920 smsg("%s%4d PUSHOBJ null", pfx, current);
6921 break;
6922 case ISN_PUSHCLASS:
6923 smsg("%s%4d PUSHCLASS %s", pfx, current,
Bram Moolenaar30a84472023-02-27 08:07:14 +00006924 iptr->isn_arg.classarg == NULL ? "null"
6925 : (char *)iptr->isn_arg.classarg->class_name);
Bram Moolenaarc4e1b862023-02-26 18:58:23 +00006926 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006927 case ISN_PUSHEXC:
6928 smsg("%s%4d PUSH v:exception", pfx, current);
6929 break;
Bram Moolenaar06b77222022-01-25 15:51:56 +00006930 case ISN_AUTOLOAD:
6931 smsg("%s%4d AUTOLOAD %s", pfx, current, iptr->isn_arg.string);
6932 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006933 case ISN_UNLET:
6934 smsg("%s%4d UNLET%s %s", pfx, current,
6935 iptr->isn_arg.unlet.ul_forceit ? "!" : "",
6936 iptr->isn_arg.unlet.ul_name);
6937 break;
6938 case ISN_UNLETENV:
6939 smsg("%s%4d UNLETENV%s $%s", pfx, current,
6940 iptr->isn_arg.unlet.ul_forceit ? "!" : "",
6941 iptr->isn_arg.unlet.ul_name);
6942 break;
6943 case ISN_UNLETINDEX:
6944 smsg("%s%4d UNLETINDEX", pfx, current);
6945 break;
6946 case ISN_UNLETRANGE:
6947 smsg("%s%4d UNLETRANGE", pfx, current);
6948 break;
Bram Moolenaaraacc9662021-08-13 19:40:51 +02006949 case ISN_LOCKUNLOCK:
6950 smsg("%s%4d LOCKUNLOCK %s", pfx, current, iptr->isn_arg.string);
6951 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006952 case ISN_LOCKCONST:
6953 smsg("%s%4d LOCKCONST", pfx, current);
6954 break;
6955 case ISN_NEWLIST:
6956 smsg("%s%4d NEWLIST size %lld", pfx, current,
Bram Moolenaar1936c762022-09-28 15:19:10 +01006957 (varnumber_T)(iptr->isn_arg.number));
Bram Moolenaar4c137212021-04-19 16:48:48 +02006958 break;
6959 case ISN_NEWDICT:
6960 smsg("%s%4d NEWDICT size %lld", pfx, current,
Bram Moolenaar1936c762022-09-28 15:19:10 +01006961 (varnumber_T)(iptr->isn_arg.number));
Bram Moolenaar4c137212021-04-19 16:48:48 +02006962 break;
Bram Moolenaar8acb9cc2022-03-08 13:18:55 +00006963 case ISN_NEWPARTIAL:
6964 smsg("%s%4d NEWPARTIAL", pfx, current);
6965 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006966
6967 // function call
6968 case ISN_BCALL:
6969 {
6970 cbfunc_T *cbfunc = &iptr->isn_arg.bfunc;
6971
6972 smsg("%s%4d BCALL %s(argc %d)", pfx, current,
6973 internal_func_name(cbfunc->cbf_idx),
6974 cbfunc->cbf_argcount);
6975 }
6976 break;
6977 case ISN_DCALL:
6978 {
6979 cdfunc_T *cdfunc = &iptr->isn_arg.dfunc;
6980 dfunc_T *df = ((dfunc_T *)def_functions.ga_data)
6981 + cdfunc->cdf_idx;
6982
6983 smsg("%s%4d DCALL %s(argc %d)", pfx, current,
Bram Moolenaar6db660b2021-08-01 14:08:54 +02006984 printable_func_name(df->df_ufunc),
6985 cdfunc->cdf_argcount);
Bram Moolenaar4c137212021-04-19 16:48:48 +02006986 }
6987 break;
Bram Moolenaard0200c82023-01-28 15:19:40 +00006988 case ISN_METHODCALL:
6989 {
6990 cmfunc_T *mfunc = iptr->isn_arg.mfunc;
6991
6992 smsg("%s%4d METHODCALL %s.%s(argc %d)", pfx, current,
6993 mfunc->cmf_itf->class_name,
6994 mfunc->cmf_itf->class_obj_methods[
6995 mfunc->cmf_idx]->uf_name,
6996 mfunc->cmf_argcount);
6997 }
6998 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006999 case ISN_UCALL:
7000 {
7001 cufunc_T *cufunc = &iptr->isn_arg.ufunc;
7002
7003 smsg("%s%4d UCALL %s(argc %d)", pfx, current,
7004 cufunc->cuf_name, cufunc->cuf_argcount);
7005 }
7006 break;
7007 case ISN_PCALL:
7008 {
7009 cpfunc_T *cpfunc = &iptr->isn_arg.pfunc;
7010
7011 smsg("%s%4d PCALL%s (argc %d)", pfx, current,
7012 cpfunc->cpf_top ? " top" : "", cpfunc->cpf_argcount);
7013 }
7014 break;
7015 case ISN_PCALL_END:
7016 smsg("%s%4d PCALL end", pfx, current);
7017 break;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01007018 case ISN_DEFER:
Yegappan Lakshmananf3eac692023-10-17 11:00:45 +02007019 smsg("%s%4d DEFER %d args", pfx, current,
Bram Moolenaar1d84f762022-09-03 21:35:53 +01007020 (int)iptr->isn_arg.defer.defer_argcount);
7021 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007022 case ISN_RETURN:
7023 smsg("%s%4d RETURN", pfx, current);
7024 break;
Bram Moolenaarf57b43c2021-06-15 22:13:27 +02007025 case ISN_RETURN_VOID:
7026 smsg("%s%4d RETURN void", pfx, current);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007027 break;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00007028 case ISN_RETURN_OBJECT:
7029 smsg("%s%4d RETURN object", pfx, current);
7030 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007031 case ISN_FUNCREF:
7032 {
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01007033 funcref_T *funcref = &iptr->isn_arg.funcref;
7034 funcref_extra_T *extra = funcref->fr_extra;
7035 char_u *name;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007036
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01007037 if (extra == NULL || extra->fre_func_name == NULL)
Bram Moolenaar38453522021-11-28 22:00:12 +00007038 {
7039 dfunc_T *df = ((dfunc_T *)def_functions.ga_data)
7040 + funcref->fr_dfunc_idx;
7041 name = df->df_ufunc->uf_name;
7042 }
7043 else
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01007044 name = extra->fre_func_name;
Bram Moolenaar313e4722023-02-08 20:55:27 +00007045 if (extra != NULL && extra->fre_class != NULL)
7046 {
7047 smsg("%s%4d FUNCREF %s.%s", pfx, current,
7048 extra->fre_class->class_name, name);
7049 }
7050 else if (extra == NULL
7051 || extra->fre_loopvar_info.lvi_depth == 0)
7052 {
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01007053 smsg("%s%4d FUNCREF %s", pfx, current, name);
Bram Moolenaar313e4722023-02-08 20:55:27 +00007054 }
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01007055 else
Bram Moolenaarcc341812022-09-19 15:54:34 +01007056 {
7057 char_u *info = printable_loopvarinfo(
7058 &extra->fre_loopvar_info);
7059
7060 smsg("%s%4d FUNCREF %s vars %s", pfx, current,
7061 name, info);
7062 vim_free(info);
7063 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02007064 }
7065 break;
7066
7067 case ISN_NEWFUNC:
7068 {
Bram Moolenaarcc341812022-09-19 15:54:34 +01007069 newfuncarg_T *arg = iptr->isn_arg.newfunc.nf_arg;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007070
Bram Moolenaarcc341812022-09-19 15:54:34 +01007071 if (arg->nfa_loopvar_info.lvi_depth == 0)
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01007072 smsg("%s%4d NEWFUNC %s %s", pfx, current,
7073 arg->nfa_lambda, arg->nfa_global);
7074 else
Bram Moolenaarcc341812022-09-19 15:54:34 +01007075 {
7076 char_u *info = printable_loopvarinfo(
7077 &arg->nfa_loopvar_info);
7078
7079 smsg("%s%4d NEWFUNC %s %s vars %s", pfx, current,
7080 arg->nfa_lambda, arg->nfa_global, info);
7081 vim_free(info);
7082 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02007083 }
7084 break;
7085
7086 case ISN_DEF:
7087 {
7088 char_u *name = iptr->isn_arg.string;
7089
7090 smsg("%s%4d DEF %s", pfx, current,
7091 name == NULL ? (char_u *)"" : name);
7092 }
7093 break;
7094
7095 case ISN_JUMP:
7096 {
7097 char *when = "?";
7098
7099 switch (iptr->isn_arg.jump.jump_when)
7100 {
7101 case JUMP_ALWAYS:
7102 when = "JUMP";
7103 break;
Bram Moolenaar1a7ee4d2021-09-16 16:15:07 +02007104 case JUMP_NEVER:
7105 iemsg("JUMP_NEVER should not be used");
7106 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007107 case JUMP_AND_KEEP_IF_TRUE:
7108 when = "JUMP_AND_KEEP_IF_TRUE";
7109 break;
7110 case JUMP_IF_FALSE:
7111 when = "JUMP_IF_FALSE";
7112 break;
Bram Moolenaarb46c0832022-09-15 17:19:37 +01007113 case JUMP_WHILE_FALSE:
7114 when = "JUMP_WHILE_FALSE"; // unused
7115 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007116 case JUMP_IF_COND_FALSE:
7117 when = "JUMP_IF_COND_FALSE";
7118 break;
7119 case JUMP_IF_COND_TRUE:
7120 when = "JUMP_IF_COND_TRUE";
7121 break;
7122 }
7123 smsg("%s%4d %s -> %d", pfx, current, when,
7124 iptr->isn_arg.jump.jump_where);
7125 }
7126 break;
7127
7128 case ISN_JUMP_IF_ARG_SET:
7129 smsg("%s%4d JUMP_IF_ARG_SET arg[%d] -> %d", pfx, current,
7130 iptr->isn_arg.jumparg.jump_arg_off + STACK_FRAME_SIZE,
7131 iptr->isn_arg.jump.jump_where);
7132 break;
7133
Bram Moolenaar65b0d162022-12-13 18:43:22 +00007134 case ISN_JUMP_IF_ARG_NOT_SET:
7135 smsg("%s%4d JUMP_IF_ARG_NOT_SET arg[%d] -> %d", pfx, current,
7136 iptr->isn_arg.jumparg.jump_arg_off + STACK_FRAME_SIZE,
7137 iptr->isn_arg.jump.jump_where);
7138 break;
7139
Bram Moolenaar4c137212021-04-19 16:48:48 +02007140 case ISN_FOR:
7141 {
7142 forloop_T *forloop = &iptr->isn_arg.forloop;
7143
7144 smsg("%s%4d FOR $%d -> %d", pfx, current,
Bram Moolenaarcc341812022-09-19 15:54:34 +01007145 forloop->for_loop_idx, forloop->for_end);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007146 }
7147 break;
7148
Bram Moolenaarb46c0832022-09-15 17:19:37 +01007149 case ISN_ENDLOOP:
7150 {
7151 endloop_T *endloop = &iptr->isn_arg.endloop;
7152
Bram Moolenaarcc341812022-09-19 15:54:34 +01007153 smsg("%s%4d ENDLOOP ref $%d save $%d-$%d depth %d",
7154 pfx, current,
Bram Moolenaarb46c0832022-09-15 17:19:37 +01007155 endloop->end_funcref_idx,
7156 endloop->end_var_idx,
Bram Moolenaarcc341812022-09-19 15:54:34 +01007157 endloop->end_var_idx + endloop->end_var_count - 1,
7158 endloop->end_depth);
Bram Moolenaarb46c0832022-09-15 17:19:37 +01007159 }
7160 break;
7161
7162 case ISN_WHILE:
7163 {
7164 whileloop_T *whileloop = &iptr->isn_arg.whileloop;
7165
7166 smsg("%s%4d WHILE $%d -> %d", pfx, current,
7167 whileloop->while_funcref_idx,
7168 whileloop->while_end);
7169 }
7170 break;
7171
Bram Moolenaar4c137212021-04-19 16:48:48 +02007172 case ISN_TRY:
7173 {
Bram Moolenaar0d807102021-12-21 09:42:09 +00007174 try_T *try = &iptr->isn_arg.tryref;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007175
7176 if (try->try_ref->try_finally == 0)
7177 smsg("%s%4d TRY catch -> %d, endtry -> %d",
7178 pfx, current,
7179 try->try_ref->try_catch,
7180 try->try_ref->try_endtry);
7181 else
7182 smsg("%s%4d TRY catch -> %d, finally -> %d, endtry -> %d",
7183 pfx, current,
7184 try->try_ref->try_catch,
7185 try->try_ref->try_finally,
7186 try->try_ref->try_endtry);
7187 }
7188 break;
7189 case ISN_CATCH:
Bram Moolenaar4c137212021-04-19 16:48:48 +02007190 smsg("%s%4d CATCH", pfx, current);
7191 break;
7192 case ISN_TRYCONT:
7193 {
7194 trycont_T *trycont = &iptr->isn_arg.trycont;
7195
7196 smsg("%s%4d TRY-CONTINUE %d level%s -> %d", pfx, current,
7197 trycont->tct_levels,
7198 trycont->tct_levels == 1 ? "" : "s",
7199 trycont->tct_where);
7200 }
7201 break;
7202 case ISN_FINALLY:
7203 smsg("%s%4d FINALLY", pfx, current);
7204 break;
7205 case ISN_ENDTRY:
7206 smsg("%s%4d ENDTRY", pfx, current);
7207 break;
7208 case ISN_THROW:
7209 smsg("%s%4d THROW", pfx, current);
7210 break;
7211
7212 // expression operations on number
7213 case ISN_OPNR:
7214 case ISN_OPFLOAT:
7215 case ISN_OPANY:
7216 {
7217 char *what;
7218 char *ins;
7219
7220 switch (iptr->isn_arg.op.op_type)
7221 {
7222 case EXPR_MULT: what = "*"; break;
7223 case EXPR_DIV: what = "/"; break;
7224 case EXPR_REM: what = "%"; break;
7225 case EXPR_SUB: what = "-"; break;
7226 case EXPR_ADD: what = "+"; break;
Yegappan Lakshmanana061f342022-05-22 19:13:49 +01007227 case EXPR_LSHIFT: what = "<<"; break;
7228 case EXPR_RSHIFT: what = ">>"; break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007229 default: what = "???"; break;
7230 }
7231 switch (iptr->isn_type)
7232 {
7233 case ISN_OPNR: ins = "OPNR"; break;
7234 case ISN_OPFLOAT: ins = "OPFLOAT"; break;
7235 case ISN_OPANY: ins = "OPANY"; break;
7236 default: ins = "???"; break;
7237 }
7238 smsg("%s%4d %s %s", pfx, current, ins, what);
7239 }
7240 break;
7241
7242 case ISN_COMPAREBOOL:
7243 case ISN_COMPARESPECIAL:
Bram Moolenaar7a222242022-03-01 19:23:24 +00007244 case ISN_COMPARENULL:
Bram Moolenaar4c137212021-04-19 16:48:48 +02007245 case ISN_COMPARENR:
7246 case ISN_COMPAREFLOAT:
7247 case ISN_COMPARESTRING:
7248 case ISN_COMPAREBLOB:
7249 case ISN_COMPARELIST:
7250 case ISN_COMPAREDICT:
7251 case ISN_COMPAREFUNC:
Bram Moolenaarbcf31ec2023-01-02 20:32:24 +00007252 case ISN_COMPAREOBJECT:
Bram Moolenaar4c137212021-04-19 16:48:48 +02007253 case ISN_COMPAREANY:
7254 {
7255 char *p;
7256 char buf[10];
7257 char *type;
7258
7259 switch (iptr->isn_arg.op.op_type)
7260 {
7261 case EXPR_EQUAL: p = "=="; break;
7262 case EXPR_NEQUAL: p = "!="; break;
7263 case EXPR_GREATER: p = ">"; break;
7264 case EXPR_GEQUAL: p = ">="; break;
7265 case EXPR_SMALLER: p = "<"; break;
7266 case EXPR_SEQUAL: p = "<="; break;
7267 case EXPR_MATCH: p = "=~"; break;
7268 case EXPR_IS: p = "is"; break;
7269 case EXPR_ISNOT: p = "isnot"; break;
7270 case EXPR_NOMATCH: p = "!~"; break;
7271 default: p = "???"; break;
7272 }
7273 STRCPY(buf, p);
7274 if (iptr->isn_arg.op.op_ic == TRUE)
7275 strcat(buf, "?");
7276 switch(iptr->isn_type)
7277 {
7278 case ISN_COMPAREBOOL: type = "COMPAREBOOL"; break;
7279 case ISN_COMPARESPECIAL:
7280 type = "COMPARESPECIAL"; break;
Bram Moolenaar7a222242022-03-01 19:23:24 +00007281 case ISN_COMPARENULL: type = "COMPARENULL"; break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007282 case ISN_COMPARENR: type = "COMPARENR"; break;
7283 case ISN_COMPAREFLOAT: type = "COMPAREFLOAT"; break;
7284 case ISN_COMPARESTRING:
7285 type = "COMPARESTRING"; break;
7286 case ISN_COMPAREBLOB: type = "COMPAREBLOB"; break;
7287 case ISN_COMPARELIST: type = "COMPARELIST"; break;
7288 case ISN_COMPAREDICT: type = "COMPAREDICT"; break;
7289 case ISN_COMPAREFUNC: type = "COMPAREFUNC"; break;
Bram Moolenaarbcf31ec2023-01-02 20:32:24 +00007290 case ISN_COMPAREOBJECT:
7291 type = "COMPAREOBJECT"; break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007292 case ISN_COMPAREANY: type = "COMPAREANY"; break;
7293 default: type = "???"; break;
7294 }
7295
7296 smsg("%s%4d %s %s", pfx, current, type, buf);
7297 }
7298 break;
7299
7300 case ISN_ADDLIST: smsg("%s%4d ADDLIST", pfx, current); break;
7301 case ISN_ADDBLOB: smsg("%s%4d ADDBLOB", pfx, current); break;
7302
7303 // expression operations
LemonBoy372bcce2022-04-25 12:43:20 +01007304 case ISN_CONCAT:
7305 smsg("%s%4d CONCAT size %lld", pfx, current,
7306 (varnumber_T)(iptr->isn_arg.number));
7307 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007308 case ISN_STRINDEX: smsg("%s%4d STRINDEX", pfx, current); break;
7309 case ISN_STRSLICE: smsg("%s%4d STRSLICE", pfx, current); break;
7310 case ISN_BLOBINDEX: smsg("%s%4d BLOBINDEX", pfx, current); break;
7311 case ISN_BLOBSLICE: smsg("%s%4d BLOBSLICE", pfx, current); break;
7312 case ISN_LISTAPPEND: smsg("%s%4d LISTAPPEND", pfx, current); break;
7313 case ISN_BLOBAPPEND: smsg("%s%4d BLOBAPPEND", pfx, current); break;
7314 case ISN_LISTINDEX: smsg("%s%4d LISTINDEX", pfx, current); break;
7315 case ISN_LISTSLICE: smsg("%s%4d LISTSLICE", pfx, current); break;
7316 case ISN_ANYINDEX: smsg("%s%4d ANYINDEX", pfx, current); break;
7317 case ISN_ANYSLICE: smsg("%s%4d ANYSLICE", pfx, current); break;
7318 case ISN_SLICE: smsg("%s%4d SLICE %lld",
Bram Moolenaar4f0884d2021-08-11 21:49:23 +02007319 pfx, current, iptr->isn_arg.number); break;
Bram Moolenaar035bd1c2021-06-21 19:44:11 +02007320 case ISN_GETITEM: smsg("%s%4d ITEM %lld%s", pfx, current,
7321 iptr->isn_arg.getitem.gi_index,
7322 iptr->isn_arg.getitem.gi_with_op ?
7323 " with op" : ""); break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007324 case ISN_MEMBER: smsg("%s%4d MEMBER", pfx, current); break;
7325 case ISN_STRINGMEMBER: smsg("%s%4d MEMBER %s", pfx, current,
7326 iptr->isn_arg.string); break;
Yegappan Lakshmanan5a05d372023-09-29 19:43:11 +02007327 case ISN_GET_OBJ_MEMBER: smsg("%s%4d OBJ_MEMBER %d", pfx, current,
7328 (int)iptr->isn_arg.classmember.cm_idx);
Ernie Rael00df69e2023-09-05 07:38:09 +02007329 break;
Yegappan Lakshmanan5a05d372023-09-29 19:43:11 +02007330 case ISN_GET_ITF_MEMBER: smsg("%s%4d ITF_MEMBER %d on %s",
Bram Moolenaar29ac5df2023-01-16 19:43:47 +00007331 pfx, current,
7332 (int)iptr->isn_arg.classmember.cm_idx,
Yegappan Lakshmanan5a05d372023-09-29 19:43:11 +02007333 iptr->isn_arg.classmember.cm_class->class_name);
Bram Moolenaar29ac5df2023-01-16 19:43:47 +00007334 break;
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00007335 case ISN_STORE_THIS: smsg("%s%4d STORE_THIS %d", pfx, current,
Bram Moolenaarffdaca92022-12-09 21:41:48 +00007336 (int)iptr->isn_arg.number); break;
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02007337 case ISN_CLEARDICT: smsg("%s%4d CLEARDICT", pfx, current); break;
7338 case ISN_USEDICT: smsg("%s%4d USEDICT", pfx, current); break;
7339
Bram Moolenaar4c137212021-04-19 16:48:48 +02007340 case ISN_NEGATENR: smsg("%s%4d NEGATENR", pfx, current); break;
7341
Bram Moolenaar4c137212021-04-19 16:48:48 +02007342 case ISN_CHECKTYPE:
7343 {
Bram Moolenaarbd3a9d22022-05-17 16:12:39 +01007344 checktype_T *ct = &iptr->isn_arg.type;
Bram Moolenaarc6951a72022-12-29 20:56:24 +00007345 char *tofree = NULL;
7346 char *typename;
7347
7348 if (ct->ct_type->tt_type == VAR_FLOAT
7349 && (ct->ct_type->tt_flags & TTFLAG_NUMBER_OK))
7350 typename = "float|number";
7351 else
7352 typename = type_name(ct->ct_type, &tofree);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007353
7354 if (ct->ct_arg_idx == 0)
7355 smsg("%s%4d CHECKTYPE %s stack[%d]", pfx, current,
Bram Moolenaarc6951a72022-12-29 20:56:24 +00007356 typename,
Bram Moolenaar4c137212021-04-19 16:48:48 +02007357 (int)ct->ct_off);
7358 else
Bram Moolenaarbd3a9d22022-05-17 16:12:39 +01007359 smsg("%s%4d CHECKTYPE %s stack[%d] %s %d",
Bram Moolenaar4f0884d2021-08-11 21:49:23 +02007360 pfx, current,
Bram Moolenaarc6951a72022-12-29 20:56:24 +00007361 typename,
Bram Moolenaar4c137212021-04-19 16:48:48 +02007362 (int)ct->ct_off,
Bram Moolenaarbd3a9d22022-05-17 16:12:39 +01007363 ct->ct_is_var ? "var": "arg",
Bram Moolenaar4c137212021-04-19 16:48:48 +02007364 (int)ct->ct_arg_idx);
7365 vim_free(tofree);
7366 break;
7367 }
7368 case ISN_CHECKLEN: smsg("%s%4d CHECKLEN %s%d", pfx, current,
7369 iptr->isn_arg.checklen.cl_more_OK ? ">= " : "",
7370 iptr->isn_arg.checklen.cl_min_len);
7371 break;
7372 case ISN_SETTYPE:
7373 {
7374 char *tofree;
7375
7376 smsg("%s%4d SETTYPE %s", pfx, current,
7377 type_name(iptr->isn_arg.type.ct_type, &tofree));
7378 vim_free(tofree);
7379 break;
7380 }
7381 case ISN_COND2BOOL: smsg("%s%4d COND2BOOL", pfx, current); break;
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02007382 case ISN_2BOOL: if (iptr->isn_arg.tobool.invert)
7383 smsg("%s%4d INVERT %d (!val)", pfx, current,
7384 iptr->isn_arg.tobool.offset);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007385 else
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02007386 smsg("%s%4d 2BOOL %d (!!val)", pfx, current,
7387 iptr->isn_arg.tobool.offset);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007388 break;
7389 case ISN_2STRING: smsg("%s%4d 2STRING stack[%lld]", pfx, current,
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02007390 (varnumber_T)(iptr->isn_arg.tostring.offset));
Bram Moolenaar4c137212021-04-19 16:48:48 +02007391 break;
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02007392 case ISN_2STRING_ANY: smsg("%s%4d 2STRING_ANY stack[%lld]",
7393 pfx, current,
7394 (varnumber_T)(iptr->isn_arg.tostring.offset));
Bram Moolenaar4c137212021-04-19 16:48:48 +02007395 break;
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02007396 case ISN_RANGE: smsg("%s%4d RANGE %s", pfx, current,
7397 iptr->isn_arg.string);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007398 break;
7399 case ISN_PUT:
Bram Moolenaar6ed545e2022-05-09 20:09:23 +01007400 if (iptr->isn_arg.put.put_lnum == LNUM_VARIABLE_RANGE_ABOVE)
Bram Moolenaar4c137212021-04-19 16:48:48 +02007401 smsg("%s%4d PUT %c above range",
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02007402 pfx, current, iptr->isn_arg.put.put_regname);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007403 else if (iptr->isn_arg.put.put_lnum == LNUM_VARIABLE_RANGE)
7404 smsg("%s%4d PUT %c range",
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02007405 pfx, current, iptr->isn_arg.put.put_regname);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007406 else
7407 smsg("%s%4d PUT %c %ld", pfx, current,
7408 iptr->isn_arg.put.put_regname,
7409 (long)iptr->isn_arg.put.put_lnum);
7410 break;
7411
Bram Moolenaar4c137212021-04-19 16:48:48 +02007412 case ISN_CMDMOD:
7413 {
7414 char_u *buf;
7415 size_t len = produce_cmdmods(
7416 NULL, iptr->isn_arg.cmdmod.cf_cmdmod, FALSE);
7417
7418 buf = alloc(len + 1);
Dominique Pelle5a9e5842021-07-24 19:32:12 +02007419 if (likely(buf != NULL))
Bram Moolenaar4c137212021-04-19 16:48:48 +02007420 {
7421 (void)produce_cmdmods(
7422 buf, iptr->isn_arg.cmdmod.cf_cmdmod, FALSE);
7423 smsg("%s%4d CMDMOD %s", pfx, current, buf);
7424 vim_free(buf);
7425 }
7426 break;
7427 }
7428 case ISN_CMDMOD_REV: smsg("%s%4d CMDMOD_REV", pfx, current); break;
7429
7430 case ISN_PROF_START:
Bram Moolenaare99d4222021-06-13 14:01:26 +02007431 smsg("%s%4d PROFILE START line %d", pfx, current,
7432 iptr->isn_lnum);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007433 break;
7434
7435 case ISN_PROF_END:
7436 smsg("%s%4d PROFILE END", pfx, current);
7437 break;
7438
Bram Moolenaare99d4222021-06-13 14:01:26 +02007439 case ISN_DEBUG:
Bram Moolenaar8cec9272021-06-23 20:20:53 +02007440 smsg("%s%4d DEBUG line %d-%d varcount %lld", pfx, current,
7441 iptr->isn_arg.debug.dbg_break_lnum + 1,
7442 iptr->isn_lnum,
7443 iptr->isn_arg.debug.dbg_var_names_len);
Bram Moolenaare99d4222021-06-13 14:01:26 +02007444 break;
7445
Bram Moolenaar4c137212021-04-19 16:48:48 +02007446 case ISN_UNPACK: smsg("%s%4d UNPACK %d%s", pfx, current,
7447 iptr->isn_arg.unpack.unp_count,
7448 iptr->isn_arg.unpack.unp_semicolon ? " semicolon" : "");
7449 break;
7450 case ISN_SHUFFLE: smsg("%s%4d SHUFFLE %d up %d", pfx, current,
7451 iptr->isn_arg.shuffle.shfl_item,
7452 iptr->isn_arg.shuffle.shfl_up);
7453 break;
7454 case ISN_DROP: smsg("%s%4d DROP", pfx, current); break;
7455
7456 case ISN_FINISH: // End of list of instructions for ISN_SUBSTITUTE.
7457 return;
7458 }
7459
7460 out_flush(); // output one line at a time
7461 ui_breakcheck();
7462 if (got_int)
7463 break;
7464 }
7465}
7466
7467/*
Bram Moolenaar4ee9d8e2021-06-13 18:38:48 +02007468 * Handle command line completion for the :disassemble command.
7469 */
7470 void
7471set_context_in_disassemble_cmd(expand_T *xp, char_u *arg)
7472{
7473 char_u *p;
7474
7475 // Default: expand user functions, "debug" and "profile"
7476 xp->xp_context = EXPAND_DISASSEMBLE;
7477 xp->xp_pattern = arg;
7478
7479 // first argument already typed: only user function names
7480 if (*arg != NUL && *(p = skiptowhite(arg)) != NUL)
7481 {
7482 xp->xp_context = EXPAND_USER_FUNC;
7483 xp->xp_pattern = skipwhite(p);
7484 }
7485}
7486
7487/*
7488 * Function given to ExpandGeneric() to obtain the list of :disassemble
7489 * arguments.
7490 */
7491 char_u *
7492get_disassemble_argument(expand_T *xp, int idx)
7493{
7494 if (idx == 0)
7495 return (char_u *)"debug";
7496 if (idx == 1)
7497 return (char_u *)"profile";
7498 return get_user_func_name(xp, idx - 2);
7499}
7500
7501/*
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01007502 * ":disassemble".
Bram Moolenaar777770f2020-02-06 21:27:08 +01007503 * We don't really need this at runtime, but we do have tests that require it,
7504 * so always include this.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007505 */
7506 void
7507ex_disassemble(exarg_T *eap)
7508{
Bram Moolenaar21456cd2020-02-13 21:29:32 +01007509 char_u *arg = eap->arg;
Bram Moolenaar0f18b6d2020-02-02 17:22:27 +01007510 ufunc_T *ufunc;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007511 dfunc_T *dfunc;
Bram Moolenaardafef512022-05-21 21:55:55 +01007512 isn_T *instr = NULL; // init to shut up gcc warning
7513 int instr_count = 0; // init to shut up gcc warning
Bram Moolenaar5a01caa2022-05-21 18:56:58 +01007514 compiletype_T compile_type = CT_NONE;
Bram Moolenaare99d4222021-06-13 14:01:26 +02007515
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01007516 ufunc = find_func_by_name(arg, &compile_type);
Bram Moolenaara26b9702020-04-18 19:53:28 +02007517 if (ufunc == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007518 return;
Bram Moolenaare99d4222021-06-13 14:01:26 +02007519 if (func_needs_compiling(ufunc, compile_type)
7520 && compile_def_function(ufunc, FALSE, compile_type, NULL) == FAIL)
Bram Moolenaar822ba242020-05-24 23:00:18 +02007521 return;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02007522 if (ufunc->uf_def_status != UF_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007523 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02007524 semsg(_(e_function_is_not_compiled_str), eap->arg);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007525 return;
7526 }
Bram Moolenaar6db660b2021-08-01 14:08:54 +02007527 msg((char *)printable_func_name(ufunc));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007528
7529 dfunc = ((dfunc_T *)def_functions.ga_data) + ufunc->uf_dfunc_idx;
Bram Moolenaare99d4222021-06-13 14:01:26 +02007530 switch (compile_type)
7531 {
7532 case CT_PROFILE:
Bram Moolenaarf002a412021-01-24 13:34:18 +01007533#ifdef FEAT_PROFILE
Bram Moolenaare99d4222021-06-13 14:01:26 +02007534 instr = dfunc->df_instr_prof;
7535 instr_count = dfunc->df_instr_prof_count;
7536 break;
Bram Moolenaarf002a412021-01-24 13:34:18 +01007537#endif
Bram Moolenaare99d4222021-06-13 14:01:26 +02007538 // FALLTHROUGH
7539 case CT_NONE:
7540 instr = dfunc->df_instr;
7541 instr_count = dfunc->df_instr_count;
7542 break;
7543 case CT_DEBUG:
7544 instr = dfunc->df_instr_debug;
7545 instr_count = dfunc->df_instr_debug_count;
7546 break;
7547 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007548
Bram Moolenaar4c137212021-04-19 16:48:48 +02007549 list_instructions("", instr, instr_count, ufunc);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007550}
7551
7552/*
Bram Moolenaar13106602020-10-04 16:06:05 +02007553 * Return TRUE when "tv" is not falsy: non-zero, non-empty string, non-empty
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007554 * list, etc. Mostly like what JavaScript does, except that empty list and
7555 * empty dictionary are FALSE.
7556 */
7557 int
7558tv2bool(typval_T *tv)
7559{
7560 switch (tv->v_type)
7561 {
7562 case VAR_NUMBER:
7563 return tv->vval.v_number != 0;
7564 case VAR_FLOAT:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007565 return tv->vval.v_float != 0.0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007566 case VAR_PARTIAL:
7567 return tv->vval.v_partial != NULL;
7568 case VAR_FUNC:
7569 case VAR_STRING:
7570 return tv->vval.v_string != NULL && *tv->vval.v_string != NUL;
7571 case VAR_LIST:
7572 return tv->vval.v_list != NULL && tv->vval.v_list->lv_len > 0;
7573 case VAR_DICT:
7574 return tv->vval.v_dict != NULL
7575 && tv->vval.v_dict->dv_hashtab.ht_used > 0;
7576 case VAR_BOOL:
7577 case VAR_SPECIAL:
7578 return tv->vval.v_number == VVAL_TRUE ? TRUE : FALSE;
7579 case VAR_JOB:
7580#ifdef FEAT_JOB_CHANNEL
7581 return tv->vval.v_job != NULL;
7582#else
7583 break;
7584#endif
7585 case VAR_CHANNEL:
7586#ifdef FEAT_JOB_CHANNEL
7587 return tv->vval.v_channel != NULL;
7588#else
7589 break;
7590#endif
7591 case VAR_BLOB:
7592 return tv->vval.v_blob != NULL && tv->vval.v_blob->bv_ga.ga_len > 0;
7593 case VAR_UNKNOWN:
Bram Moolenaar4c683752020-04-05 21:38:23 +02007594 case VAR_ANY:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007595 case VAR_VOID:
Bram Moolenaarf18332f2021-05-07 17:55:55 +02007596 case VAR_INSTR:
Bram Moolenaar00b28d62022-12-08 15:32:33 +00007597 case VAR_CLASS:
7598 case VAR_OBJECT:
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02007599 case VAR_TYPEALIAS:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007600 break;
7601 }
7602 return FALSE;
7603}
7604
Bram Moolenaarea2d4072020-11-12 12:08:51 +01007605 void
7606emsg_using_string_as(typval_T *tv, int as_number)
7607{
7608 semsg(_(as_number ? e_using_string_as_number_str
7609 : e_using_string_as_bool_str),
7610 tv->vval.v_string == NULL
7611 ? (char_u *)"" : tv->vval.v_string);
7612}
7613
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007614/*
7615 * If "tv" is a string give an error and return FAIL.
7616 */
7617 int
7618check_not_string(typval_T *tv)
7619{
7620 if (tv->v_type == VAR_STRING)
7621 {
Bram Moolenaarea2d4072020-11-12 12:08:51 +01007622 emsg_using_string_as(tv, TRUE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007623 clear_tv(tv);
7624 return FAIL;
7625 }
7626 return OK;
7627}
7628
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007629
7630#endif // FEAT_EVAL