blob: aa0e0863aec822838caac2ec087b3ed7b1e72c3c [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/*
Yegappan Lakshmanan92195ae2024-12-22 14:44:35 +01002219 * Do a runtime check of the RHS value against the LHS List member type.
2220 * This is used by the STOREINDEX instruction to perform a type check
2221 * at runtime if compile time type check cannot be performed (VAR_ANY).
2222 * Returns FAIL if there is a type mismatch.
2223 */
2224 static int
2225storeindex_check_list_member_type(
2226 list_T *lhs_list,
2227 typval_T *rhs_tv,
2228 ectx_T *ectx)
2229{
2230 if (lhs_list->lv_type == NULL || lhs_list->lv_type->tt_member == NULL)
2231 return OK;
2232
2233 return check_typval_type(lhs_list->lv_type->tt_member, rhs_tv,
2234 ectx->ec_where);
2235}
2236
2237/*
Bram Moolenaar65b0d162022-12-13 18:43:22 +00002238 * Store a value in a list, dict, blob or object variable.
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002239 * Returns OK, FAIL or NOTDONE (uncatchable error).
2240 */
2241 static int
2242execute_storeindex(isn_T *iptr, ectx_T *ectx)
2243{
Bram Moolenaarf7d1c6e2023-01-16 20:47:57 +00002244 vartype_T dest_type = iptr->isn_arg.storeindex.si_vartype;
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002245 typval_T *tv;
2246 typval_T *tv_idx = STACK_TV_BOT(-2);
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002247 long lidx = 0;
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002248 typval_T *tv_dest = STACK_TV_BOT(-1);
2249 int status = OK;
Yegappan Lakshmanan92195ae2024-12-22 14:44:35 +01002250 int check_rhs_type = FALSE;
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002251
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002252 if (tv_idx->v_type == VAR_NUMBER)
2253 lidx = (long)tv_idx->vval.v_number;
2254
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002255 // Stack contains:
2256 // -3 value to be stored
2257 // -2 index
Yegappan Lakshmanan3775f772023-09-01 22:05:45 +02002258 // -1 dict, list, blob, object or class
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002259 tv = STACK_TV_BOT(-3);
2260 SOURCING_LNUM = iptr->isn_lnum;
Gianmaria Bajod7085a02023-08-31 18:15:26 +02002261
2262 // Make sure an object has been initialized
2263 if (dest_type == VAR_OBJECT && tv_dest->vval.v_object == NULL)
2264 {
2265 emsg(_(e_using_null_object));
2266 status = FAIL;
2267 }
2268 else if (dest_type == VAR_ANY)
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002269 {
Yegappan Lakshmanan92195ae2024-12-22 14:44:35 +01002270 check_rhs_type = TRUE;
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002271 dest_type = tv_dest->v_type;
2272 if (dest_type == VAR_DICT)
2273 status = do_2string(tv_idx, TRUE, FALSE);
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002274 else if (dest_type == VAR_OBJECT && tv_idx->v_type == VAR_STRING)
2275 {
2276 // Need to get the member index now that the class is known.
2277 object_T *obj = tv_dest->vval.v_object;
Ernie Raelbe828252024-07-26 18:37:02 +02002278 if (obj == NULL)
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002279 {
Ernie Raelbe828252024-07-26 18:37:02 +02002280 emsg(_(e_using_null_object));
2281 status = FAIL;
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002282 }
2283 else
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002284 {
Ernie Raelbe828252024-07-26 18:37:02 +02002285 class_T *cl = obj->obj_class;
2286 char_u *member = tv_idx->vval.v_string;
2287
2288 int m_idx;
2289 ocmember_T *m = object_member_lookup(cl, member, 0, &m_idx);
2290 if (m != NULL)
2291 {
Yegappan Lakshmanan56d45f12024-11-11 19:58:55 +01002292 // Get the current function
2293 ufunc_T *ufunc = (((dfunc_T *)def_functions.ga_data)
2294 + ectx->ec_dfunc_idx)->df_ufunc;
Yegappan Lakshmanane7984462024-11-12 21:03:00 +01002295 where_T where = WHERE_INIT;
Yegappan Lakshmanan56d45f12024-11-11 19:58:55 +01002296
2297 // Check whether the member variable is writeable
2298 if ((m->ocm_access != VIM_ACCESS_ALL) &&
2299 (ufunc->uf_class == NULL ||
2300 !class_instance_of(ufunc->uf_class, cl)))
Ernie Raelbe828252024-07-26 18:37:02 +02002301 {
Yegappan Lakshmanan56d45f12024-11-11 19:58:55 +01002302 char *msg = (m->ocm_access == VIM_ACCESS_PRIVATE)
2303 ? e_cannot_access_protected_variable_str
2304 : e_variable_is_not_writable_str;
2305 emsg_var_cl_define(msg, m->ocm_name, 0, cl);
Ernie Raelbe828252024-07-26 18:37:02 +02002306 status = FAIL;
2307 }
Yegappan Lakshmanane7984462024-11-12 21:03:00 +01002308 // Fail if the variable is a const or final or the type
2309 // is not compatible
2310 else if (oc_var_check_ro(cl, m) ||
2311 check_typval_type(m->ocm_type, tv, where)
2312 == FAIL)
2313 status = FAIL;
Yegappan Lakshmanan56d45f12024-11-11 19:58:55 +01002314 else
2315 lidx = m_idx;
Ernie Raelbe828252024-07-26 18:37:02 +02002316 }
2317 else
2318 {
2319 member_not_found_msg(cl, VAR_OBJECT, member, 0);
2320 status = FAIL;
2321 }
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002322 }
2323 }
2324 else if ((dest_type == VAR_LIST || dest_type == VAR_OBJECT)
2325 && tv_idx->v_type != VAR_NUMBER)
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002326 {
2327 emsg(_(e_number_expected));
2328 status = FAIL;
2329 }
2330 }
Bram Moolenaare08be092022-02-17 13:08:26 +00002331
2332 if (status == OK)
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002333 {
Bram Moolenaare08be092022-02-17 13:08:26 +00002334 if (dest_type == VAR_LIST)
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002335 {
Bram Moolenaare08be092022-02-17 13:08:26 +00002336 list_T *list = tv_dest->vval.v_list;
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002337
Bram Moolenaare08be092022-02-17 13:08:26 +00002338 if (list == NULL)
2339 {
2340 emsg(_(e_list_not_set));
2341 return FAIL;
2342 }
2343 if (lidx < 0 && list->lv_len + lidx >= 0)
2344 // negative index is relative to the end
2345 lidx = list->lv_len + lidx;
2346 if (lidx < 0 || lidx > list->lv_len)
2347 {
2348 semsg(_(e_list_index_out_of_range_nr), lidx);
2349 return FAIL;
2350 }
Yegappan Lakshmanan92195ae2024-12-22 14:44:35 +01002351
2352 // Do a runtime type check for VAR_ANY
2353 if (check_rhs_type &&
2354 storeindex_check_list_member_type(list, tv, ectx) == FAIL)
2355 return FAIL;
2356
Bram Moolenaare08be092022-02-17 13:08:26 +00002357 if (lidx < list->lv_len)
2358 {
2359 listitem_T *li = list_find(list, lidx);
2360
2361 if (error_if_locked(li->li_tv.v_lock,
Bram Moolenaar70c43d82022-01-26 21:01:15 +00002362 e_cannot_change_locked_list_item))
Bram Moolenaare08be092022-02-17 13:08:26 +00002363 return FAIL;
2364 // overwrite existing list item
2365 clear_tv(&li->li_tv);
2366 li->li_tv = *tv;
2367 }
2368 else
2369 {
2370 if (error_if_locked(list->lv_lock, e_cannot_change_locked_list))
2371 return FAIL;
2372 // append to list, only fails when out of memory
2373 if (list_append_tv(list, tv) == FAIL)
2374 return NOTDONE;
2375 clear_tv(tv);
2376 }
2377 }
2378 else if (dest_type == VAR_DICT)
2379 {
2380 char_u *key = tv_idx->vval.v_string;
2381 dict_T *dict = tv_dest->vval.v_dict;
2382 dictitem_T *di;
2383
2384 SOURCING_LNUM = iptr->isn_lnum;
2385 if (dict == NULL)
2386 {
2387 emsg(_(e_dictionary_not_set));
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002388 return FAIL;
Bram Moolenaare08be092022-02-17 13:08:26 +00002389 }
2390 if (key == NULL)
2391 key = (char_u *)"";
2392 di = dict_find(dict, key, -1);
2393 if (di != NULL)
2394 {
2395 if (error_if_locked(di->di_tv.v_lock,
2396 e_cannot_change_dict_item))
2397 return FAIL;
2398 // overwrite existing value
2399 clear_tv(&di->di_tv);
2400 di->di_tv = *tv;
2401 }
2402 else
2403 {
2404 if (error_if_locked(dict->dv_lock, e_cannot_change_dict))
2405 return FAIL;
2406 // add to dict, only fails when out of memory
2407 if (dict_add_tv(dict, (char *)key, tv) == FAIL)
2408 return NOTDONE;
2409 clear_tv(tv);
2410 }
2411 }
2412 else if (dest_type == VAR_BLOB)
2413 {
Bram Moolenaare08be092022-02-17 13:08:26 +00002414 blob_T *blob = tv_dest->vval.v_blob;
Bram Moolenaar65b0d162022-12-13 18:43:22 +00002415 varnumber_T nr;
2416 int error = FALSE;
2417 int len;
Bram Moolenaare08be092022-02-17 13:08:26 +00002418
2419 if (blob == NULL)
2420 {
2421 emsg(_(e_blob_not_set));
2422 return FAIL;
2423 }
2424 len = blob_len(blob);
2425 if (lidx < 0 && len + lidx >= 0)
2426 // negative index is relative to the end
2427 lidx = len + lidx;
2428
2429 // Can add one byte at the end.
2430 if (lidx < 0 || lidx > len)
2431 {
2432 semsg(_(e_blob_index_out_of_range_nr), lidx);
2433 return FAIL;
2434 }
2435 if (value_check_lock(blob->bv_lock, (char_u *)"blob", FALSE))
2436 return FAIL;
2437 nr = tv_get_number_chk(tv, &error);
2438 if (error)
2439 return FAIL;
2440 blob_set_append(blob, lidx, nr);
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002441 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002442 else if (dest_type == VAR_CLASS || dest_type == VAR_OBJECT)
2443 {
Yegappan Lakshmanan3775f772023-09-01 22:05:45 +02002444 typval_T *otv;
Bram Moolenaarf7d1c6e2023-01-16 20:47:57 +00002445
Yegappan Lakshmanan3775f772023-09-01 22:05:45 +02002446 if (dest_type == VAR_OBJECT)
2447 {
2448 object_T *obj = tv_dest->vval.v_object;
2449
2450 otv = (typval_T *)(obj + 1);
2451 class_T *itf = iptr->isn_arg.storeindex.si_class;
2452 if (itf != NULL)
2453 // convert interface member index to class member index
Ernie Rael18143d32023-09-04 22:30:41 +02002454 lidx = object_index_from_itf_index(itf, FALSE, lidx,
Yegappan Lakshmanan5a05d372023-09-29 19:43:11 +02002455 obj->obj_class);
Yegappan Lakshmanan3775f772023-09-01 22:05:45 +02002456 }
2457 else
2458 {
2459 // VAR_CLASS
2460 class_T *class = tv_dest->vval.v_class;
2461 otv = class->class_members_tv;
2462 }
Bram Moolenaarf7d1c6e2023-01-16 20:47:57 +00002463
Yegappan Lakshmanan54d7f182025-02-10 21:35:07 +01002464 clear_tv(&otv[lidx]);
2465 otv[lidx] = *tv;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002466 }
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002467 else
2468 {
Bram Moolenaare08be092022-02-17 13:08:26 +00002469 status = FAIL;
2470 semsg(_(e_cannot_index_str), vartype_name(dest_type));
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002471 }
2472 }
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002473
2474 clear_tv(tv_idx);
2475 clear_tv(tv_dest);
2476 ectx->ec_stack.ga_len -= 3;
2477 if (status == FAIL)
2478 {
2479 clear_tv(tv);
2480 return FAIL;
2481 }
2482 return OK;
2483}
2484
2485/*
Bram Moolenaarea5c8982022-02-17 14:42:02 +00002486 * Store a value in a list or blob range.
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002487 */
2488 static int
2489execute_storerange(isn_T *iptr, ectx_T *ectx)
2490{
2491 typval_T *tv;
2492 typval_T *tv_idx1 = STACK_TV_BOT(-3);
2493 typval_T *tv_idx2 = STACK_TV_BOT(-2);
2494 typval_T *tv_dest = STACK_TV_BOT(-1);
2495 int status = OK;
2496
2497 // Stack contains:
2498 // -4 value to be stored
2499 // -3 first index or "none"
2500 // -2 second index or "none"
2501 // -1 destination list or blob
2502 tv = STACK_TV_BOT(-4);
Bram Moolenaarea5c8982022-02-17 14:42:02 +00002503 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002504 if (tv_dest->v_type == VAR_LIST)
2505 {
Bram Moolenaar2995e5c2022-03-18 21:41:47 +00002506 long n1;
2507 long n2;
2508 listitem_T *li1;
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002509
Bram Moolenaar2995e5c2022-03-18 21:41:47 +00002510 n1 = (long)tv_get_number_chk(tv_idx1, NULL);
2511 if (tv_idx2->v_type == VAR_SPECIAL
2512 && tv_idx2->vval.v_number == VVAL_NONE)
2513 n2 = list_len(tv_dest->vval.v_list) - 1;
2514 else
2515 n2 = (long)tv_get_number_chk(tv_idx2, NULL);
2516
Bram Moolenaar22ebd172022-04-01 15:26:58 +01002517 li1 = check_range_index_one(tv_dest->vval.v_list, &n1, TRUE, FALSE);
Bram Moolenaar2995e5c2022-03-18 21:41:47 +00002518 if (li1 == NULL)
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002519 status = FAIL;
2520 else
2521 {
Bram Moolenaar2995e5c2022-03-18 21:41:47 +00002522 status = check_range_index_two(tv_dest->vval.v_list,
2523 &n1, li1, &n2, FALSE);
2524 if (status != FAIL)
2525 status = list_assign_range(
2526 tv_dest->vval.v_list,
2527 tv->vval.v_list,
2528 n1,
2529 n2,
2530 tv_idx2->v_type == VAR_SPECIAL,
2531 (char_u *)"=",
2532 (char_u *)"[unknown]");
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002533 }
2534 }
2535 else if (tv_dest->v_type == VAR_BLOB)
2536 {
2537 varnumber_T n1;
2538 varnumber_T n2;
Bram Moolenaar2995e5c2022-03-18 21:41:47 +00002539 long bloblen;
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002540
Bram Moolenaar2995e5c2022-03-18 21:41:47 +00002541 n1 = tv_get_number_chk(tv_idx1, NULL);
2542 if (tv_idx2->v_type == VAR_SPECIAL
2543 && tv_idx2->vval.v_number == VVAL_NONE)
2544 n2 = blob_len(tv_dest->vval.v_blob) - 1;
2545 else
2546 n2 = tv_get_number_chk(tv_idx2, NULL);
2547 bloblen = blob_len(tv_dest->vval.v_blob);
2548
2549 if (check_blob_index(bloblen, n1, FALSE) == FAIL
2550 || check_blob_range(bloblen, n1, n2, FALSE) == FAIL)
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002551 status = FAIL;
2552 else
Bram Moolenaar2995e5c2022-03-18 21:41:47 +00002553 status = blob_set_range(tv_dest->vval.v_blob, n1, n2, tv);
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002554 }
2555 else
2556 {
2557 status = FAIL;
Bram Moolenaarea5c8982022-02-17 14:42:02 +00002558 emsg(_(e_list_or_blob_required));
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002559 }
2560
2561 clear_tv(tv_idx1);
2562 clear_tv(tv_idx2);
2563 clear_tv(tv_dest);
2564 ectx->ec_stack.ga_len -= 4;
2565 clear_tv(tv);
2566
2567 return status;
2568}
2569
2570/*
2571 * Unlet item in list or dict variable.
2572 */
2573 static int
2574execute_unletindex(isn_T *iptr, ectx_T *ectx)
2575{
2576 typval_T *tv_idx = STACK_TV_BOT(-2);
2577 typval_T *tv_dest = STACK_TV_BOT(-1);
2578 int status = OK;
2579
2580 // Stack contains:
2581 // -2 index
2582 // -1 dict or list
Bram Moolenaar6296d1e2022-02-17 16:30:11 +00002583 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002584 if (tv_dest->v_type == VAR_DICT)
2585 {
2586 // unlet a dict item, index must be a string
Bram Moolenaarea5c8982022-02-17 14:42:02 +00002587 if (tv_idx->v_type != VAR_STRING && tv_idx->v_type != VAR_NUMBER)
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002588 {
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002589 semsg(_(e_expected_str_but_got_str),
2590 vartype_name(VAR_STRING),
2591 vartype_name(tv_idx->v_type));
2592 status = FAIL;
2593 }
2594 else
2595 {
2596 dict_T *d = tv_dest->vval.v_dict;
Bram Moolenaarea5c8982022-02-17 14:42:02 +00002597 char_u *key;
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002598 dictitem_T *di = NULL;
2599
2600 if (d != NULL && value_check_lock(
2601 d->dv_lock, NULL, FALSE))
2602 status = FAIL;
2603 else
2604 {
Bram Moolenaarea5c8982022-02-17 14:42:02 +00002605 if (tv_idx->v_type == VAR_STRING)
2606 {
2607 key = tv_idx->vval.v_string;
2608 if (key == NULL)
2609 key = (char_u *)"";
2610 }
2611 else
2612 {
2613 key = tv_get_string(tv_idx);
2614 }
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002615 if (d != NULL)
2616 di = dict_find(d, key, (int)STRLEN(key));
2617 if (di == NULL)
2618 {
2619 // NULL dict is equivalent to empty dict
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00002620 semsg(_(e_key_not_present_in_dictionary_str), key);
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002621 status = FAIL;
2622 }
2623 else if (var_check_fixed(di->di_flags,
2624 NULL, FALSE)
2625 || var_check_ro(di->di_flags,
2626 NULL, FALSE))
2627 status = FAIL;
2628 else
Bram Moolenaaref2c3252022-11-25 16:31:51 +00002629 dictitem_remove(d, di, "unlet");
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002630 }
2631 }
2632 }
2633 else if (tv_dest->v_type == VAR_LIST)
2634 {
2635 // unlet a List item, index must be a number
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002636 if (check_for_number(tv_idx) == FAIL)
2637 {
2638 status = FAIL;
2639 }
2640 else
2641 {
2642 list_T *l = tv_dest->vval.v_list;
2643 long n = (long)tv_idx->vval.v_number;
2644
2645 if (l != NULL && value_check_lock(
2646 l->lv_lock, NULL, FALSE))
2647 status = FAIL;
2648 else
2649 {
2650 listitem_T *li = list_find(l, n);
2651
2652 if (li == NULL)
2653 {
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002654 semsg(_(e_list_index_out_of_range_nr), n);
2655 status = FAIL;
2656 }
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002657 else
2658 listitem_remove(l, li);
2659 }
2660 }
2661 }
2662 else
2663 {
2664 status = FAIL;
2665 semsg(_(e_cannot_index_str),
2666 vartype_name(tv_dest->v_type));
2667 }
2668
2669 clear_tv(tv_idx);
2670 clear_tv(tv_dest);
2671 ectx->ec_stack.ga_len -= 2;
2672
2673 return status;
2674}
2675
2676/*
2677 * Unlet a range of items in a list variable.
2678 */
2679 static int
2680execute_unletrange(isn_T *iptr, ectx_T *ectx)
2681{
2682 // Stack contains:
2683 // -3 index1
2684 // -2 index2
2685 // -1 dict or list
2686 typval_T *tv_idx1 = STACK_TV_BOT(-3);
2687 typval_T *tv_idx2 = STACK_TV_BOT(-2);
2688 typval_T *tv_dest = STACK_TV_BOT(-1);
2689 int status = OK;
2690
2691 if (tv_dest->v_type == VAR_LIST)
2692 {
2693 // indexes must be a number
2694 SOURCING_LNUM = iptr->isn_lnum;
2695 if (check_for_number(tv_idx1) == FAIL
2696 || (tv_idx2->v_type != VAR_SPECIAL
2697 && check_for_number(tv_idx2) == FAIL))
2698 {
2699 status = FAIL;
2700 }
2701 else
2702 {
2703 list_T *l = tv_dest->vval.v_list;
2704 long n1 = (long)tv_idx1->vval.v_number;
2705 long n2 = tv_idx2->v_type == VAR_SPECIAL
2706 ? 0 : (long)tv_idx2->vval.v_number;
2707 listitem_T *li;
2708
2709 li = list_find_index(l, &n1);
2710 if (li == NULL)
Bram Moolenaar6296d1e2022-02-17 16:30:11 +00002711 {
2712 semsg(_(e_list_index_out_of_range_nr),
2713 (long)tv_idx1->vval.v_number);
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002714 status = FAIL;
Bram Moolenaar6296d1e2022-02-17 16:30:11 +00002715 }
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002716 else
2717 {
2718 if (n1 < 0)
2719 n1 = list_idx_of_item(l, li);
2720 if (n2 < 0)
2721 {
2722 listitem_T *li2 = list_find(l, n2);
2723
2724 if (li2 == NULL)
Bram Moolenaar6296d1e2022-02-17 16:30:11 +00002725 {
2726 semsg(_(e_list_index_out_of_range_nr), n2);
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002727 status = FAIL;
Bram Moolenaar6296d1e2022-02-17 16:30:11 +00002728 }
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002729 else
2730 n2 = list_idx_of_item(l, li2);
2731 }
2732 if (status != FAIL
2733 && tv_idx2->v_type != VAR_SPECIAL
2734 && n2 < n1)
2735 {
2736 semsg(_(e_list_index_out_of_range_nr), n2);
2737 status = FAIL;
2738 }
Bram Moolenaar6b8c7ba2022-03-20 17:46:06 +00002739 if (status != FAIL)
2740 list_unlet_range(l, li, n1,
2741 tv_idx2->v_type != VAR_SPECIAL, n2);
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002742 }
2743 }
2744 }
2745 else
2746 {
2747 status = FAIL;
2748 SOURCING_LNUM = iptr->isn_lnum;
2749 semsg(_(e_cannot_index_str),
2750 vartype_name(tv_dest->v_type));
2751 }
2752
2753 clear_tv(tv_idx1);
2754 clear_tv(tv_idx2);
2755 clear_tv(tv_dest);
2756 ectx->ec_stack.ga_len -= 3;
2757
2758 return status;
2759}
2760
2761/*
2762 * Top of a for loop.
2763 */
2764 static int
2765execute_for(isn_T *iptr, ectx_T *ectx)
2766{
2767 typval_T *tv;
Bram Moolenaarb46c0832022-09-15 17:19:37 +01002768 int jump = FALSE;
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002769 typval_T *ltv = STACK_TV_BOT(-1);
2770 typval_T *idxtv =
Bram Moolenaarcc341812022-09-19 15:54:34 +01002771 STACK_TV_VAR(iptr->isn_arg.forloop.for_loop_idx);
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002772
2773 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
2774 return FAIL;
2775 if (ltv->v_type == VAR_LIST)
2776 {
2777 list_T *list = ltv->vval.v_list;
2778
2779 // push the next item from the list
2780 ++idxtv->vval.v_number;
2781 if (list == NULL
2782 || idxtv->vval.v_number >= list->lv_len)
2783 {
Bram Moolenaarb46c0832022-09-15 17:19:37 +01002784 jump = TRUE;
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002785 }
2786 else if (list->lv_first == &range_list_item)
2787 {
2788 // non-materialized range() list
2789 tv = STACK_TV_BOT(0);
2790 tv->v_type = VAR_NUMBER;
2791 tv->v_lock = 0;
2792 tv->vval.v_number = list_find_nr(
2793 list, idxtv->vval.v_number, NULL);
2794 ++ectx->ec_stack.ga_len;
2795 }
2796 else
2797 {
2798 listitem_T *li = list_find(list,
2799 idxtv->vval.v_number);
2800
2801 copy_tv(&li->li_tv, STACK_TV_BOT(0));
2802 ++ectx->ec_stack.ga_len;
2803 }
2804 }
2805 else if (ltv->v_type == VAR_STRING)
2806 {
2807 char_u *str = ltv->vval.v_string;
2808
2809 // The index is for the last byte of the previous
2810 // character.
2811 ++idxtv->vval.v_number;
2812 if (str == NULL || str[idxtv->vval.v_number] == NUL)
2813 {
Bram Moolenaarb46c0832022-09-15 17:19:37 +01002814 jump = TRUE;
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002815 }
2816 else
2817 {
2818 int clen = mb_ptr2len(str + idxtv->vval.v_number);
2819
2820 // Push the next character from the string.
2821 tv = STACK_TV_BOT(0);
2822 tv->v_type = VAR_STRING;
2823 tv->vval.v_string = vim_strnsave(
2824 str + idxtv->vval.v_number, clen);
2825 ++ectx->ec_stack.ga_len;
2826 idxtv->vval.v_number += clen - 1;
2827 }
2828 }
2829 else if (ltv->v_type == VAR_BLOB)
2830 {
2831 blob_T *blob = ltv->vval.v_blob;
2832
2833 // When we get here the first time make a copy of the
2834 // blob, so that the iteration still works when it is
2835 // changed.
2836 if (idxtv->vval.v_number == -1 && blob != NULL)
2837 {
2838 blob_copy(blob, ltv);
2839 blob_unref(blob);
2840 blob = ltv->vval.v_blob;
2841 }
2842
2843 // The index is for the previous byte.
2844 ++idxtv->vval.v_number;
Bram Moolenaarb46c0832022-09-15 17:19:37 +01002845 if (blob == NULL || idxtv->vval.v_number >= blob_len(blob))
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002846 {
Bram Moolenaarb46c0832022-09-15 17:19:37 +01002847 jump = TRUE;
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002848 }
2849 else
2850 {
2851 // Push the next byte from the blob.
2852 tv = STACK_TV_BOT(0);
2853 tv->v_type = VAR_NUMBER;
2854 tv->vval.v_number = blob_get(blob,
2855 idxtv->vval.v_number);
2856 ++ectx->ec_stack.ga_len;
2857 }
2858 }
2859 else
2860 {
2861 semsg(_(e_for_loop_on_str_not_supported),
2862 vartype_name(ltv->v_type));
2863 return FAIL;
2864 }
Bram Moolenaarb46c0832022-09-15 17:19:37 +01002865
2866 if (jump)
2867 {
2868 // past the end of the list/string/blob, jump to "endfor"
2869 ectx->ec_iidx = iptr->isn_arg.forloop.for_end;
2870 may_restore_cmdmod(&ectx->ec_funclocal);
2871 }
2872 else
2873 {
2874 // Store the current number of funcrefs, this may be used in
2875 // ISN_LOOPEND. The variable index is always one more than the loop
2876 // variable index.
Bram Moolenaarcc341812022-09-19 15:54:34 +01002877 tv = STACK_TV_VAR(iptr->isn_arg.forloop.for_loop_idx + 1);
Bram Moolenaarb46c0832022-09-15 17:19:37 +01002878 tv->vval.v_number = ectx->ec_funcrefs.ga_len;
2879 }
2880
2881 return OK;
2882}
2883
2884/*
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01002885 * Code for handling variables declared inside a loop and used in a closure.
2886 * This is very similar to what is done with funcstack_T. The difference is
2887 * that the funcstack_T has the scope of a function, while a loopvars_T has the
2888 * scope of the block inside a loop and each loop may have its own.
2889 */
2890
2891// Double linked list of loopvars_T in use.
2892static loopvars_T *first_loopvars = NULL;
2893
2894 static void
2895add_loopvars_to_list(loopvars_T *loopvars)
2896{
2897 // Link in list of loopvarss.
2898 if (first_loopvars != NULL)
2899 first_loopvars->lvs_prev = loopvars;
2900 loopvars->lvs_next = first_loopvars;
2901 loopvars->lvs_prev = NULL;
2902 first_loopvars = loopvars;
2903}
2904
2905 static void
2906remove_loopvars_from_list(loopvars_T *loopvars)
2907{
2908 if (loopvars->lvs_prev == NULL)
2909 first_loopvars = loopvars->lvs_next;
2910 else
2911 loopvars->lvs_prev->lvs_next = loopvars->lvs_next;
2912 if (loopvars->lvs_next != NULL)
2913 loopvars->lvs_next->lvs_prev = loopvars->lvs_prev;
2914}
2915
2916/*
Bram Moolenaarb46c0832022-09-15 17:19:37 +01002917 * End of a for or while loop: Handle any variables used by a closure.
2918 */
2919 static int
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01002920execute_endloop(isn_T *iptr, ectx_T *ectx)
Bram Moolenaarb46c0832022-09-15 17:19:37 +01002921{
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01002922 endloop_T *endloop = &iptr->isn_arg.endloop;
2923 typval_T *tv_refcount = STACK_TV_VAR(endloop->end_funcref_idx);
2924 int prev_closure_count = tv_refcount->vval.v_number;
Bram Moolenaarcc341812022-09-19 15:54:34 +01002925 int depth = endloop->end_depth;
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01002926 garray_T *gap = &ectx->ec_funcrefs;
2927 int closure_in_use = FALSE;
2928 loopvars_T *loopvars;
2929 typval_T *stack;
2930 int idx;
2931
Bram Moolenaarcc341812022-09-19 15:54:34 +01002932 // Check if any created closure is still being referenced and loopvars have
2933 // not been saved yet for the current depth.
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01002934 for (idx = prev_closure_count; idx < gap->ga_len; ++idx)
2935 {
2936 partial_T *pt = ((partial_T **)gap->ga_data)[idx];
2937
Bram Moolenaarcc341812022-09-19 15:54:34 +01002938 if (pt->pt_refcount > 1 && pt->pt_loopvars[depth] == NULL)
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01002939 {
2940 int refcount = pt->pt_refcount;
2941 int i;
2942
2943 // A Reference in a variable inside the loop doesn't count, it gets
2944 // unreferenced at the end of the loop.
2945 for (i = 0; i < endloop->end_var_count; ++i)
2946 {
2947 typval_T *stv = STACK_TV_VAR(endloop->end_var_idx + i);
2948
2949 if (stv->v_type == VAR_PARTIAL && pt == stv->vval.v_partial)
2950 --refcount;
2951 }
2952 if (refcount > 1)
2953 {
2954 closure_in_use = TRUE;
2955 break;
2956 }
2957 }
2958 }
2959
2960 // If no function reference were created since the start of the loop block
2961 // or it is no longer referenced there is nothing to do.
2962 if (!closure_in_use)
2963 return OK;
2964
2965 // A closure is using variables declared inside the loop.
2966 // Move them to the called function.
2967 loopvars = ALLOC_CLEAR_ONE(loopvars_T);
2968 if (loopvars == NULL)
2969 return FAIL;
2970
2971 loopvars->lvs_ga.ga_len = endloop->end_var_count;
2972 stack = ALLOC_CLEAR_MULT(typval_T, loopvars->lvs_ga.ga_len);
2973 loopvars->lvs_ga.ga_data = stack;
2974 if (stack == NULL)
2975 {
2976 vim_free(loopvars);
2977 return FAIL;
2978 }
2979 add_loopvars_to_list(loopvars);
2980
2981 // Move the variable values.
2982 for (idx = 0; idx < endloop->end_var_count; ++idx)
2983 {
2984 typval_T *tv = STACK_TV_VAR(endloop->end_var_idx + idx);
2985
2986 *(stack + idx) = *tv;
2987 tv->v_type = VAR_UNKNOWN;
2988 }
2989
2990 for (idx = prev_closure_count; idx < gap->ga_len; ++idx)
2991 {
2992 partial_T *pt = ((partial_T **)gap->ga_data)[idx];
2993
Bram Moolenaarcc341812022-09-19 15:54:34 +01002994 if (pt->pt_refcount > 1 && pt->pt_loopvars[depth] == NULL)
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01002995 {
2996 ++loopvars->lvs_refcount;
Bram Moolenaarcc341812022-09-19 15:54:34 +01002997 pt->pt_loopvars[depth] = loopvars;
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01002998
Bram Moolenaarcc341812022-09-19 15:54:34 +01002999 pt->pt_outer.out_loop[depth].stack = &loopvars->lvs_ga;
3000 pt->pt_outer.out_loop[depth].var_idx -=
3001 ectx->ec_frame_idx + STACK_FRAME_SIZE + endloop->end_var_idx;
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01003002 }
3003 }
Bram Moolenaarb46c0832022-09-15 17:19:37 +01003004
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00003005 return OK;
3006}
3007
3008/*
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01003009 * Called when a partial is freed or its reference count goes down to one. The
3010 * loopvars may be the only reference to the partials in the local variables.
3011 * Go over all of them, the funcref and can be freed if all partials
3012 * referencing the loopvars have a reference count of one.
Bram Moolenaarcc341812022-09-19 15:54:34 +01003013 * Return TRUE if it was freed.
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01003014 */
Bram Moolenaarcc341812022-09-19 15:54:34 +01003015 int
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01003016loopvars_check_refcount(loopvars_T *loopvars)
3017{
3018 int i;
3019 garray_T *gap = &loopvars->lvs_ga;
3020 int done = 0;
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01003021 typval_T *stack = gap->ga_data;
3022
Bram Moolenaarcc341812022-09-19 15:54:34 +01003023 if (loopvars->lvs_refcount > loopvars->lvs_min_refcount)
3024 return FALSE;
3025 for (i = 0; i < gap->ga_len; ++i)
3026 {
3027 typval_T *tv = ((typval_T *)gap->ga_data) + i;
3028
3029 if (tv->v_type == VAR_PARTIAL && tv->vval.v_partial != NULL
3030 && tv->vval.v_partial->pt_refcount == 1)
3031 {
3032 int depth;
3033
3034 for (depth = 0; depth < MAX_LOOP_DEPTH; ++depth)
3035 if (tv->vval.v_partial->pt_loopvars[depth] == loopvars)
3036 ++done;
3037 }
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01003038 }
Bram Moolenaarcc341812022-09-19 15:54:34 +01003039 if (done != loopvars->lvs_min_refcount)
3040 return FALSE;
3041
3042 // All partials referencing the loopvars have a reference count of
3043 // one, thus the loopvars is no longer of use.
3044 stack = gap->ga_data;
3045 for (i = 0; i < gap->ga_len; ++i)
3046 clear_tv(stack + i);
3047 vim_free(stack);
3048 remove_loopvars_from_list(loopvars);
3049 vim_free(loopvars);
3050 return TRUE;
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01003051}
3052
3053/*
3054 * For garbage collecting: set references in all variables referenced by
3055 * all loopvars.
3056 */
3057 int
3058set_ref_in_loopvars(int copyID)
3059{
3060 loopvars_T *loopvars;
3061
3062 for (loopvars = first_loopvars; loopvars != NULL;
3063 loopvars = loopvars->lvs_next)
3064 {
3065 typval_T *stack = loopvars->lvs_ga.ga_data;
3066 int i;
3067
3068 for (i = 0; i < loopvars->lvs_ga.ga_len; ++i)
3069 if (set_ref_in_item(stack + i, copyID, NULL, NULL))
3070 return TRUE; // abort
3071 }
3072 return FALSE;
3073}
3074
3075/*
Bram Moolenaar06b77222022-01-25 15:51:56 +00003076 * Load instruction for w:/b:/g:/t: variable.
3077 * "isn_type" is used instead of "iptr->isn_type".
3078 */
3079 static int
3080load_namespace_var(ectx_T *ectx, isntype_T isn_type, isn_T *iptr)
3081{
3082 dictitem_T *di = NULL;
3083 hashtab_T *ht = NULL;
3084 char namespace;
3085
3086 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
3087 return NOTDONE;
3088 switch (isn_type)
3089 {
3090 case ISN_LOADG:
3091 ht = get_globvar_ht();
3092 namespace = 'g';
3093 break;
3094 case ISN_LOADB:
3095 ht = &curbuf->b_vars->dv_hashtab;
3096 namespace = 'b';
3097 break;
3098 case ISN_LOADW:
3099 ht = &curwin->w_vars->dv_hashtab;
3100 namespace = 'w';
3101 break;
3102 case ISN_LOADT:
3103 ht = &curtab->tp_vars->dv_hashtab;
3104 namespace = 't';
3105 break;
3106 default: // Cannot reach here
3107 return NOTDONE;
3108 }
3109 di = find_var_in_ht(ht, 0, iptr->isn_arg.string, TRUE);
3110
Bram Moolenaar06b77222022-01-25 15:51:56 +00003111 if (di == NULL)
3112 {
Bram Moolenaarfe732552022-02-22 19:39:13 +00003113 if (isn_type == ISN_LOADG)
3114 {
3115 ufunc_T *ufunc = find_func(iptr->isn_arg.string, TRUE);
3116
3117 // g:Something could be a function
3118 if (ufunc != NULL)
3119 {
3120 typval_T *tv = STACK_TV_BOT(0);
3121
3122 ++ectx->ec_stack.ga_len;
3123 tv->v_type = VAR_FUNC;
3124 tv->vval.v_string = alloc(STRLEN(iptr->isn_arg.string) + 3);
3125 if (tv->vval.v_string == NULL)
3126 return FAIL;
3127 STRCPY(tv->vval.v_string, "g:");
3128 STRCPY(tv->vval.v_string + 2, iptr->isn_arg.string);
3129 return OK;
3130 }
3131 }
Bram Moolenaar06b77222022-01-25 15:51:56 +00003132 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaarfe732552022-02-22 19:39:13 +00003133 if (vim_strchr(iptr->isn_arg.string, AUTOLOAD_CHAR) != NULL)
Bram Moolenaar06b77222022-01-25 15:51:56 +00003134 // no check if the item exists in the script but
3135 // isn't exported, it is too complicated
Bram Moolenaarfe732552022-02-22 19:39:13 +00003136 semsg(_(e_item_not_found_in_script_str), iptr->isn_arg.string);
Bram Moolenaar06b77222022-01-25 15:51:56 +00003137 else
3138 semsg(_(e_undefined_variable_char_str),
Bram Moolenaarfe732552022-02-22 19:39:13 +00003139 namespace, iptr->isn_arg.string);
Bram Moolenaar06b77222022-01-25 15:51:56 +00003140 return FAIL;
3141 }
3142 else
3143 {
3144 copy_tv(&di->di_tv, STACK_TV_BOT(0));
3145 ++ectx->ec_stack.ga_len;
3146 }
3147 return OK;
3148}
3149
Bram Moolenaard0200c82023-01-28 15:19:40 +00003150
3151 static void
3152object_required_error(typval_T *tv)
3153{
3154 garray_T type_list;
3155 ga_init2(&type_list, sizeof(type_T *), 10);
3156 type_T *type = typval2type(tv, get_copyID(), &type_list, TVTT_DO_MEMBER);
3157 char *tofree = NULL;
3158 char *typename = type_name(type, &tofree);
3159 semsg(_(e_object_required_found_str), typename);
3160 vim_free(tofree);
3161 clear_type_list(&type_list);
3162}
3163
Bram Moolenaar06b77222022-01-25 15:51:56 +00003164/*
Yegappan Lakshmanan778ada42025-02-17 20:21:23 +01003165 * Accessing the variable or method of an object or a class stored in a
3166 * variable of type "any".
Yegappan Lakshmanan56d45f12024-11-11 19:58:55 +01003167 * Returns OK if the member variable is present.
3168 * Returns FAIL if the variable is not found.
3169 */
3170 static int
Yegappan Lakshmanan778ada42025-02-17 20:21:23 +01003171var_any_get_oc_member(class_T *current_class, isn_T *iptr, typval_T *tv)
Yegappan Lakshmanan56d45f12024-11-11 19:58:55 +01003172{
Yegappan Lakshmanan778ada42025-02-17 20:21:23 +01003173 int is_object = tv->v_type == VAR_OBJECT;
3174 class_T *tv_cl;
3175 object_T *obj = NULL;
Yegappan Lakshmanan56d45f12024-11-11 19:58:55 +01003176 typval_T mtv;
3177
Yegappan Lakshmanan778ada42025-02-17 20:21:23 +01003178 if (is_object)
Yegappan Lakshmanan56d45f12024-11-11 19:58:55 +01003179 {
Yegappan Lakshmanan778ada42025-02-17 20:21:23 +01003180 obj = tv->vval.v_object;
3181 if (obj == NULL)
3182 {
3183 SOURCING_LNUM = iptr->isn_lnum;
3184 emsg(_(e_using_null_object));
3185 return FAIL;
3186 }
3187 tv_cl = obj->obj_class;
3188 }
3189 else
3190 {
3191 tv_cl = tv->vval.v_class;
3192 if (tv_cl == NULL)
3193 {
3194 SOURCING_LNUM = iptr->isn_lnum;
3195 emsg(_(e_using_null_class));
3196 return FAIL;
3197 }
Yegappan Lakshmanan56d45f12024-11-11 19:58:55 +01003198 }
3199
Yegappan Lakshmanan778ada42025-02-17 20:21:23 +01003200 // get_member_tv() needs the class/object information in the typval
3201 // argument. So set the object information.
Yegappan Lakshmanan56d45f12024-11-11 19:58:55 +01003202 copy_tv(tv, &mtv);
3203
Yegappan Lakshmanan778ada42025-02-17 20:21:23 +01003204 // 'name' can either be an instance or class variable or method
Yegappan Lakshmanan084529c2024-12-24 09:50:01 +01003205 int namelen = (int)STRLEN(iptr->isn_arg.string);
Yegappan Lakshmanan56d45f12024-11-11 19:58:55 +01003206 int save_did_emsg = did_emsg;
3207
Yegappan Lakshmanan778ada42025-02-17 20:21:23 +01003208 if (get_member_tv(tv_cl, is_object, iptr->isn_arg.string, namelen,
Yegappan Lakshmanan56d45f12024-11-11 19:58:55 +01003209 current_class, &mtv) == OK)
3210 {
Yegappan Lakshmanan778ada42025-02-17 20:21:23 +01003211 // instance or class variable
Yegappan Lakshmanan56d45f12024-11-11 19:58:55 +01003212 copy_tv(&mtv, tv);
3213 clear_tv(&mtv);
3214 return OK;
3215 }
3216
3217 if (did_emsg != save_did_emsg)
3218 return FAIL;
3219
Yegappan Lakshmanan778ada42025-02-17 20:21:23 +01003220 // could be a class or instance method
3221 ufunc_T *oc_method;
3222 int oc_method_idx;
Yegappan Lakshmanan56d45f12024-11-11 19:58:55 +01003223
Yegappan Lakshmanan778ada42025-02-17 20:21:23 +01003224 oc_method = method_lookup(tv_cl, tv->v_type, iptr->isn_arg.string,
3225 namelen, &oc_method_idx);
3226 if (oc_method == NULL)
Yegappan Lakshmanan56d45f12024-11-11 19:58:55 +01003227 {
Yegappan Lakshmanan778ada42025-02-17 20:21:23 +01003228 char *msg;
3229
Yegappan Lakshmanan56d45f12024-11-11 19:58:55 +01003230 SOURCING_LNUM = iptr->isn_lnum;
Yegappan Lakshmanan778ada42025-02-17 20:21:23 +01003231 if (is_object)
3232 msg = e_variable_not_found_on_object_str_str;
3233 else
3234 msg = e_class_variable_str_not_found_in_class_str;
3235 semsg(_(msg), iptr->isn_arg.string, tv_cl->class_name);
Yegappan Lakshmanan56d45f12024-11-11 19:58:55 +01003236 return FAIL;
3237 }
3238
3239 // Protected methods are not accessible outside the class
Yegappan Lakshmanan778ada42025-02-17 20:21:23 +01003240 if (*oc_method->uf_name == '_'
3241 && !class_instance_of(current_class, tv_cl))
Yegappan Lakshmanan56d45f12024-11-11 19:58:55 +01003242 {
Yegappan Lakshmanan778ada42025-02-17 20:21:23 +01003243 semsg(_(e_cannot_access_protected_method_str), oc_method->uf_name);
Yegappan Lakshmanan56d45f12024-11-11 19:58:55 +01003244 return FAIL;
3245 }
3246
Yegappan Lakshmanan778ada42025-02-17 20:21:23 +01003247 // Create a partial for the instance or class method
3248 if (obj_method_to_partial_tv(is_object ? obj : NULL, oc_method, tv)
3249 == FAIL)
Yegappan Lakshmanan56d45f12024-11-11 19:58:55 +01003250 return FAIL;
3251
3252 return OK;
3253}
3254
3255/*
64-bitman250739d2025-03-16 21:10:47 +01003256 * do ISN_PUT or ISN_IPUT instruction depending on fixindent parameter
3257 */
3258 static void
3259isn_put_do (ectx_T *ectx, isn_T *iptr, typval_T *tv, int fixindent) {
3260 int regname = iptr->isn_arg.put.put_regname;
3261 linenr_T lnum = iptr->isn_arg.put.put_lnum;
3262 char_u *expr = NULL;
3263 int dir = FORWARD;
3264
3265 if (lnum < -2)
3266 {
3267 // line number was put on the stack by ISN_RANGE
3268 tv = STACK_TV_BOT(-1);
3269 curwin->w_cursor.lnum = tv->vval.v_number;
3270 if (lnum == LNUM_VARIABLE_RANGE_ABOVE)
3271 dir = BACKWARD;
3272 --ectx->ec_stack.ga_len;
3273 }
3274 else if (lnum == -2)
3275 // :put! above cursor
3276 dir = BACKWARD;
3277 else if (lnum >= 0)
3278 {
3279 curwin->w_cursor.lnum = lnum;
3280 if (lnum == 0)
3281 // check_cursor() below will move to line 1
3282 dir = BACKWARD;
3283 }
3284
3285 if (regname == '=')
3286 {
3287 tv = STACK_TV_BOT(-1);
3288 if (tv->v_type == VAR_STRING)
3289 expr = tv->vval.v_string;
3290 else
3291 {
3292 expr = typval2string(tv, TRUE); // allocates value
3293 clear_tv(tv);
3294 }
3295 --ectx->ec_stack.ga_len;
3296 }
3297 check_cursor();
3298
3299 if (fixindent)
3300 do_put(regname, expr, dir, 1L, PUT_LINE|PUT_CURSLINE|PUT_FIXINDENT);
3301 else
3302 do_put(regname, expr, dir, 1L, PUT_LINE|PUT_CURSLINE);
3303 vim_free(expr);
3304}
3305
3306/*
Bram Moolenaar4c137212021-04-19 16:48:48 +02003307 * Execute instructions in execution context "ectx".
3308 * Return OK or FAIL;
3309 */
3310 static int
3311exec_instructions(ectx_T *ectx)
3312{
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003313 int ret = FAIL;
3314 int save_trylevel_at_start = ectx->ec_trylevel_at_start;
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02003315 int dict_stack_len_at_start = dict_stack.ga_len;
Bram Moolenaarf785aa12021-02-11 21:19:34 +01003316
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +02003317 // Start execution at the first instruction.
Bram Moolenaar4c137212021-04-19 16:48:48 +02003318 ectx->ec_iidx = 0;
Bram Moolenaar170fcfc2020-02-06 17:51:35 +01003319
Bram Moolenaarff652882021-05-16 15:24:49 +02003320 // Only catch exceptions in this instruction list.
3321 ectx->ec_trylevel_at_start = trylevel;
3322
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003323 for (;;)
3324 {
Bram Moolenaara7490192021-07-22 12:26:14 +02003325 static int breakcheck_count = 0; // using "static" makes it faster
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003326 isn_T *iptr;
Bram Moolenaara7490192021-07-22 12:26:14 +02003327 typval_T *tv;
Bram Moolenaar20431c92020-03-20 18:39:46 +01003328
Dominique Pelle5a9e5842021-07-24 19:32:12 +02003329 if (unlikely(++breakcheck_count >= 100))
Bram Moolenaar270d0382020-05-15 21:42:53 +02003330 {
3331 line_breakcheck();
3332 breakcheck_count = 0;
3333 }
Dominique Pelle5a9e5842021-07-24 19:32:12 +02003334 if (unlikely(got_int))
Bram Moolenaar20431c92020-03-20 18:39:46 +01003335 {
3336 // Turn CTRL-C into an exception.
3337 got_int = FALSE;
Bram Moolenaar97acfc72020-03-22 13:44:28 +01003338 if (throw_exception("Vim:Interrupt", ET_INTERRUPT, NULL) == FAIL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003339 goto theend;
Bram Moolenaar20431c92020-03-20 18:39:46 +01003340 did_throw = TRUE;
3341 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003342
Dominique Pelle5a9e5842021-07-24 19:32:12 +02003343 if (unlikely(did_emsg && msg_list != NULL && *msg_list != NULL))
Bram Moolenaara26b9702020-04-18 19:53:28 +02003344 {
3345 // Turn an error message into an exception.
3346 did_emsg = FALSE;
3347 if (throw_exception(*msg_list, ET_ERROR, NULL) == FAIL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003348 goto theend;
Bram Moolenaara26b9702020-04-18 19:53:28 +02003349 did_throw = TRUE;
3350 *msg_list = NULL;
Bram Moolenaar3ef2e412023-04-30 18:50:48 +01003351
3352 // This exception was not caught (yet).
3353 garray_T *trystack = &ectx->ec_trystack;
3354 if (trystack->ga_len > 0)
3355 {
3356 trycmd_T *trycmd = ((trycmd_T *)trystack->ga_data)
3357 + trystack->ga_len - 1;
3358 if (trycmd->tcd_frame_idx == ectx->ec_frame_idx)
Yee Cheng Chin2051af12025-01-09 22:14:34 +01003359 {
3360 if (trycmd->tcd_caught)
3361 {
3362 // Inside a "catch" we need to first discard the caught
3363 // exception.
3364 finish_exception(caught_stack);
3365 trycmd->tcd_caught = FALSE;
3366 }
3367 }
Bram Moolenaar3ef2e412023-04-30 18:50:48 +01003368 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003369 }
3370
Dominique Pelle5a9e5842021-07-24 19:32:12 +02003371 if (unlikely(did_throw))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003372 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02003373 garray_T *trystack = &ectx->ec_trystack;
Bram Moolenaar20431c92020-03-20 18:39:46 +01003374 trycmd_T *trycmd = NULL;
Bram Moolenaard3d8fee2021-06-30 19:54:43 +02003375 int index = trystack->ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003376
3377 // An exception jumps to the first catch, finally, or returns from
3378 // the current function.
Bram Moolenaard3d8fee2021-06-30 19:54:43 +02003379 while (index > 0)
3380 {
3381 trycmd = ((trycmd_T *)trystack->ga_data) + index - 1;
Bram Moolenaar3ef2e412023-04-30 18:50:48 +01003382 // 1. after :try and before :catch - jump to first :catch
3383 // 2. in :catch block - jump to :finally
3384 // 3. in :catch block and no finally - jump to :endtry
3385 if (!trycmd->tcd_in_catch || trycmd->tcd_finally_idx != 0
3386 || trycmd->tcd_frame_idx == ectx->ec_frame_idx)
Bram Moolenaard3d8fee2021-06-30 19:54:43 +02003387 break;
3388 // In the catch and finally block of this try we have to go up
3389 // one level.
3390 --index;
3391 trycmd = NULL;
3392 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02003393 if (trycmd != NULL && trycmd->tcd_frame_idx == ectx->ec_frame_idx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003394 {
Bram Moolenaar834193a2021-06-30 20:39:15 +02003395 if (trycmd->tcd_in_catch)
3396 {
Bram Moolenaar3ef2e412023-04-30 18:50:48 +01003397 if (trycmd->tcd_finally_idx > 0)
3398 {
3399 // exception inside ":catch", jump to ":finally" once
3400 ectx->ec_iidx = trycmd->tcd_finally_idx;
3401 trycmd->tcd_finally_idx = 0;
3402 }
3403 else
3404 {
3405 // exception inside ":catch" or ":finally", jump to
3406 // ":endtry"
3407 ectx->ec_iidx = trycmd->tcd_endtry_idx;
3408 }
Bram Moolenaar834193a2021-06-30 20:39:15 +02003409 }
3410 else
Bram Moolenaar3ef2e412023-04-30 18:50:48 +01003411 {
Bram Moolenaar834193a2021-06-30 20:39:15 +02003412 // jump to first ":catch"
3413 ectx->ec_iidx = trycmd->tcd_catch_idx;
Bram Moolenaar3ef2e412023-04-30 18:50:48 +01003414 trycmd->tcd_in_catch = TRUE;
3415 }
Bram Moolenaard3d8fee2021-06-30 19:54:43 +02003416 did_throw = FALSE; // don't come back here until :endtry
3417 trycmd->tcd_did_throw = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003418 }
3419 else
3420 {
Bram Moolenaar3ef2e412023-04-30 18:50:48 +01003421 // Not inside try or need to return from current function.
Bram Moolenaarcdd70f02020-08-13 21:40:18 +02003422 // Push a dummy return value.
Bram Moolenaar35578162021-08-02 19:10:38 +02003423 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003424 goto theend;
Bram Moolenaarcdd70f02020-08-13 21:40:18 +02003425 tv = STACK_TV_BOT(0);
3426 tv->v_type = VAR_NUMBER;
3427 tv->vval.v_number = 0;
Bram Moolenaar4c137212021-04-19 16:48:48 +02003428 ++ectx->ec_stack.ga_len;
3429 if (ectx->ec_frame_idx == ectx->ec_initial_frame_idx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003430 {
Bram Moolenaarcdd70f02020-08-13 21:40:18 +02003431 // At the toplevel we are done.
Bram Moolenaar257cc5e2020-02-19 17:06:11 +01003432 need_rethrow = TRUE;
Bram Moolenaar4c137212021-04-19 16:48:48 +02003433 if (handle_closure_in_use(ectx, FALSE) == FAIL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003434 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003435 goto done;
3436 }
3437
Bram Moolenaar4c137212021-04-19 16:48:48 +02003438 if (func_return(ectx) == FAIL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003439 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003440 }
3441 continue;
3442 }
3443
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00003444 /*
3445 * Big switch on the instruction. Most compilers will be turning this
3446 * into an efficient lookup table, since the "case" values are an enum
3447 * with sequential numbers. It may look ugly, but it should be the
3448 * most efficient way.
3449 */
Bram Moolenaar4c137212021-04-19 16:48:48 +02003450 iptr = &ectx->ec_instr[ectx->ec_iidx++];
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003451 switch (iptr->isn_type)
3452 {
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00003453 // Constructor, first instruction in a new() method.
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003454 case ISN_CONSTRUCT:
3455 // "this" is always the local variable at index zero
3456 tv = STACK_TV_VAR(0);
3457 tv->v_type = VAR_OBJECT;
3458 tv->vval.v_object = alloc_clear(
3459 iptr->isn_arg.construct.construct_size);
3460 tv->vval.v_object->obj_class =
3461 iptr->isn_arg.construct.construct_class;
Bram Moolenaard28d7b92022-12-08 20:42:00 +00003462 ++tv->vval.v_object->obj_class->class_refcount;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003463 tv->vval.v_object->obj_refcount = 1;
Bram Moolenaard28d7b92022-12-08 20:42:00 +00003464 object_created(tv->vval.v_object);
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01003465
3466 // When creating an enum value object, initialize the name and
3467 // ordinal object variables.
3468 class_T *en = tv->vval.v_object->obj_class;
3469 if (IS_ENUM(en))
3470 enum_set_internal_obj_vars(en, tv->vval.v_object);
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003471 break;
3472
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003473 // execute Ex command line
3474 case ISN_EXEC:
Ernie Raelee865f32023-09-29 19:53:55 +02003475 if (exec_command(iptr, iptr->isn_arg.string) == FAIL)
Bram Moolenaaraacc9662021-08-13 19:40:51 +02003476 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003477 break;
3478
Bram Moolenaar20677332021-06-06 17:02:53 +02003479 // execute Ex command line split at NL characters.
3480 case ISN_EXEC_SPLIT:
3481 {
3482 source_cookie_T cookie;
Bram Moolenaar518df272021-06-06 17:34:13 +02003483 char_u *line;
Bram Moolenaar20677332021-06-06 17:02:53 +02003484
3485 SOURCING_LNUM = iptr->isn_lnum;
3486 CLEAR_FIELD(cookie);
3487 cookie.sourcing_lnum = iptr->isn_lnum - 1;
3488 cookie.nextline = iptr->isn_arg.string;
Bram Moolenaar518df272021-06-06 17:34:13 +02003489 line = get_split_sourceline(0, &cookie, 0, 0);
3490 if (do_cmdline(line,
Bram Moolenaar20677332021-06-06 17:02:53 +02003491 get_split_sourceline, &cookie,
3492 DOCMD_VERBOSE|DOCMD_NOWAIT|DOCMD_KEYTYPED)
3493 == FAIL
3494 || did_emsg)
Bram Moolenaar518df272021-06-06 17:34:13 +02003495 {
3496 vim_free(line);
Bram Moolenaar20677332021-06-06 17:02:53 +02003497 goto on_error;
Bram Moolenaar518df272021-06-06 17:34:13 +02003498 }
3499 vim_free(line);
Bram Moolenaar20677332021-06-06 17:02:53 +02003500 }
3501 break;
3502
Bram Moolenaare4eed8c2021-12-01 15:22:56 +00003503 // execute Ex command line that is only a range
3504 case ISN_EXECRANGE:
3505 {
3506 exarg_T ea;
3507 char *error = NULL;
3508
3509 CLEAR_FIELD(ea);
3510 ea.cmdidx = CMD_SIZE;
3511 ea.addr_type = ADDR_LINES;
3512 ea.cmd = iptr->isn_arg.string;
Bram Moolenaar0c7f2612022-02-17 19:44:07 +00003513 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaare4eed8c2021-12-01 15:22:56 +00003514 parse_cmd_address(&ea, &error, FALSE);
Bram Moolenaar01a4dcb2021-12-04 13:15:10 +00003515 if (ea.cmd == NULL)
3516 goto on_error;
Bram Moolenaar0c7f2612022-02-17 19:44:07 +00003517 // error is always NULL when using ADDR_LINES
3518 error = ex_range_without_command(&ea);
Bram Moolenaare4eed8c2021-12-01 15:22:56 +00003519 if (error != NULL)
3520 {
Bram Moolenaare4eed8c2021-12-01 15:22:56 +00003521 emsg(error);
3522 goto on_error;
3523 }
3524 }
3525 break;
3526
Bram Moolenaar3b1373b2021-05-17 00:01:42 +02003527 // Evaluate an expression with legacy syntax, push it onto the
3528 // stack.
3529 case ISN_LEGACY_EVAL:
3530 {
3531 char_u *arg = iptr->isn_arg.string;
3532 int res;
3533 int save_flags = cmdmod.cmod_flags;
3534
Bram Moolenaar35578162021-08-02 19:10:38 +02003535 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003536 goto theend;
Bram Moolenaar3b1373b2021-05-17 00:01:42 +02003537 tv = STACK_TV_BOT(0);
3538 init_tv(tv);
3539 cmdmod.cmod_flags |= CMOD_LEGACY;
3540 res = eval0(arg, tv, NULL, &EVALARG_EVALUATE);
3541 cmdmod.cmod_flags = save_flags;
3542 if (res == FAIL)
3543 goto on_error;
3544 ++ectx->ec_stack.ga_len;
3545 }
3546 break;
3547
Bram Moolenaarf18332f2021-05-07 17:55:55 +02003548 // push typeval VAR_INSTR with instructions to be executed
3549 case ISN_INSTR:
3550 {
Bram Moolenaar35578162021-08-02 19:10:38 +02003551 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003552 goto theend;
Bram Moolenaarf18332f2021-05-07 17:55:55 +02003553 tv = STACK_TV_BOT(0);
3554 tv->vval.v_instr = ALLOC_ONE(instr_T);
3555 if (tv->vval.v_instr == NULL)
3556 goto on_error;
3557 ++ectx->ec_stack.ga_len;
3558
3559 tv->v_type = VAR_INSTR;
3560 tv->vval.v_instr->instr_ectx = ectx;
3561 tv->vval.v_instr->instr_instr = iptr->isn_arg.instr;
3562 }
3563 break;
3564
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003565 case ISN_SOURCE:
3566 {
Bram Moolenaar89445512022-04-14 12:58:23 +01003567 int notused;
LemonBoy77142312022-04-15 20:50:46 +01003568
Bram Moolenaar89445512022-04-14 12:58:23 +01003569 SOURCING_LNUM = iptr->isn_lnum;
3570 if (may_load_script((int)iptr->isn_arg.number, &notused)
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003571 == FAIL)
Bram Moolenaar89445512022-04-14 12:58:23 +01003572 goto on_error;
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003573 }
3574 break;
3575
Bram Moolenaar4c137212021-04-19 16:48:48 +02003576 // execute :substitute with an expression
3577 case ISN_SUBSTITUTE:
3578 {
3579 subs_T *subs = &iptr->isn_arg.subs;
3580 source_cookie_T cookie;
3581 struct subs_expr_S *save_instr = substitute_instr;
3582 struct subs_expr_S subs_instr;
3583 int res;
3584
3585 subs_instr.subs_ectx = ectx;
3586 subs_instr.subs_instr = subs->subs_instr;
3587 subs_instr.subs_status = OK;
3588 substitute_instr = &subs_instr;
3589
3590 SOURCING_LNUM = iptr->isn_lnum;
3591 // This is very much like ISN_EXEC
3592 CLEAR_FIELD(cookie);
3593 cookie.sourcing_lnum = iptr->isn_lnum - 1;
3594 res = do_cmdline(subs->subs_cmd,
3595 getsourceline, &cookie,
3596 DOCMD_VERBOSE|DOCMD_NOWAIT|DOCMD_KEYTYPED);
3597 substitute_instr = save_instr;
3598
3599 if (res == FAIL || did_emsg
3600 || subs_instr.subs_status == FAIL)
3601 goto on_error;
3602 }
3603 break;
3604
3605 case ISN_FINISH:
3606 goto done;
3607
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02003608 case ISN_REDIRSTART:
3609 // create a dummy entry for var_redir_str()
3610 if (alloc_redir_lval() == FAIL)
3611 goto on_error;
3612
3613 // The output is stored in growarray "redir_ga" until
3614 // redirection ends.
3615 init_redir_ga();
3616 redir_vname = 1;
3617 break;
3618
3619 case ISN_REDIREND:
3620 {
3621 char_u *res = get_clear_redir_ga();
3622
3623 // End redirection, put redirected text on the stack.
3624 clear_redir_lval();
3625 redir_vname = 0;
3626
Bram Moolenaar35578162021-08-02 19:10:38 +02003627 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02003628 {
3629 vim_free(res);
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003630 goto theend;
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02003631 }
3632 tv = STACK_TV_BOT(0);
3633 tv->v_type = VAR_STRING;
3634 tv->vval.v_string = res;
3635 ++ectx->ec_stack.ga_len;
3636 }
3637 break;
3638
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02003639 case ISN_CEXPR_AUCMD:
Bram Moolenaarb7c97812021-05-05 22:51:39 +02003640#ifdef FEAT_QUICKFIX
Bram Moolenaar397a87a2022-03-20 21:14:15 +00003641 force_abort = TRUE;
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02003642 if (trigger_cexpr_autocmd(iptr->isn_arg.number) == FAIL)
3643 goto on_error;
Bram Moolenaar397a87a2022-03-20 21:14:15 +00003644 force_abort = FALSE;
Bram Moolenaarb7c97812021-05-05 22:51:39 +02003645#endif
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02003646 break;
3647
3648 case ISN_CEXPR_CORE:
Bram Moolenaarb7c97812021-05-05 22:51:39 +02003649#ifdef FEAT_QUICKFIX
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02003650 {
3651 exarg_T ea;
3652 int res;
3653
3654 CLEAR_FIELD(ea);
3655 ea.cmdidx = iptr->isn_arg.cexpr.cexpr_ref->cer_cmdidx;
3656 ea.forceit = iptr->isn_arg.cexpr.cexpr_ref->cer_forceit;
3657 ea.cmdlinep = &iptr->isn_arg.cexpr.cexpr_ref->cer_cmdline;
3658 --ectx->ec_stack.ga_len;
3659 tv = STACK_TV_BOT(0);
Bram Moolenaarbd683e32022-07-18 17:49:03 +01003660 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02003661 res = cexpr_core(&ea, tv);
3662 clear_tv(tv);
3663 if (res == FAIL)
3664 goto on_error;
3665 }
Bram Moolenaarb7c97812021-05-05 22:51:39 +02003666#endif
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02003667 break;
3668
Bram Moolenaarcfe435d2020-04-25 20:02:55 +02003669 // execute Ex command from pieces on the stack
3670 case ISN_EXECCONCAT:
3671 {
3672 int count = iptr->isn_arg.number;
Bram Moolenaar7f6f56f2020-04-30 20:21:43 +02003673 size_t len = 0;
Bram Moolenaarcfe435d2020-04-25 20:02:55 +02003674 int pass;
3675 int i;
3676 char_u *cmd = NULL;
3677 char_u *str;
3678
3679 for (pass = 1; pass <= 2; ++pass)
3680 {
3681 for (i = 0; i < count; ++i)
3682 {
3683 tv = STACK_TV_BOT(i - count);
3684 str = tv->vval.v_string;
3685 if (str != NULL && *str != NUL)
3686 {
3687 if (pass == 2)
3688 STRCPY(cmd + len, str);
3689 len += STRLEN(str);
3690 }
3691 if (pass == 2)
3692 clear_tv(tv);
3693 }
3694 if (pass == 1)
3695 {
3696 cmd = alloc(len + 1);
Dominique Pelle5a9e5842021-07-24 19:32:12 +02003697 if (unlikely(cmd == NULL))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003698 goto theend;
Bram Moolenaarcfe435d2020-04-25 20:02:55 +02003699 len = 0;
3700 }
3701 }
3702
Bram Moolenaar6378c4f2020-04-26 13:50:41 +02003703 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaarcfe435d2020-04-25 20:02:55 +02003704 do_cmdline_cmd(cmd);
3705 vim_free(cmd);
3706 }
3707 break;
3708
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003709 // execute :echo {string} ...
3710 case ISN_ECHO:
3711 {
3712 int count = iptr->isn_arg.echo.echo_count;
3713 int atstart = TRUE;
3714 int needclr = TRUE;
Bram Moolenaar4c137212021-04-19 16:48:48 +02003715 int idx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003716
3717 for (idx = 0; idx < count; ++idx)
3718 {
3719 tv = STACK_TV_BOT(idx - count);
3720 echo_one(tv, iptr->isn_arg.echo.echo_with_white,
3721 &atstart, &needclr);
3722 clear_tv(tv);
3723 }
Bram Moolenaare0807ea2020-02-20 22:18:06 +01003724 if (needclr)
3725 msg_clr_eos();
Bram Moolenaar4c137212021-04-19 16:48:48 +02003726 ectx->ec_stack.ga_len -= count;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003727 }
3728 break;
3729
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +02003730 // :execute {string} ...
3731 // :echomsg {string} ...
Bram Moolenaar7d7ad7b2022-09-01 16:00:53 +01003732 // :echowindow {string} ...
Bram Moolenaar7de62622021-08-07 15:05:47 +02003733 // :echoconsole {string} ...
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +02003734 // :echoerr {string} ...
Bram Moolenaarad39c092020-02-26 18:23:43 +01003735 case ISN_EXECUTE:
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +02003736 case ISN_ECHOMSG:
Bram Moolenaar7d7ad7b2022-09-01 16:00:53 +01003737 case ISN_ECHOWINDOW:
Bram Moolenaar7de62622021-08-07 15:05:47 +02003738 case ISN_ECHOCONSOLE:
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +02003739 case ISN_ECHOERR:
Bram Moolenaarad39c092020-02-26 18:23:43 +01003740 {
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003741 int count;
Bram Moolenaarad39c092020-02-26 18:23:43 +01003742 garray_T ga;
3743 char_u buf[NUMBUFLEN];
3744 char_u *p;
3745 int len;
3746 int failed = FALSE;
Bram Moolenaar4c137212021-04-19 16:48:48 +02003747 int idx;
Bram Moolenaarad39c092020-02-26 18:23:43 +01003748
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003749 if (iptr->isn_type == ISN_ECHOWINDOW)
3750 count = iptr->isn_arg.echowin.ewin_count;
3751 else
3752 count = iptr->isn_arg.number;
Bram Moolenaarad39c092020-02-26 18:23:43 +01003753 ga_init2(&ga, 1, 80);
3754 for (idx = 0; idx < count; ++idx)
3755 {
3756 tv = STACK_TV_BOT(idx - count);
Bram Moolenaare5abf7a2020-08-16 18:29:35 +02003757 if (iptr->isn_type == ISN_EXECUTE)
Bram Moolenaarad39c092020-02-26 18:23:43 +01003758 {
Bram Moolenaare5abf7a2020-08-16 18:29:35 +02003759 if (tv->v_type == VAR_CHANNEL
3760 || tv->v_type == VAR_JOB)
3761 {
3762 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar68db9962021-05-09 23:19:22 +02003763 semsg(_(e_using_invalid_value_as_string_str),
3764 vartype_name(tv->v_type));
Bram Moolenaare5abf7a2020-08-16 18:29:35 +02003765 break;
3766 }
3767 else
3768 p = tv_get_string_buf(tv, buf);
Bram Moolenaarad39c092020-02-26 18:23:43 +01003769 }
3770 else
Ernie Raelbe828252024-07-26 18:37:02 +02003771 {
3772 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaare5abf7a2020-08-16 18:29:35 +02003773 p = tv_stringify(tv, buf);
Ernie Raelbe828252024-07-26 18:37:02 +02003774 }
Bram Moolenaarad39c092020-02-26 18:23:43 +01003775
3776 len = (int)STRLEN(p);
Bram Moolenaar35578162021-08-02 19:10:38 +02003777 if (GA_GROW_FAILS(&ga, len + 2))
Bram Moolenaarad39c092020-02-26 18:23:43 +01003778 failed = TRUE;
3779 else
3780 {
3781 if (ga.ga_len > 0)
3782 ((char_u *)(ga.ga_data))[ga.ga_len++] = ' ';
3783 STRCPY((char_u *)(ga.ga_data) + ga.ga_len, p);
3784 ga.ga_len += len;
3785 }
3786 clear_tv(tv);
3787 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02003788 ectx->ec_stack.ga_len -= count;
Bram Moolenaare5abf7a2020-08-16 18:29:35 +02003789 if (failed)
Bram Moolenaarc71ee822020-11-21 11:45:50 +01003790 {
3791 ga_clear(&ga);
Bram Moolenaare5abf7a2020-08-16 18:29:35 +02003792 goto on_error;
Bram Moolenaarc71ee822020-11-21 11:45:50 +01003793 }
Bram Moolenaarad39c092020-02-26 18:23:43 +01003794
Bram Moolenaare5abf7a2020-08-16 18:29:35 +02003795 if (ga.ga_data != NULL)
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +02003796 {
3797 if (iptr->isn_type == ISN_EXECUTE)
Bram Moolenaar430deb12020-08-23 16:29:11 +02003798 {
3799 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +02003800 do_cmdline_cmd((char_u *)ga.ga_data);
Bram Moolenaareeece9e2020-11-20 19:26:48 +01003801 if (did_emsg)
Bram Moolenaarc71ee822020-11-21 11:45:50 +01003802 {
3803 ga_clear(&ga);
Bram Moolenaareeece9e2020-11-20 19:26:48 +01003804 goto on_error;
Bram Moolenaarc71ee822020-11-21 11:45:50 +01003805 }
Bram Moolenaar430deb12020-08-23 16:29:11 +02003806 }
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +02003807 else
3808 {
3809 msg_sb_eol();
3810 if (iptr->isn_type == ISN_ECHOMSG)
3811 {
3812 msg_attr(ga.ga_data, echo_attr);
3813 out_flush();
3814 }
Bram Moolenaar7d7ad7b2022-09-01 16:00:53 +01003815#ifdef HAS_MESSAGE_WINDOW
3816 else if (iptr->isn_type == ISN_ECHOWINDOW)
3817 {
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003818 start_echowindow(
3819 iptr->isn_arg.echowin.ewin_time);
Bram Moolenaar7d7ad7b2022-09-01 16:00:53 +01003820 msg_attr(ga.ga_data, echo_attr);
3821 end_echowindow();
3822 }
3823#endif
Bram Moolenaar7de62622021-08-07 15:05:47 +02003824 else if (iptr->isn_type == ISN_ECHOCONSOLE)
3825 {
3826 ui_write(ga.ga_data, (int)STRLEN(ga.ga_data),
3827 TRUE);
3828 ui_write((char_u *)"\r\n", 2, TRUE);
3829 }
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +02003830 else
3831 {
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +02003832 SOURCING_LNUM = iptr->isn_lnum;
3833 emsg(ga.ga_data);
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +02003834 }
3835 }
3836 }
Bram Moolenaarad39c092020-02-26 18:23:43 +01003837 ga_clear(&ga);
3838 }
3839 break;
3840
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003841 // load local variable or argument
3842 case ISN_LOAD:
Bram Moolenaar35578162021-08-02 19:10:38 +02003843 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003844 goto theend;
Bram Moolenaar2ed57ac2023-04-01 22:05:38 +01003845 tv = STACK_TV_VAR(iptr->isn_arg.number);
3846 if (tv->v_type == VAR_UNKNOWN)
3847 {
3848 // missing argument or default value v:none
3849 STACK_TV_BOT(0)->v_type = VAR_SPECIAL;
3850 STACK_TV_BOT(0)->vval.v_number = VVAL_NONE;
3851 }
3852 else
3853 copy_tv(tv, STACK_TV_BOT(0));
Bram Moolenaar4c137212021-04-19 16:48:48 +02003854 ++ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003855 break;
3856
3857 // load v: variable
3858 case ISN_LOADV:
Bram Moolenaar35578162021-08-02 19:10:38 +02003859 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003860 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003861 copy_tv(get_vim_var_tv(iptr->isn_arg.number), STACK_TV_BOT(0));
Bram Moolenaar4c137212021-04-19 16:48:48 +02003862 ++ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003863 break;
3864
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01003865 // load s: variable in Vim9 script
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003866 case ISN_LOADSCRIPT:
3867 {
Bram Moolenaar4aab88d2020-12-24 21:56:41 +01003868 scriptref_T *sref = iptr->isn_arg.script.scriptref;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003869 svar_T *sv;
3870
Bram Moolenaar6db660b2021-08-01 14:08:54 +02003871 sv = get_script_svar(sref, ectx->ec_dfunc_idx);
Bram Moolenaar07a65d22020-12-26 20:09:15 +01003872 if (sv == NULL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003873 goto theend;
Bram Moolenaar859cc212022-03-28 15:22:35 +01003874 allocate_if_null(sv);
Bram Moolenaar35578162021-08-02 19:10:38 +02003875 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003876 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003877 copy_tv(sv->sv_tv, STACK_TV_BOT(0));
Bram Moolenaar4c137212021-04-19 16:48:48 +02003878 ++ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003879 }
3880 break;
3881
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003882 // load s: variable in old script or autoload import
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003883 case ISN_LOADS:
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003884 case ISN_LOADEXPORT:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003885 {
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003886 int sid = iptr->isn_arg.loadstore.ls_sid;
3887 hashtab_T *ht = &SCRIPT_VARS(sid);
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01003888 char_u *name = iptr->isn_arg.loadstore.ls_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003889 dictitem_T *di = find_var_in_ht(ht, 0, name, TRUE);
Bram Moolenaar0bbf7222020-02-19 22:31:48 +01003890
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003891 if (di == NULL)
3892 {
Bram Moolenaar7517ffd2020-08-14 18:35:07 +02003893 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003894 semsg(_(e_undefined_variable_str), name);
Bram Moolenaarf0b9f432020-07-17 23:03:17 +02003895 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003896 }
3897 else
3898 {
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003899 if (iptr->isn_type == ISN_LOADEXPORT)
3900 {
3901 int idx = get_script_item_idx(sid, name, 0,
3902 NULL, NULL);
3903 svar_T *sv;
3904
3905 if (idx >= 0)
3906 {
3907 sv = ((svar_T *)SCRIPT_ITEM(sid)
3908 ->sn_var_vals.ga_data) + idx;
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003909 if ((sv->sv_flags & SVFLAG_EXPORTED) == 0)
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003910 {
3911 SOURCING_LNUM = iptr->isn_lnum;
3912 semsg(_(e_item_not_exported_in_script_str),
3913 name);
3914 goto on_error;
3915 }
3916 }
3917 }
Bram Moolenaar35578162021-08-02 19:10:38 +02003918 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003919 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003920 copy_tv(&di->di_tv, STACK_TV_BOT(0));
Bram Moolenaar4c137212021-04-19 16:48:48 +02003921 ++ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003922 }
3923 }
3924 break;
3925
Bram Moolenaard3aac292020-04-19 14:32:17 +02003926 // load g:/b:/w:/t: variable
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003927 case ISN_LOADG:
Bram Moolenaard3aac292020-04-19 14:32:17 +02003928 case ISN_LOADB:
3929 case ISN_LOADW:
3930 case ISN_LOADT:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003931 {
Bram Moolenaar06b77222022-01-25 15:51:56 +00003932 int res = load_namespace_var(ectx, iptr->isn_type, iptr);
Bram Moolenaar2f8ce0a2020-07-19 19:47:35 +02003933
Bram Moolenaar06b77222022-01-25 15:51:56 +00003934 if (res == NOTDONE)
Bram Moolenaarcbbc48f2022-01-18 12:58:28 +00003935 goto theend;
Bram Moolenaar06b77222022-01-25 15:51:56 +00003936 if (res == FAIL)
Bram Moolenaarf0b9f432020-07-17 23:03:17 +02003937 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003938 }
Bram Moolenaar06b77222022-01-25 15:51:56 +00003939
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003940 break;
3941
Bram Moolenaar03290b82020-12-19 16:30:44 +01003942 // load autoload variable
3943 case ISN_LOADAUTO:
3944 {
3945 char_u *name = iptr->isn_arg.string;
3946
Bram Moolenaar35578162021-08-02 19:10:38 +02003947 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003948 goto theend;
Bram Moolenaar03290b82020-12-19 16:30:44 +01003949 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003950 if (eval_variable(name, (int)STRLEN(name), 0,
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01003951 STACK_TV_BOT(0), NULL, EVAL_VAR_VERBOSE) == FAIL)
Bram Moolenaar03290b82020-12-19 16:30:44 +01003952 goto on_error;
Bram Moolenaar4c137212021-04-19 16:48:48 +02003953 ++ectx->ec_stack.ga_len;
Bram Moolenaar03290b82020-12-19 16:30:44 +01003954 }
3955 break;
3956
Bram Moolenaar2f8ce0a2020-07-19 19:47:35 +02003957 // load g:/b:/w:/t: namespace
3958 case ISN_LOADGDICT:
3959 case ISN_LOADBDICT:
3960 case ISN_LOADWDICT:
3961 case ISN_LOADTDICT:
3962 {
3963 dict_T *d = NULL;
3964
3965 switch (iptr->isn_type)
3966 {
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003967 case ISN_LOADGDICT: d = get_globvar_dict(); break;
3968 case ISN_LOADBDICT: d = curbuf->b_vars; break;
3969 case ISN_LOADWDICT: d = curwin->w_vars; break;
3970 case ISN_LOADTDICT: d = curtab->tp_vars; break;
Bram Moolenaar2f8ce0a2020-07-19 19:47:35 +02003971 default: // Cannot reach here
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003972 goto theend;
Bram Moolenaar2f8ce0a2020-07-19 19:47:35 +02003973 }
Bram Moolenaar35578162021-08-02 19:10:38 +02003974 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003975 goto theend;
Bram Moolenaar2f8ce0a2020-07-19 19:47:35 +02003976 tv = STACK_TV_BOT(0);
3977 tv->v_type = VAR_DICT;
3978 tv->v_lock = 0;
3979 tv->vval.v_dict = d;
Bram Moolenaar1bd3cb22021-02-24 12:27:31 +01003980 ++d->dv_refcount;
Bram Moolenaar4c137212021-04-19 16:48:48 +02003981 ++ectx->ec_stack.ga_len;
Bram Moolenaar2f8ce0a2020-07-19 19:47:35 +02003982 }
3983 break;
3984
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003985 // load &option
3986 case ISN_LOADOPT:
3987 {
3988 typval_T optval;
3989 char_u *name = iptr->isn_arg.string;
3990
Bram Moolenaara8c17702020-04-01 21:17:24 +02003991 // This is not expected to fail, name is checked during
3992 // compilation: don't set SOURCING_LNUM.
Bram Moolenaar35578162021-08-02 19:10:38 +02003993 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003994 goto theend;
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02003995 if (eval_option(&name, &optval, TRUE) == FAIL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003996 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003997 *STACK_TV_BOT(0) = optval;
Bram Moolenaar4c137212021-04-19 16:48:48 +02003998 ++ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003999 }
4000 break;
4001
4002 // load $ENV
4003 case ISN_LOADENV:
4004 {
4005 typval_T optval;
4006 char_u *name = iptr->isn_arg.string;
4007
Bram Moolenaar35578162021-08-02 19:10:38 +02004008 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004009 goto theend;
Bram Moolenaar0bbf7222020-02-19 22:31:48 +01004010 // name is always valid, checked when compiling
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02004011 (void)eval_env_var(&name, &optval, TRUE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004012 *STACK_TV_BOT(0) = optval;
Bram Moolenaar4c137212021-04-19 16:48:48 +02004013 ++ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004014 }
4015 break;
4016
4017 // load @register
4018 case ISN_LOADREG:
Bram Moolenaar35578162021-08-02 19:10:38 +02004019 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004020 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004021 tv = STACK_TV_BOT(0);
4022 tv->v_type = VAR_STRING;
Bram Moolenaar2f8ce0a2020-07-19 19:47:35 +02004023 tv->v_lock = 0;
Bram Moolenaar1e021e62020-10-16 20:25:23 +02004024 // This may result in NULL, which should be equivalent to an
4025 // empty string.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004026 tv->vval.v_string = get_reg_contents(
4027 iptr->isn_arg.number, GREG_EXPR_SRC);
Bram Moolenaar4c137212021-04-19 16:48:48 +02004028 ++ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004029 break;
4030
4031 // store local variable
4032 case ISN_STORE:
Bram Moolenaar4c137212021-04-19 16:48:48 +02004033 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004034 tv = STACK_TV_VAR(iptr->isn_arg.number);
Ernie Rael9ed53752023-12-11 17:40:46 +01004035 if (check_typval_is_value(STACK_TV_BOT(0)) == FAIL)
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02004036 {
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02004037 clear_tv(STACK_TV_BOT(0));
4038 goto on_error;
4039 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004040 clear_tv(tv);
4041 *tv = *STACK_TV_BOT(0);
4042 break;
4043
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01004044 // store s: variable in old script or autoload import
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01004045 case ISN_STORES:
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01004046 case ISN_STOREEXPORT:
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01004047 {
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01004048 int sid = iptr->isn_arg.loadstore.ls_sid;
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01004049 char_u *name = iptr->isn_arg.loadstore.ls_name;
Ernie Rael3f821d62024-04-24 20:07:50 +02004050 dictitem_T *di = NULL;
4051 // First check for a variable from an exported autoload
4052 // with an autoload_prefix; it would be in globals.
4053 if (iptr->isn_type == ISN_STOREEXPORT)
4054 di = find_var_autoload_prefix(name, sid, NULL, NULL);
4055 // Then look for a variable in the script's variables.
4056 if (di == NULL)
4057 {
4058 hashtab_T *ht = &SCRIPT_VARS(sid);
4059 di = find_var_in_ht(ht, 0, STRNCMP("s:", name, 2) == 0
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01004060 ? name + 2 : name, TRUE);
Ernie Rael3f821d62024-04-24 20:07:50 +02004061 }
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01004062
Bram Moolenaar4c137212021-04-19 16:48:48 +02004063 --ectx->ec_stack.ga_len;
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01004064 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar0bbf7222020-02-19 22:31:48 +01004065 if (di == NULL)
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01004066 {
4067 if (iptr->isn_type == ISN_STOREEXPORT)
4068 {
4069 semsg(_(e_undefined_variable_str), name);
Bram Moolenaard1d26842022-03-31 10:13:47 +01004070 clear_tv(STACK_TV_BOT(0));
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01004071 goto on_error;
4072 }
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004073 store_var(name, STACK_TV_BOT(0));
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01004074 }
Bram Moolenaar0bbf7222020-02-19 22:31:48 +01004075 else
4076 {
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01004077 if (iptr->isn_type == ISN_STOREEXPORT)
4078 {
4079 int idx = get_script_item_idx(sid, name, 0,
4080 NULL, NULL);
4081
Bram Moolenaar06651632022-04-27 17:54:25 +01004082 // can this ever fail?
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01004083 if (idx >= 0)
4084 {
4085 svar_T *sv = ((svar_T *)SCRIPT_ITEM(sid)
4086 ->sn_var_vals.ga_data) + idx;
4087
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01004088 if ((sv->sv_flags & SVFLAG_EXPORTED) == 0)
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01004089 {
4090 semsg(_(e_item_not_exported_in_script_str),
4091 name);
Bram Moolenaard1d26842022-03-31 10:13:47 +01004092 clear_tv(STACK_TV_BOT(0));
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01004093 goto on_error;
4094 }
4095 }
4096 }
Bram Moolenaardcf29ac2021-04-02 14:44:02 +02004097 if (var_check_permission(di, name) == FAIL)
Bram Moolenaar6e50ec22021-04-03 19:32:44 +02004098 {
4099 clear_tv(STACK_TV_BOT(0));
Bram Moolenaardcf29ac2021-04-02 14:44:02 +02004100 goto on_error;
Bram Moolenaar6e50ec22021-04-03 19:32:44 +02004101 }
Bram Moolenaar0bbf7222020-02-19 22:31:48 +01004102 clear_tv(&di->di_tv);
4103 di->di_tv = *STACK_TV_BOT(0);
4104 }
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01004105 }
4106 break;
4107
4108 // store script-local variable in Vim9 script
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004109 case ISN_STORESCRIPT:
4110 {
Bram Moolenaar07a65d22020-12-26 20:09:15 +01004111 scriptref_T *sref = iptr->isn_arg.script.scriptref;
4112 svar_T *sv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004113
Bram Moolenaar6db660b2021-08-01 14:08:54 +02004114 sv = get_script_svar(sref, ectx->ec_dfunc_idx);
Bram Moolenaar07a65d22020-12-26 20:09:15 +01004115 if (sv == NULL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004116 goto theend;
Bram Moolenaar4c137212021-04-19 16:48:48 +02004117 --ectx->ec_stack.ga_len;
Bram Moolenaarf5906aa2021-04-02 14:35:15 +02004118
4119 // "const" and "final" are checked at compile time, locking
4120 // the value needs to be checked here.
4121 SOURCING_LNUM = iptr->isn_lnum;
4122 if (value_check_lock(sv->sv_tv->v_lock, sv->sv_name, FALSE))
Bram Moolenaar6e50ec22021-04-03 19:32:44 +02004123 {
4124 clear_tv(STACK_TV_BOT(0));
Bram Moolenaarf5906aa2021-04-02 14:35:15 +02004125 goto on_error;
Bram Moolenaar6e50ec22021-04-03 19:32:44 +02004126 }
Bram Moolenaarf5906aa2021-04-02 14:35:15 +02004127
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004128 clear_tv(sv->sv_tv);
4129 *sv->sv_tv = *STACK_TV_BOT(0);
4130 }
4131 break;
4132
4133 // store option
4134 case ISN_STOREOPT:
Bram Moolenaardcb53be2021-12-09 14:23:43 +00004135 case ISN_STOREFUNCOPT:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004136 {
Bram Moolenaardcb53be2021-12-09 14:23:43 +00004137 char_u *opt_name = iptr->isn_arg.storeopt.so_name;
4138 int opt_flags = iptr->isn_arg.storeopt.so_flags;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004139 long n = 0;
4140 char_u *s = NULL;
4141 char *msg;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00004142 char_u numbuf[NUMBUFLEN];
4143 char_u *tofree = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004144
Bram Moolenaar4c137212021-04-19 16:48:48 +02004145 --ectx->ec_stack.ga_len;
LemonBoy32f34612023-09-02 21:52:05 +02004146 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004147 tv = STACK_TV_BOT(0);
4148 if (tv->v_type == VAR_STRING)
Bram Moolenaar97a2af32020-01-28 22:52:48 +01004149 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004150 s = tv->vval.v_string;
Bram Moolenaar97a2af32020-01-28 22:52:48 +01004151 if (s == NULL)
4152 s = (char_u *)"";
4153 }
Bram Moolenaardcb53be2021-12-09 14:23:43 +00004154 else if (iptr->isn_type == ISN_STOREFUNCOPT)
4155 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00004156 // If the option can be set to a function reference or
4157 // a lambda and the passed value is a function
4158 // reference, then convert it to the name (string) of
4159 // the function reference.
4160 s = tv2string(tv, &tofree, numbuf, 0);
4161 if (s == NULL || *s == NUL)
Bram Moolenaardcb53be2021-12-09 14:23:43 +00004162 {
Bram Moolenaar397a87a2022-03-20 21:14:15 +00004163 // cannot happen?
Bram Moolenaardcb53be2021-12-09 14:23:43 +00004164 clear_tv(tv);
Bram Moolenaar397a87a2022-03-20 21:14:15 +00004165 vim_free(tofree);
Bram Moolenaardcb53be2021-12-09 14:23:43 +00004166 goto on_error;
4167 }
Bram Moolenaardcb53be2021-12-09 14:23:43 +00004168 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004169 else
Bram Moolenaara6e67e42020-05-15 23:36:40 +02004170 // must be VAR_NUMBER, CHECKTYPE makes sure
4171 n = tv->vval.v_number;
Bram Moolenaardcb53be2021-12-09 14:23:43 +00004172 msg = set_option_value(opt_name, n, s, opt_flags);
Bram Moolenaare75ba262020-05-16 15:43:31 +02004173 clear_tv(tv);
Bram Moolenaar2ef91562021-12-11 16:14:07 +00004174 vim_free(tofree);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004175 if (msg != NULL)
4176 {
Bram Moolenaar7517ffd2020-08-14 18:35:07 +02004177 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004178 emsg(_(msg));
Bram Moolenaare8593122020-07-18 15:17:02 +02004179 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004180 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004181 }
4182 break;
4183
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01004184 // store $ENV
4185 case ISN_STOREENV:
Bram Moolenaar4c137212021-04-19 16:48:48 +02004186 --ectx->ec_stack.ga_len;
Bram Moolenaar20431c92020-03-20 18:39:46 +01004187 tv = STACK_TV_BOT(0);
4188 vim_setenv_ext(iptr->isn_arg.string, tv_get_string(tv));
4189 clear_tv(tv);
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01004190 break;
4191
4192 // store @r
4193 case ISN_STOREREG:
4194 {
4195 int reg = iptr->isn_arg.number;
4196
Bram Moolenaar4c137212021-04-19 16:48:48 +02004197 --ectx->ec_stack.ga_len;
Bram Moolenaar401d9ff2020-02-19 18:14:44 +01004198 tv = STACK_TV_BOT(0);
Bram Moolenaar74f4a962021-06-17 21:03:07 +02004199 write_reg_contents(reg, tv_get_string(tv), -1, FALSE);
Bram Moolenaar401d9ff2020-02-19 18:14:44 +01004200 clear_tv(tv);
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01004201 }
4202 break;
4203
4204 // store v: variable
4205 case ISN_STOREV:
Bram Moolenaar4c137212021-04-19 16:48:48 +02004206 --ectx->ec_stack.ga_len;
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01004207 if (set_vim_var_tv(iptr->isn_arg.number, STACK_TV_BOT(0))
4208 == FAIL)
Bram Moolenaare8593122020-07-18 15:17:02 +02004209 // should not happen, type is checked when compiling
4210 goto on_error;
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01004211 break;
4212
Bram Moolenaard3aac292020-04-19 14:32:17 +02004213 // store g:/b:/w:/t: variable
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004214 case ISN_STOREG:
Bram Moolenaard3aac292020-04-19 14:32:17 +02004215 case ISN_STOREB:
4216 case ISN_STOREW:
4217 case ISN_STORET:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004218 {
Bram Moolenaar3bdc90b2020-12-22 20:35:40 +01004219 dictitem_T *di;
4220 hashtab_T *ht;
4221 char_u *name = iptr->isn_arg.string + 2;
4222
Bram Moolenaard3aac292020-04-19 14:32:17 +02004223 switch (iptr->isn_type)
4224 {
4225 case ISN_STOREG:
4226 ht = get_globvar_ht();
4227 break;
4228 case ISN_STOREB:
4229 ht = &curbuf->b_vars->dv_hashtab;
4230 break;
4231 case ISN_STOREW:
4232 ht = &curwin->w_vars->dv_hashtab;
4233 break;
4234 case ISN_STORET:
4235 ht = &curtab->tp_vars->dv_hashtab;
4236 break;
4237 default: // Cannot reach here
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004238 goto theend;
Bram Moolenaard3aac292020-04-19 14:32:17 +02004239 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004240
Bram Moolenaar4c137212021-04-19 16:48:48 +02004241 --ectx->ec_stack.ga_len;
Bram Moolenaar3bdc90b2020-12-22 20:35:40 +01004242 di = find_var_in_ht(ht, 0, name, TRUE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004243 if (di == NULL)
Bram Moolenaar0bbf7222020-02-19 22:31:48 +01004244 store_var(iptr->isn_arg.string, STACK_TV_BOT(0));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004245 else
4246 {
Bram Moolenaar3bdc90b2020-12-22 20:35:40 +01004247 SOURCING_LNUM = iptr->isn_lnum;
4248 if (var_check_permission(di, name) == FAIL)
4249 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004250 clear_tv(&di->di_tv);
4251 di->di_tv = *STACK_TV_BOT(0);
4252 }
4253 }
4254 break;
4255
Bram Moolenaar03290b82020-12-19 16:30:44 +01004256 // store an autoload variable
4257 case ISN_STOREAUTO:
4258 SOURCING_LNUM = iptr->isn_lnum;
4259 set_var(iptr->isn_arg.string, STACK_TV_BOT(-1), TRUE);
4260 clear_tv(STACK_TV_BOT(-1));
Bram Moolenaar4c137212021-04-19 16:48:48 +02004261 --ectx->ec_stack.ga_len;
Bram Moolenaar03290b82020-12-19 16:30:44 +01004262 break;
4263
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004264 // store number in local variable
4265 case ISN_STORENR:
Bram Moolenaara471eea2020-03-04 22:20:26 +01004266 tv = STACK_TV_VAR(iptr->isn_arg.storenr.stnr_idx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004267 clear_tv(tv);
4268 tv->v_type = VAR_NUMBER;
Bram Moolenaara471eea2020-03-04 22:20:26 +01004269 tv->vval.v_number = iptr->isn_arg.storenr.stnr_val;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004270 break;
4271
Bram Moolenaar590162c2022-12-24 21:24:06 +00004272 // Store a value in a list, dict, blob or object variable.
Bram Moolenaar4f5e3972020-12-21 17:30:50 +01004273 case ISN_STOREINDEX:
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02004274 {
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00004275 int res = execute_storeindex(iptr, ectx);
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02004276
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00004277 if (res == FAIL)
Bram Moolenaar8e4c8c82020-08-01 15:38:38 +02004278 goto on_error;
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00004279 if (res == NOTDONE)
4280 goto theend;
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02004281 }
4282 break;
4283
Bram Moolenaarea5c8982022-02-17 14:42:02 +00004284 // store value in list or blob range
Bram Moolenaar68452172021-04-12 21:21:02 +02004285 case ISN_STORERANGE:
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00004286 if (execute_storerange(iptr, ectx) == FAIL)
4287 goto on_error;
Bram Moolenaar68452172021-04-12 21:21:02 +02004288 break;
4289
Bram Moolenaard505d172022-12-18 21:42:55 +00004290 case ISN_LOAD_CLASSMEMBER:
4291 {
4292 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
4293 goto theend;
4294 classmember_T *cm = &iptr->isn_arg.classmember;
Bram Moolenaar4e2406c2023-06-24 19:22:21 +01004295 copy_tv(cm->cm_class->class_members_tv + cm->cm_idx,
4296 STACK_TV_BOT(0));
Bram Moolenaard505d172022-12-18 21:42:55 +00004297 ++ectx->ec_stack.ga_len;
4298 }
4299 break;
4300
4301 case ISN_STORE_CLASSMEMBER:
4302 {
4303 classmember_T *cm = &iptr->isn_arg.classmember;
4304 tv = &cm->cm_class->class_members_tv[cm->cm_idx];
4305 clear_tv(tv);
4306 *tv = *STACK_TV_BOT(-1);
4307 --ectx->ec_stack.ga_len;
4308 }
4309 break;
4310
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01004311 // Load or store variable or argument from outer scope.
Bram Moolenaar0186e582021-01-10 18:33:11 +01004312 case ISN_LOADOUTER:
4313 case ISN_STOREOUTER:
4314 {
4315 int depth = iptr->isn_arg.outer.outer_depth;
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02004316 outer_T *outer = ectx->ec_outer_ref == NULL ? NULL
4317 : ectx->ec_outer_ref->or_outer;
Bram Moolenaar0186e582021-01-10 18:33:11 +01004318
4319 while (depth > 1 && outer != NULL)
4320 {
4321 outer = outer->out_up;
4322 --depth;
4323 }
4324 if (outer == NULL)
4325 {
4326 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar69c76172021-12-02 16:38:52 +00004327 if (ectx->ec_frame_idx == ectx->ec_initial_frame_idx
4328 || ectx->ec_outer_ref == NULL)
4329 // Possibly :def function called from legacy
4330 // context.
4331 emsg(_(e_closure_called_from_invalid_context));
4332 else
4333 iemsg("LOADOUTER depth more than scope levels");
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004334 goto theend;
Bram Moolenaar0186e582021-01-10 18:33:11 +01004335 }
Bram Moolenaarcc341812022-09-19 15:54:34 +01004336 if (depth < 0)
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01004337 // Variable declared in loop. May be copied if the
4338 // loop block has already ended.
Bram Moolenaarcc341812022-09-19 15:54:34 +01004339 tv = ((typval_T *)outer->out_loop[-depth - 1]
4340 .stack->ga_data)
4341 + outer->out_loop[-depth - 1].var_idx
4342 + iptr->isn_arg.outer.outer_idx;
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01004343 else
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01004344 // Variable declared in a function. May be copied if
4345 // the function has already returned.
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01004346 tv = ((typval_T *)outer->out_stack->ga_data)
4347 + outer->out_frame_idx + STACK_FRAME_SIZE
4348 + iptr->isn_arg.outer.outer_idx;
Bram Moolenaar0186e582021-01-10 18:33:11 +01004349 if (iptr->isn_type == ISN_LOADOUTER)
4350 {
Christian Brabandt5dd41d42023-12-04 22:52:23 +01004351 typval_T *copy;
Bram Moolenaar35578162021-08-02 19:10:38 +02004352 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004353 goto theend;
Christian Brabandt5dd41d42023-12-04 22:52:23 +01004354 // careful: ga_grow_inner may re-alloc the stack
4355 if (depth < 0)
4356 copy = ((typval_T *)outer->out_loop[-depth - 1]
4357 .stack->ga_data)
4358 + outer->out_loop[-depth - 1].var_idx
4359 + iptr->isn_arg.outer.outer_idx;
4360 else
4361 copy = ((typval_T *)outer->out_stack->ga_data)
4362 + outer->out_frame_idx + STACK_FRAME_SIZE
4363 + iptr->isn_arg.outer.outer_idx;
4364 // memory was freed, get tv again
4365 if (copy != tv)
4366 tv = copy;
Bram Moolenaar0186e582021-01-10 18:33:11 +01004367 copy_tv(tv, STACK_TV_BOT(0));
Bram Moolenaar4c137212021-04-19 16:48:48 +02004368 ++ectx->ec_stack.ga_len;
Bram Moolenaar0186e582021-01-10 18:33:11 +01004369 }
4370 else
4371 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02004372 --ectx->ec_stack.ga_len;
Bram Moolenaar0186e582021-01-10 18:33:11 +01004373 clear_tv(tv);
4374 *tv = *STACK_TV_BOT(0);
4375 }
4376 }
4377 break;
4378
Bram Moolenaar752fc692021-01-04 21:57:11 +01004379 // unlet item in list or dict variable
4380 case ISN_UNLETINDEX:
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00004381 if (execute_unletindex(iptr, ectx) == FAIL)
4382 goto on_error;
Bram Moolenaar752fc692021-01-04 21:57:11 +01004383 break;
4384
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01004385 // unlet range of items in list variable
4386 case ISN_UNLETRANGE:
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00004387 if (execute_unletrange(iptr, ectx) == FAIL)
4388 goto on_error;
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01004389 break;
4390
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004391 // push constant
4392 case ISN_PUSHNR:
4393 case ISN_PUSHBOOL:
4394 case ISN_PUSHSPEC:
4395 case ISN_PUSHF:
4396 case ISN_PUSHS:
4397 case ISN_PUSHBLOB:
Bram Moolenaar42a480b2020-02-29 23:23:47 +01004398 case ISN_PUSHFUNC:
Bram Moolenaar42a480b2020-02-29 23:23:47 +01004399 case ISN_PUSHCHANNEL:
4400 case ISN_PUSHJOB:
Bram Moolenaarc4e1b862023-02-26 18:58:23 +00004401 case ISN_PUSHOBJ:
4402 case ISN_PUSHCLASS:
Bram Moolenaar35578162021-08-02 19:10:38 +02004403 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004404 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004405 tv = STACK_TV_BOT(0);
Bram Moolenaar2f8ce0a2020-07-19 19:47:35 +02004406 tv->v_lock = 0;
Bram Moolenaar4c137212021-04-19 16:48:48 +02004407 ++ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004408 switch (iptr->isn_type)
4409 {
4410 case ISN_PUSHNR:
4411 tv->v_type = VAR_NUMBER;
4412 tv->vval.v_number = iptr->isn_arg.number;
4413 break;
4414 case ISN_PUSHBOOL:
4415 tv->v_type = VAR_BOOL;
4416 tv->vval.v_number = iptr->isn_arg.number;
4417 break;
4418 case ISN_PUSHSPEC:
4419 tv->v_type = VAR_SPECIAL;
4420 tv->vval.v_number = iptr->isn_arg.number;
4421 break;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004422 case ISN_PUSHF:
4423 tv->v_type = VAR_FLOAT;
4424 tv->vval.v_float = iptr->isn_arg.fnumber;
4425 break;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004426 case ISN_PUSHBLOB:
4427 blob_copy(iptr->isn_arg.blob, tv);
4428 break;
Bram Moolenaar42a480b2020-02-29 23:23:47 +01004429 case ISN_PUSHFUNC:
4430 tv->v_type = VAR_FUNC;
Bram Moolenaar087d2e12020-03-01 15:36:42 +01004431 if (iptr->isn_arg.string == NULL)
4432 tv->vval.v_string = NULL;
4433 else
4434 tv->vval.v_string =
4435 vim_strsave(iptr->isn_arg.string);
Bram Moolenaar42a480b2020-02-29 23:23:47 +01004436 break;
Bram Moolenaar42a480b2020-02-29 23:23:47 +01004437 case ISN_PUSHCHANNEL:
4438#ifdef FEAT_JOB_CHANNEL
4439 tv->v_type = VAR_CHANNEL;
Bram Moolenaar397a87a2022-03-20 21:14:15 +00004440 tv->vval.v_channel = NULL;
Bram Moolenaar42a480b2020-02-29 23:23:47 +01004441#endif
4442 break;
4443 case ISN_PUSHJOB:
4444#ifdef FEAT_JOB_CHANNEL
4445 tv->v_type = VAR_JOB;
Bram Moolenaar397a87a2022-03-20 21:14:15 +00004446 tv->vval.v_job = NULL;
Bram Moolenaar42a480b2020-02-29 23:23:47 +01004447#endif
4448 break;
Bram Moolenaarc4e1b862023-02-26 18:58:23 +00004449 case ISN_PUSHOBJ:
4450 tv->v_type = VAR_OBJECT;
4451 tv->vval.v_object = NULL;
4452 break;
4453 case ISN_PUSHCLASS:
4454 tv->v_type = VAR_CLASS;
Bram Moolenaar30a84472023-02-27 08:07:14 +00004455 tv->vval.v_class = iptr->isn_arg.classarg;
Bram Moolenaarc4e1b862023-02-26 18:58:23 +00004456 break;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004457 default:
4458 tv->v_type = VAR_STRING;
Bram Moolenaarf8691002022-03-10 12:20:53 +00004459 tv->vval.v_string = iptr->isn_arg.string == NULL
4460 ? NULL : vim_strsave(iptr->isn_arg.string);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004461 }
4462 break;
4463
Bram Moolenaar06b77222022-01-25 15:51:56 +00004464 case ISN_AUTOLOAD:
4465 {
4466 char_u *name = iptr->isn_arg.string;
4467
4468 (void)script_autoload(name, FALSE);
4469 if (find_func(name, TRUE))
4470 {
4471 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
4472 goto theend;
4473 tv = STACK_TV_BOT(0);
4474 tv->v_lock = 0;
4475 ++ectx->ec_stack.ga_len;
4476 tv->v_type = VAR_FUNC;
4477 tv->vval.v_string = vim_strsave(name);
4478 }
4479 else
4480 {
4481 int res = load_namespace_var(ectx, ISN_LOADG, iptr);
4482
4483 if (res == NOTDONE)
4484 goto theend;
4485 if (res == FAIL)
4486 goto on_error;
4487 }
4488 }
4489 break;
4490
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02004491 case ISN_UNLET:
4492 if (do_unlet(iptr->isn_arg.unlet.ul_name,
4493 iptr->isn_arg.unlet.ul_forceit) == FAIL)
Bram Moolenaare8593122020-07-18 15:17:02 +02004494 goto on_error;
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02004495 break;
Bram Moolenaar7bdaea62020-04-19 18:27:26 +02004496 case ISN_UNLETENV:
LemonBoy77142312022-04-15 20:50:46 +01004497 vim_unsetenv_ext(iptr->isn_arg.unlet.ul_name);
Bram Moolenaar7bdaea62020-04-19 18:27:26 +02004498 break;
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02004499
Bram Moolenaaraacc9662021-08-13 19:40:51 +02004500 case ISN_LOCKUNLOCK:
4501 {
Ernie Raelee865f32023-09-29 19:53:55 +02004502#ifdef LOG_LOCKVAR
4503 ch_log(NULL, "LKVAR: execute INS_LOCKUNLOCK isn_arg %s",
4504 iptr->isn_arg.string);
4505#endif
Ernie Rael4c8da022023-10-11 21:35:11 +02004506 lval_root_T *lval_root_save = lval_root;
Bram Moolenaaraacc9662021-08-13 19:40:51 +02004507
4508 // Stack has the local variable, argument the whole :lock
4509 // or :unlock command, like ISN_EXEC.
4510 --ectx->ec_stack.ga_len;
Zoltan Arpadffy7b12ac32024-12-29 09:50:20 +01004511 lval_root_T root;
4512 root.lr_tv = STACK_TV_BOT(0);
4513 root.lr_cl_exec = iptr->isn_arg.lockunlock.lu_cl_exec;
4514 root.lr_is_arg = iptr->isn_arg.lockunlock.lu_is_arg;
Ernie Rael64885642023-10-04 20:16:22 +02004515 lval_root = &root;
Ernie Rael4c8da022023-10-11 21:35:11 +02004516 int res = exec_command(iptr,
Ernie Rael64885642023-10-04 20:16:22 +02004517 iptr->isn_arg.lockunlock.lu_string);
4518 clear_tv(root.lr_tv);
Bram Moolenaaraacc9662021-08-13 19:40:51 +02004519 lval_root = lval_root_save;
4520 if (res == FAIL)
4521 goto on_error;
4522 }
4523 break;
4524
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +02004525 case ISN_LOCKCONST:
4526 item_lock(STACK_TV_BOT(-1), 100, TRUE, TRUE);
4527 break;
4528
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004529 // create a list from items on the stack; uses a single allocation
4530 // for the list header and the items
4531 case ISN_NEWLIST:
Bram Moolenaar4c137212021-04-19 16:48:48 +02004532 if (exe_newlist(iptr->isn_arg.number, ectx) == FAIL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004533 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004534 break;
4535
4536 // create a dict from items on the stack
4537 case ISN_NEWDICT:
4538 {
Bram Moolenaarec15b1c2022-03-27 16:29:53 +01004539 int res;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004540
Bram Moolenaarec15b1c2022-03-27 16:29:53 +01004541 SOURCING_LNUM = iptr->isn_lnum;
4542 res = exe_newdict(iptr->isn_arg.number, ectx);
4543 if (res == FAIL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004544 goto theend;
Bram Moolenaarec15b1c2022-03-27 16:29:53 +01004545 if (res == MAYBE)
4546 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004547 }
4548 break;
4549
LemonBoy372bcce2022-04-25 12:43:20 +01004550 case ISN_CONCAT:
4551 if (exe_concat(iptr->isn_arg.number, ectx) == FAIL)
4552 goto theend;
4553 break;
4554
Bram Moolenaar8acb9cc2022-03-08 13:18:55 +00004555 // create a partial with NULL value
4556 case ISN_NEWPARTIAL:
4557 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
4558 goto theend;
4559 ++ectx->ec_stack.ga_len;
4560 tv = STACK_TV_BOT(-1);
4561 tv->v_type = VAR_PARTIAL;
4562 tv->v_lock = 0;
4563 tv->vval.v_partial = NULL;
4564 break;
4565
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004566 // call a :def function
4567 case ISN_DCALL:
Bram Moolenaardfa3d552020-09-10 22:05:08 +02004568 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar2fecb532021-03-24 22:00:56 +01004569 if (call_dfunc(iptr->isn_arg.dfunc.cdf_idx,
4570 NULL,
4571 iptr->isn_arg.dfunc.cdf_argcount,
Bram Moolenaar4c137212021-04-19 16:48:48 +02004572 ectx) == FAIL)
Bram Moolenaare8593122020-07-18 15:17:02 +02004573 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004574 break;
4575
Bram Moolenaard0200c82023-01-28 15:19:40 +00004576 // call a method on an interface
4577 case ISN_METHODCALL:
4578 {
Bram Moolenaar094cf9f2023-02-10 15:52:25 +00004579 cmfunc_T *mfunc = iptr->isn_arg.mfunc;
4580
Bram Moolenaard0200c82023-01-28 15:19:40 +00004581 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar094cf9f2023-02-10 15:52:25 +00004582 tv = STACK_TV_BOT(-1 - mfunc->cmf_argcount);
Bram Moolenaard0200c82023-01-28 15:19:40 +00004583 if (tv->v_type != VAR_OBJECT)
4584 {
4585 object_required_error(tv);
4586 goto on_error;
4587 }
Ernie Raelbe828252024-07-26 18:37:02 +02004588
Bram Moolenaard0200c82023-01-28 15:19:40 +00004589 object_T *obj = tv->vval.v_object;
Ernie Raelbe828252024-07-26 18:37:02 +02004590 if (obj == NULL)
4591 {
4592 emsg(_(e_using_null_object));
4593 goto on_error;
4594 }
4595
Ernie Rael58c95792024-08-13 23:27:22 +02004596 ufunc_T *ufunc;
4597 if (mfunc->cmf_is_super)
4598 // Doing "super.Func", use the specific ufunc.
4599 ufunc = mfunc->cmf_itf->class_obj_methods[
4600 mfunc->cmf_idx];
4601 else
4602 {
4603 class_T *cl = obj->obj_class;
Bram Moolenaard0200c82023-01-28 15:19:40 +00004604
Ernie Rael58c95792024-08-13 23:27:22 +02004605 // convert the interface index to the object index
4606 int idx = object_index_from_itf_index(mfunc->cmf_itf,
4607 TRUE, mfunc->cmf_idx, cl);
4608 ufunc = cl->class_obj_methods[idx];
4609 }
Bram Moolenaard0200c82023-01-28 15:19:40 +00004610
Ernie Rael58c95792024-08-13 23:27:22 +02004611 if (call_ufunc(ufunc, NULL, mfunc->cmf_argcount, ectx,
4612 NULL, NULL) == FAIL)
Bram Moolenaard0200c82023-01-28 15:19:40 +00004613 goto on_error;
4614 }
4615 break;
4616
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004617 // call a builtin function
4618 case ISN_BCALL:
4619 SOURCING_LNUM = iptr->isn_lnum;
4620 if (call_bfunc(iptr->isn_arg.bfunc.cbf_idx,
4621 iptr->isn_arg.bfunc.cbf_argcount,
Bram Moolenaar4c137212021-04-19 16:48:48 +02004622 ectx) == FAIL)
Bram Moolenaard032f342020-07-18 18:13:02 +02004623 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004624 break;
4625
4626 // call a funcref or partial
4627 case ISN_PCALL:
4628 {
4629 cpfunc_T *pfunc = &iptr->isn_arg.pfunc;
4630 int r;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02004631 typval_T partial_tv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004632
4633 SOURCING_LNUM = iptr->isn_lnum;
4634 if (pfunc->cpf_top)
4635 {
4636 // funcref is above the arguments
4637 tv = STACK_TV_BOT(-pfunc->cpf_argcount - 1);
4638 }
4639 else
4640 {
4641 // Get the funcref from the stack.
Bram Moolenaar4c137212021-04-19 16:48:48 +02004642 --ectx->ec_stack.ga_len;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02004643 partial_tv = *STACK_TV_BOT(0);
4644 tv = &partial_tv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004645 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02004646 r = call_partial(tv, pfunc->cpf_argcount, ectx);
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02004647 if (tv == &partial_tv)
4648 clear_tv(&partial_tv);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004649 if (r == FAIL)
Bram Moolenaard032f342020-07-18 18:13:02 +02004650 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004651 }
4652 break;
4653
Bram Moolenaarbd5da372020-03-31 23:13:10 +02004654 case ISN_PCALL_END:
4655 // PCALL finished, arguments have been consumed and replaced by
4656 // the return value. Now clear the funcref from the stack,
4657 // and move the return value in its place.
Bram Moolenaar4c137212021-04-19 16:48:48 +02004658 --ectx->ec_stack.ga_len;
Bram Moolenaarbd5da372020-03-31 23:13:10 +02004659 clear_tv(STACK_TV_BOT(-1));
4660 *STACK_TV_BOT(-1) = *STACK_TV_BOT(0);
4661 break;
4662
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004663 // call a user defined function or funcref/partial
4664 case ISN_UCALL:
4665 {
4666 cufunc_T *cufunc = &iptr->isn_arg.ufunc;
4667
4668 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar2fecb532021-03-24 22:00:56 +01004669 if (call_eval_func(cufunc->cuf_name, cufunc->cuf_argcount,
Bram Moolenaar4c137212021-04-19 16:48:48 +02004670 ectx, iptr) == FAIL)
Bram Moolenaard032f342020-07-18 18:13:02 +02004671 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004672 }
4673 break;
4674
Bram Moolenaar1d84f762022-09-03 21:35:53 +01004675 // :defer func(arg)
4676 case ISN_DEFER:
Bram Moolenaar806a2732022-09-04 15:40:36 +01004677 if (defer_command(iptr->isn_arg.defer.defer_var_idx,
Bram Moolenaar1d84f762022-09-03 21:35:53 +01004678 iptr->isn_arg.defer.defer_argcount, ectx) == FAIL)
4679 goto on_error;
4680 break;
4681
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004682 // Return from a :def function call without a value.
4683 // Return from a constructor.
Bram Moolenaarf57b43c2021-06-15 22:13:27 +02004684 case ISN_RETURN_VOID:
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004685 case ISN_RETURN_OBJECT:
Bram Moolenaar35578162021-08-02 19:10:38 +02004686 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004687 goto theend;
Bram Moolenaar299f3032021-01-08 20:53:09 +01004688 tv = STACK_TV_BOT(0);
Bram Moolenaar4c137212021-04-19 16:48:48 +02004689 ++ectx->ec_stack.ga_len;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004690 if (iptr->isn_type == ISN_RETURN_VOID)
4691 {
4692 tv->v_type = VAR_VOID;
4693 tv->vval.v_number = 0;
4694 tv->v_lock = 0;
4695 }
4696 else
4697 {
4698 *tv = *STACK_TV_VAR(0);
Yegappan Lakshmanane5437c52023-12-16 14:11:19 +01004699 object_T *obj = tv->vval.v_object;
4700 ++obj->obj_refcount;
4701
4702 // Lock all the constant object variables
4703 obj_lock_const_vars(obj);
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004704 }
Bram Moolenaar299f3032021-01-08 20:53:09 +01004705 // FALLTHROUGH
4706
Bram Moolenaarf57b43c2021-06-15 22:13:27 +02004707 // return from a :def function call with what is on the stack
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004708 case ISN_RETURN:
4709 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02004710 garray_T *trystack = &ectx->ec_trystack;
Bram Moolenaar20431c92020-03-20 18:39:46 +01004711 trycmd_T *trycmd = NULL;
Bram Moolenaar8cbd6df2020-01-28 22:59:45 +01004712
Ernie Raelb077b582023-12-14 20:11:44 +01004713 ///////////////////////////////////////////////////
4714 // TODO: If FAIL, line number in output not correct
4715 ///////////////////////////////////////////////////
4716 if (check_typval_is_value(STACK_TV_BOT(-1)) == FAIL)
4717 goto theend;
4718
Bram Moolenaar8cbd6df2020-01-28 22:59:45 +01004719 if (trystack->ga_len > 0)
4720 trycmd = ((trycmd_T *)trystack->ga_data)
4721 + trystack->ga_len - 1;
Bram Moolenaarbf67ea12020-05-02 17:52:42 +02004722 if (trycmd != NULL
Bram Moolenaar4c137212021-04-19 16:48:48 +02004723 && trycmd->tcd_frame_idx == ectx->ec_frame_idx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004724 {
Bram Moolenaar9cb577a2021-02-22 22:45:10 +01004725 // jump to ":finally" or ":endtry"
4726 if (trycmd->tcd_finally_idx != 0)
Bram Moolenaar4c137212021-04-19 16:48:48 +02004727 ectx->ec_iidx = trycmd->tcd_finally_idx;
Bram Moolenaar9cb577a2021-02-22 22:45:10 +01004728 else
Bram Moolenaar4c137212021-04-19 16:48:48 +02004729 ectx->ec_iidx = trycmd->tcd_endtry_idx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004730 trycmd->tcd_return = TRUE;
4731 }
4732 else
Bram Moolenaard032f342020-07-18 18:13:02 +02004733 goto func_return;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004734 }
4735 break;
4736
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02004737 // push a partial, a reference to a compiled function
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004738 case ISN_FUNCREF:
4739 {
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01004740 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
4741 ufunc_T *ufunc;
4742 funcref_T *funcref = &iptr->isn_arg.funcref;
4743 funcref_extra_T *extra = funcref->fr_extra;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004744
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004745 if (pt == NULL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004746 goto theend;
Bram Moolenaar35578162021-08-02 19:10:38 +02004747 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +02004748 {
Bram Moolenaarbf67ea12020-05-02 17:52:42 +02004749 vim_free(pt);
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004750 goto theend;
Bram Moolenaarbf67ea12020-05-02 17:52:42 +02004751 }
Bram Moolenaar313e4722023-02-08 20:55:27 +00004752 if (extra != NULL && extra->fre_class != NULL)
4753 {
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02004754 class_T *cl;
4755 if (extra->fre_object_method)
Bram Moolenaar313e4722023-02-08 20:55:27 +00004756 {
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02004757 tv = STACK_TV_BOT(-1);
4758 if (tv->v_type != VAR_OBJECT)
4759 {
Ernie Raelbe828252024-07-26 18:37:02 +02004760 SOURCING_LNUM = iptr->isn_lnum;
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02004761 object_required_error(tv);
4762 vim_free(pt);
4763 goto on_error;
4764 }
Bram Moolenaar313e4722023-02-08 20:55:27 +00004765
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02004766 object_T *obj = tv->vval.v_object;
Ernie Raelbe828252024-07-26 18:37:02 +02004767 if (obj == NULL)
4768 {
4769 SOURCING_LNUM = iptr->isn_lnum;
4770 emsg(_(e_using_null_object));
4771 vim_free(pt);
4772 goto on_error;
4773 }
4774
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02004775 cl = obj->obj_class;
4776 // drop the value from the stack
4777 clear_tv(tv);
4778 --ectx->ec_stack.ga_len;
4779
4780 pt->pt_obj = obj;
4781 ++obj->obj_refcount;
4782 }
4783 else
4784 cl = extra->fre_class;
4785
4786 if (extra->fre_object_method)
4787 {
4788 // object method
4789 // convert the interface index to the object index
4790 int idx =
4791 object_index_from_itf_index(extra->fre_class,
4792 TRUE, extra->fre_method_idx, cl);
4793 ufunc = cl->class_obj_methods[idx];
4794 }
4795 else
4796 {
4797 // class method
4798 ufunc =
4799 cl->class_class_functions[extra->fre_method_idx];
4800 }
Bram Moolenaar313e4722023-02-08 20:55:27 +00004801 }
4802 else if (extra == NULL || extra->fre_func_name == NULL)
Bram Moolenaar38453522021-11-28 22:00:12 +00004803 {
4804 dfunc_T *pt_dfunc = ((dfunc_T *)def_functions.ga_data)
4805 + funcref->fr_dfunc_idx;
4806
4807 ufunc = pt_dfunc->df_ufunc;
4808 }
4809 else
Bram Moolenaar313e4722023-02-08 20:55:27 +00004810 {
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01004811 ufunc = find_func(extra->fre_func_name, FALSE);
Bram Moolenaar313e4722023-02-08 20:55:27 +00004812 }
Bram Moolenaar56acd1f2022-02-18 13:24:52 +00004813 if (ufunc == NULL)
4814 {
4815 SOURCING_LNUM = iptr->isn_lnum;
4816 iemsg("ufunc unexpectedly NULL for FUNCREF");
Christian Brabandt915f3bf2024-04-05 20:12:19 +02004817 vim_free(pt);
Bram Moolenaar56acd1f2022-02-18 13:24:52 +00004818 goto theend;
4819 }
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01004820 if (fill_partial_and_closure(pt, ufunc,
Bram Moolenaarcc341812022-09-19 15:54:34 +01004821 extra == NULL ? NULL : &extra->fre_loopvar_info,
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01004822 ectx) == FAIL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004823 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004824 tv = STACK_TV_BOT(0);
Bram Moolenaar4c137212021-04-19 16:48:48 +02004825 ++ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004826 tv->vval.v_partial = pt;
4827 tv->v_type = VAR_PARTIAL;
Bram Moolenaar2f8ce0a2020-07-19 19:47:35 +02004828 tv->v_lock = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004829 }
4830 break;
4831
Bram Moolenaar38ddf332020-07-31 22:05:04 +02004832 // Create a global function from a lambda.
4833 case ISN_NEWFUNC:
4834 {
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01004835 newfuncarg_T *arg = iptr->isn_arg.newfunc.nf_arg;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02004836
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01004837 if (copy_lambda_to_global_func(arg->nfa_lambda,
Bram Moolenaarcc341812022-09-19 15:54:34 +01004838 arg->nfa_global, &arg->nfa_loopvar_info,
4839 ectx) == FAIL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004840 goto theend;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02004841 }
4842 break;
4843
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01004844 // List functions
4845 case ISN_DEF:
4846 if (iptr->isn_arg.string == NULL)
4847 list_functions(NULL);
4848 else
4849 {
Bram Moolenaar14336722022-01-08 16:02:59 +00004850 exarg_T ea;
4851 garray_T lines_to_free;
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01004852
4853 CLEAR_FIELD(ea);
4854 ea.cmd = ea.arg = iptr->isn_arg.string;
Bram Moolenaar14336722022-01-08 16:02:59 +00004855 ga_init2(&lines_to_free, sizeof(char_u *), 50);
Bram Moolenaard4a9b7f2023-05-23 14:48:42 +01004856 SOURCING_LNUM = iptr->isn_lnum;
h-eastb895b0f2023-09-24 15:46:31 +02004857 define_function(&ea, NULL, &lines_to_free, 0, NULL, 0);
Bram Moolenaar14336722022-01-08 16:02:59 +00004858 ga_clear_strings(&lines_to_free);
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01004859 }
4860 break;
4861
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004862 // jump if a condition is met
4863 case ISN_JUMP:
4864 {
4865 jumpwhen_T when = iptr->isn_arg.jump.jump_when;
Bram Moolenaar2bb26582020-10-03 22:52:39 +02004866 int error = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004867 int jump = TRUE;
4868
4869 if (when != JUMP_ALWAYS)
4870 {
4871 tv = STACK_TV_BOT(-1);
Bram Moolenaar2bb26582020-10-03 22:52:39 +02004872 if (when == JUMP_IF_COND_FALSE
Bram Moolenaar13106602020-10-04 16:06:05 +02004873 || when == JUMP_IF_FALSE
Bram Moolenaar2bb26582020-10-03 22:52:39 +02004874 || when == JUMP_IF_COND_TRUE)
4875 {
4876 SOURCING_LNUM = iptr->isn_lnum;
4877 jump = tv_get_bool_chk(tv, &error);
4878 if (error)
4879 goto on_error;
4880 }
4881 else
4882 jump = tv2bool(tv);
Bram Moolenaarf6ced982022-04-28 12:00:49 +01004883 if (when == JUMP_IF_FALSE || when == JUMP_IF_COND_FALSE)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004884 jump = !jump;
Bram Moolenaar777770f2020-02-06 21:27:08 +01004885 if (when == JUMP_IF_FALSE || !jump)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004886 {
4887 // drop the value from the stack
4888 clear_tv(tv);
Bram Moolenaar4c137212021-04-19 16:48:48 +02004889 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004890 }
4891 }
4892 if (jump)
Bram Moolenaar4c137212021-04-19 16:48:48 +02004893 ectx->ec_iidx = iptr->isn_arg.jump.jump_where;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004894 }
4895 break;
4896
Bram Moolenaarb46c0832022-09-15 17:19:37 +01004897 // "while": jump to end if a condition is false
4898 case ISN_WHILE:
4899 {
4900 int error = FALSE;
4901 int jump = TRUE;
4902
4903 tv = STACK_TV_BOT(-1);
4904 SOURCING_LNUM = iptr->isn_lnum;
4905 jump = !tv_get_bool_chk(tv, &error);
4906 if (error)
4907 goto on_error;
4908 // drop the value from the stack
4909 clear_tv(tv);
4910 --ectx->ec_stack.ga_len;
4911 if (jump)
4912 ectx->ec_iidx = iptr->isn_arg.whileloop.while_end;
4913
Bram Moolenaar87b4e5c2022-10-01 15:32:46 +01004914 // Store the current funcref count, may be used by
Bram Moolenaarcc341812022-09-19 15:54:34 +01004915 // ISN_ENDLOOP later
Bram Moolenaarb46c0832022-09-15 17:19:37 +01004916 tv = STACK_TV_VAR(
4917 iptr->isn_arg.whileloop.while_funcref_idx);
4918 tv->vval.v_number = ectx->ec_funcrefs.ga_len;
4919 }
4920 break;
4921
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +02004922 // Jump if an argument with a default value was already set and not
4923 // v:none.
4924 case ISN_JUMP_IF_ARG_SET:
Bram Moolenaar65b0d162022-12-13 18:43:22 +00004925 case ISN_JUMP_IF_ARG_NOT_SET:
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +02004926 tv = STACK_TV_VAR(iptr->isn_arg.jumparg.jump_arg_off);
Bram Moolenaar65b0d162022-12-13 18:43:22 +00004927 int arg_set = tv->v_type != VAR_UNKNOWN
4928 && !(tv->v_type == VAR_SPECIAL
4929 && tv->vval.v_number == VVAL_NONE);
Yegappan Lakshmananb04af4c2025-01-03 10:50:08 +01004930
4931 if (iptr->isn_type == ISN_JUMP_IF_ARG_NOT_SET && !arg_set)
4932 {
4933 dfunc_T *df = ((dfunc_T *)def_functions.ga_data)
4934 + ectx->ec_dfunc_idx;
4935 ufunc_T *ufunc = df->df_ufunc;
4936 // jump_arg_off is negative for arguments
4937 size_t argidx = ufunc->uf_def_args.ga_len
4938 + iptr->isn_arg.jumparg.jump_arg_off
4939 + STACK_FRAME_SIZE;
4940 type_T *t = ufunc->uf_arg_types[argidx];
Yegappan Lakshmanan2050dcc2025-01-06 18:34:49 +01004941 CLEAR_POINTER(tv);
Yegappan Lakshmananb04af4c2025-01-03 10:50:08 +01004942 tv->v_type = t->tt_type;
4943 }
4944
Bram Moolenaar65b0d162022-12-13 18:43:22 +00004945 if (iptr->isn_type == ISN_JUMP_IF_ARG_SET ? arg_set : !arg_set)
Bram Moolenaar4c137212021-04-19 16:48:48 +02004946 ectx->ec_iidx = iptr->isn_arg.jumparg.jump_where;
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +02004947 break;
4948
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004949 // top of a for loop
4950 case ISN_FOR:
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00004951 if (execute_for(iptr, ectx) == FAIL)
4952 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004953 break;
4954
Bram Moolenaarb46c0832022-09-15 17:19:37 +01004955 // end of a for or while loop
4956 case ISN_ENDLOOP:
4957 if (execute_endloop(iptr, ectx) == FAIL)
4958 goto theend;
4959 break;
4960
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004961 // start of ":try" block
4962 case ISN_TRY:
4963 {
Bram Moolenaar20431c92020-03-20 18:39:46 +01004964 trycmd_T *trycmd = NULL;
4965
Bram Moolenaar35578162021-08-02 19:10:38 +02004966 if (GA_GROW_FAILS(&ectx->ec_trystack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004967 goto theend;
Bram Moolenaar4c137212021-04-19 16:48:48 +02004968 trycmd = ((trycmd_T *)ectx->ec_trystack.ga_data)
4969 + ectx->ec_trystack.ga_len;
4970 ++ectx->ec_trystack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004971 ++trylevel;
Bram Moolenaar8d4be892021-02-13 18:33:02 +01004972 CLEAR_POINTER(trycmd);
Bram Moolenaar4c137212021-04-19 16:48:48 +02004973 trycmd->tcd_frame_idx = ectx->ec_frame_idx;
4974 trycmd->tcd_stack_len = ectx->ec_stack.ga_len;
Bram Moolenaara91a7132021-03-25 21:12:15 +01004975 trycmd->tcd_catch_idx =
Bram Moolenaar0d807102021-12-21 09:42:09 +00004976 iptr->isn_arg.tryref.try_ref->try_catch;
Bram Moolenaara91a7132021-03-25 21:12:15 +01004977 trycmd->tcd_finally_idx =
Bram Moolenaar0d807102021-12-21 09:42:09 +00004978 iptr->isn_arg.tryref.try_ref->try_finally;
Bram Moolenaara91a7132021-03-25 21:12:15 +01004979 trycmd->tcd_endtry_idx =
Bram Moolenaar0d807102021-12-21 09:42:09 +00004980 iptr->isn_arg.tryref.try_ref->try_endtry;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004981 }
4982 break;
4983
4984 case ISN_PUSHEXC:
4985 if (current_exception == NULL)
4986 {
Bram Moolenaar7517ffd2020-08-14 18:35:07 +02004987 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004988 iemsg("Evaluating catch while current_exception is NULL");
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004989 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004990 }
Bram Moolenaar35578162021-08-02 19:10:38 +02004991 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004992 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004993 tv = STACK_TV_BOT(0);
Bram Moolenaar4c137212021-04-19 16:48:48 +02004994 ++ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004995 tv->v_type = VAR_STRING;
Bram Moolenaar2f8ce0a2020-07-19 19:47:35 +02004996 tv->v_lock = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004997 tv->vval.v_string = vim_strsave(
4998 (char_u *)current_exception->value);
4999 break;
5000
5001 case ISN_CATCH:
5002 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02005003 garray_T *trystack = &ectx->ec_trystack;
Bram Moolenaar06651632022-04-27 17:54:25 +01005004 trycmd_T *trycmd;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005005
Bram Moolenaar4c137212021-04-19 16:48:48 +02005006 may_restore_cmdmod(&ectx->ec_funclocal);
Bram Moolenaar06651632022-04-27 17:54:25 +01005007 trycmd = ((trycmd_T *)trystack->ga_data)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005008 + trystack->ga_len - 1;
Bram Moolenaar06651632022-04-27 17:54:25 +01005009 trycmd->tcd_caught = TRUE;
5010 trycmd->tcd_did_throw = FALSE;
5011
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005012 did_emsg = got_int = did_throw = FALSE;
Bram Moolenaar1430cee2021-01-17 19:20:32 +01005013 force_abort = need_rethrow = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005014 catch_exception(current_exception);
5015 }
5016 break;
5017
Bram Moolenaarc150c092021-02-13 15:02:46 +01005018 case ISN_TRYCONT:
5019 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02005020 garray_T *trystack = &ectx->ec_trystack;
Bram Moolenaarc150c092021-02-13 15:02:46 +01005021 trycont_T *trycont = &iptr->isn_arg.trycont;
5022 int i;
5023 trycmd_T *trycmd;
5024 int iidx = trycont->tct_where;
5025
5026 if (trystack->ga_len < trycont->tct_levels)
5027 {
5028 siemsg("TRYCONT: expected %d levels, found %d",
5029 trycont->tct_levels, trystack->ga_len);
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02005030 goto theend;
Bram Moolenaarc150c092021-02-13 15:02:46 +01005031 }
5032 // Make :endtry jump to any outer try block and the last
5033 // :endtry inside the loop to the loop start.
5034 for (i = trycont->tct_levels; i > 0; --i)
5035 {
5036 trycmd = ((trycmd_T *)trystack->ga_data)
5037 + trystack->ga_len - i;
Bram Moolenaar2e34c342021-03-14 12:13:33 +01005038 // Add one to tcd_cont to be able to jump to
5039 // instruction with index zero.
5040 trycmd->tcd_cont = iidx + 1;
Bram Moolenaar7e82c5f2021-02-21 21:32:45 +01005041 iidx = trycmd->tcd_finally_idx == 0
5042 ? trycmd->tcd_endtry_idx : trycmd->tcd_finally_idx;
Bram Moolenaarc150c092021-02-13 15:02:46 +01005043 }
5044 // jump to :finally or :endtry of current try statement
Bram Moolenaar4c137212021-04-19 16:48:48 +02005045 ectx->ec_iidx = iidx;
Bram Moolenaarc150c092021-02-13 15:02:46 +01005046 }
5047 break;
5048
Bram Moolenaar7e82c5f2021-02-21 21:32:45 +01005049 case ISN_FINALLY:
5050 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02005051 garray_T *trystack = &ectx->ec_trystack;
Bram Moolenaar7e82c5f2021-02-21 21:32:45 +01005052 trycmd_T *trycmd = ((trycmd_T *)trystack->ga_data)
5053 + trystack->ga_len - 1;
5054
5055 // Reset the index to avoid a return statement jumps here
5056 // again.
5057 trycmd->tcd_finally_idx = 0;
Yee Cheng Chin2051af12025-01-09 22:14:34 +01005058 if (trycmd->tcd_caught)
5059 {
5060 // discard the exception
5061 finish_exception(caught_stack);
5062 trycmd->tcd_caught = FALSE;
5063 }
Bram Moolenaar7e82c5f2021-02-21 21:32:45 +01005064 break;
5065 }
5066
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005067 // end of ":try" block
5068 case ISN_ENDTRY:
5069 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02005070 garray_T *trystack = &ectx->ec_trystack;
Bram Moolenaar06651632022-04-27 17:54:25 +01005071 trycmd_T *trycmd;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005072
Bram Moolenaar06651632022-04-27 17:54:25 +01005073 --trystack->ga_len;
5074 --trylevel;
5075 trycmd = ((trycmd_T *)trystack->ga_data) + trystack->ga_len;
5076 if (trycmd->tcd_did_throw)
5077 did_throw = TRUE;
Yee Cheng Chin2051af12025-01-09 22:14:34 +01005078 if (trycmd->tcd_caught)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005079 {
Bram Moolenaar06651632022-04-27 17:54:25 +01005080 // discard the exception
Yee Cheng Chin2051af12025-01-09 22:14:34 +01005081 finish_exception(caught_stack);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005082 }
Bram Moolenaar06651632022-04-27 17:54:25 +01005083
5084 if (trycmd->tcd_return)
5085 goto func_return;
5086
5087 while (ectx->ec_stack.ga_len > trycmd->tcd_stack_len)
5088 {
5089 --ectx->ec_stack.ga_len;
5090 clear_tv(STACK_TV_BOT(0));
5091 }
5092 if (trycmd->tcd_cont != 0)
5093 // handling :continue: jump to outer try block or
5094 // start of the loop
5095 ectx->ec_iidx = trycmd->tcd_cont - 1;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005096 }
5097 break;
5098
5099 case ISN_THROW:
Bram Moolenaar8f81b222021-01-14 21:47:06 +01005100 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02005101 garray_T *trystack = &ectx->ec_trystack;
Bram Moolenaar1e021e62020-10-16 20:25:23 +02005102
Bram Moolenaar107e9ce2021-01-24 20:52:00 +01005103 if (trystack->ga_len == 0 && trylevel == 0 && emsg_silent)
5104 {
Bram Moolenaar3ef2e412023-04-30 18:50:48 +01005105 // Throwing an exception while using "silent!" causes
Bram Moolenaar107e9ce2021-01-24 20:52:00 +01005106 // the function to abort but not display an error.
5107 tv = STACK_TV_BOT(-1);
5108 clear_tv(tv);
5109 tv->v_type = VAR_NUMBER;
5110 tv->vval.v_number = 0;
5111 goto done;
5112 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02005113 --ectx->ec_stack.ga_len;
Bram Moolenaar107e9ce2021-01-24 20:52:00 +01005114 tv = STACK_TV_BOT(0);
5115 if (tv->vval.v_string == NULL
5116 || *skipwhite(tv->vval.v_string) == NUL)
5117 {
5118 vim_free(tv->vval.v_string);
5119 SOURCING_LNUM = iptr->isn_lnum;
5120 emsg(_(e_throw_with_empty_string));
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02005121 goto theend;
Bram Moolenaar107e9ce2021-01-24 20:52:00 +01005122 }
5123
5124 // Inside a "catch" we need to first discard the caught
5125 // exception.
5126 if (trystack->ga_len > 0)
5127 {
5128 trycmd_T *trycmd = ((trycmd_T *)trystack->ga_data)
5129 + trystack->ga_len - 1;
Yee Cheng Chin2051af12025-01-09 22:14:34 +01005130 if (trycmd->tcd_caught)
Bram Moolenaar107e9ce2021-01-24 20:52:00 +01005131 {
5132 // discard the exception
Yee Cheng Chin2051af12025-01-09 22:14:34 +01005133 finish_exception(caught_stack);
Bram Moolenaar107e9ce2021-01-24 20:52:00 +01005134 trycmd->tcd_caught = FALSE;
5135 }
5136 }
5137
Bram Moolenaar90a57162022-02-12 14:23:17 +00005138 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar107e9ce2021-01-24 20:52:00 +01005139 if (throw_exception(tv->vval.v_string, ET_USER, NULL)
5140 == FAIL)
5141 {
5142 vim_free(tv->vval.v_string);
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02005143 goto theend;
Bram Moolenaar107e9ce2021-01-24 20:52:00 +01005144 }
5145 did_throw = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005146 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005147 break;
5148
5149 // compare with special values
5150 case ISN_COMPAREBOOL:
5151 case ISN_COMPARESPECIAL:
5152 {
5153 typval_T *tv1 = STACK_TV_BOT(-2);
5154 typval_T *tv2 = STACK_TV_BOT(-1);
5155 varnumber_T arg1 = tv1->vval.v_number;
5156 varnumber_T arg2 = tv2->vval.v_number;
5157 int res;
5158
Bram Moolenaar06651632022-04-27 17:54:25 +01005159 if (iptr->isn_arg.op.op_type == EXPR_EQUAL)
5160 res = arg1 == arg2;
5161 else
5162 res = arg1 != arg2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005163
Bram Moolenaar4c137212021-04-19 16:48:48 +02005164 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005165 tv1->v_type = VAR_BOOL;
5166 tv1->vval.v_number = res ? VVAL_TRUE : VVAL_FALSE;
5167 }
5168 break;
5169
Bram Moolenaar7a222242022-03-01 19:23:24 +00005170 case ISN_COMPARENULL:
5171 {
5172 typval_T *tv1 = STACK_TV_BOT(-2);
5173 typval_T *tv2 = STACK_TV_BOT(-1);
5174 int res;
5175
5176 res = typval_compare_null(tv1, tv2);
5177 if (res == MAYBE)
5178 goto on_error;
5179 if (iptr->isn_arg.op.op_type == EXPR_NEQUAL)
5180 res = !res;
5181 clear_tv(tv1);
5182 clear_tv(tv2);
5183 --ectx->ec_stack.ga_len;
5184 tv1->v_type = VAR_BOOL;
5185 tv1->vval.v_number = res ? VVAL_TRUE : VVAL_FALSE;
5186 }
5187 break;
5188
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005189 // Operation with two number arguments
5190 case ISN_OPNR:
5191 case ISN_COMPARENR:
5192 {
5193 typval_T *tv1 = STACK_TV_BOT(-2);
5194 typval_T *tv2 = STACK_TV_BOT(-1);
5195 varnumber_T arg1 = tv1->vval.v_number;
5196 varnumber_T arg2 = tv2->vval.v_number;
Bram Moolenaarfbeefb12021-08-07 15:50:23 +02005197 varnumber_T res = 0;
5198 int div_zero = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005199
Yegappan Lakshmanana061f342022-05-22 19:13:49 +01005200 if (iptr->isn_arg.op.op_type == EXPR_LSHIFT
5201 || iptr->isn_arg.op.op_type == EXPR_RSHIFT)
5202 {
5203 if (arg2 < 0)
5204 {
5205 SOURCING_LNUM = iptr->isn_lnum;
dundargocc57b5bc2022-11-02 13:30:51 +00005206 emsg(_(e_bitshift_ops_must_be_positive));
Yegappan Lakshmanana061f342022-05-22 19:13:49 +01005207 goto on_error;
5208 }
5209 }
5210
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005211 switch (iptr->isn_arg.op.op_type)
5212 {
5213 case EXPR_MULT: res = arg1 * arg2; break;
Bram Moolenaarfbeefb12021-08-07 15:50:23 +02005214 case EXPR_DIV: if (arg2 == 0)
5215 div_zero = TRUE;
5216 else
5217 res = arg1 / arg2;
5218 break;
5219 case EXPR_REM: if (arg2 == 0)
5220 div_zero = TRUE;
5221 else
5222 res = arg1 % arg2;
5223 break;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005224 case EXPR_SUB: res = arg1 - arg2; break;
5225 case EXPR_ADD: res = arg1 + arg2; break;
5226
5227 case EXPR_EQUAL: res = arg1 == arg2; break;
5228 case EXPR_NEQUAL: res = arg1 != arg2; break;
5229 case EXPR_GREATER: res = arg1 > arg2; break;
5230 case EXPR_GEQUAL: res = arg1 >= arg2; break;
5231 case EXPR_SMALLER: res = arg1 < arg2; break;
5232 case EXPR_SEQUAL: res = arg1 <= arg2; break;
Yegappan Lakshmanana061f342022-05-22 19:13:49 +01005233 case EXPR_LSHIFT: if (arg2 > MAX_LSHIFT_BITS)
5234 res = 0;
5235 else
Bram Moolenaar68e64d22022-05-22 22:07:52 +01005236 res = (uvarnumber_T)arg1 << arg2;
Yegappan Lakshmanana061f342022-05-22 19:13:49 +01005237 break;
5238 case EXPR_RSHIFT: if (arg2 > MAX_LSHIFT_BITS)
5239 res = 0;
5240 else
Bram Moolenaar338bf582022-05-22 20:16:32 +01005241 res = (uvarnumber_T)arg1 >> arg2;
Yegappan Lakshmanana061f342022-05-22 19:13:49 +01005242 break;
Bram Moolenaarfbeefb12021-08-07 15:50:23 +02005243 default: break;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005244 }
5245
Bram Moolenaar4c137212021-04-19 16:48:48 +02005246 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005247 if (iptr->isn_type == ISN_COMPARENR)
5248 {
5249 tv1->v_type = VAR_BOOL;
5250 tv1->vval.v_number = res ? VVAL_TRUE : VVAL_FALSE;
5251 }
5252 else
5253 tv1->vval.v_number = res;
Bram Moolenaarfbeefb12021-08-07 15:50:23 +02005254 if (div_zero)
5255 {
5256 SOURCING_LNUM = iptr->isn_lnum;
5257 emsg(_(e_divide_by_zero));
5258 goto on_error;
5259 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005260 }
5261 break;
5262
5263 // Computation with two float arguments
5264 case ISN_OPFLOAT:
5265 case ISN_COMPAREFLOAT:
5266 {
5267 typval_T *tv1 = STACK_TV_BOT(-2);
5268 typval_T *tv2 = STACK_TV_BOT(-1);
5269 float_T arg1 = tv1->vval.v_float;
5270 float_T arg2 = tv2->vval.v_float;
5271 float_T res = 0;
5272 int cmp = FALSE;
5273
5274 switch (iptr->isn_arg.op.op_type)
5275 {
5276 case EXPR_MULT: res = arg1 * arg2; break;
5277 case EXPR_DIV: res = arg1 / arg2; break;
5278 case EXPR_SUB: res = arg1 - arg2; break;
5279 case EXPR_ADD: res = arg1 + arg2; break;
5280
5281 case EXPR_EQUAL: cmp = arg1 == arg2; break;
5282 case EXPR_NEQUAL: cmp = arg1 != arg2; break;
5283 case EXPR_GREATER: cmp = arg1 > arg2; break;
5284 case EXPR_GEQUAL: cmp = arg1 >= arg2; break;
5285 case EXPR_SMALLER: cmp = arg1 < arg2; break;
5286 case EXPR_SEQUAL: cmp = arg1 <= arg2; break;
5287 default: cmp = 0; break;
5288 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02005289 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005290 if (iptr->isn_type == ISN_COMPAREFLOAT)
5291 {
5292 tv1->v_type = VAR_BOOL;
5293 tv1->vval.v_number = cmp ? VVAL_TRUE : VVAL_FALSE;
5294 }
5295 else
5296 tv1->vval.v_float = res;
5297 }
5298 break;
5299
5300 case ISN_COMPARELIST:
Bram Moolenaar265f8112021-12-19 12:33:05 +00005301 case ISN_COMPAREDICT:
5302 case ISN_COMPAREFUNC:
5303 case ISN_COMPARESTRING:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005304 case ISN_COMPAREBLOB:
Bram Moolenaarbcf31ec2023-01-02 20:32:24 +00005305 case ISN_COMPAREOBJECT:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005306 {
5307 typval_T *tv1 = STACK_TV_BOT(-2);
5308 typval_T *tv2 = STACK_TV_BOT(-1);
Bram Moolenaar265f8112021-12-19 12:33:05 +00005309 exprtype_T exprtype = iptr->isn_arg.op.op_type;
5310 int ic = iptr->isn_arg.op.op_ic;
5311 int res = FALSE;
5312 int status = OK;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005313
Bram Moolenaar265f8112021-12-19 12:33:05 +00005314 SOURCING_LNUM = iptr->isn_lnum;
5315 if (iptr->isn_type == ISN_COMPARELIST)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005316 {
Bram Moolenaar265f8112021-12-19 12:33:05 +00005317 status = typval_compare_list(tv1, tv2,
5318 exprtype, ic, &res);
5319 }
5320 else if (iptr->isn_type == ISN_COMPAREDICT)
5321 {
5322 status = typval_compare_dict(tv1, tv2,
5323 exprtype, ic, &res);
5324 }
5325 else if (iptr->isn_type == ISN_COMPAREFUNC)
5326 {
5327 status = typval_compare_func(tv1, tv2,
5328 exprtype, ic, &res);
5329 }
5330 else if (iptr->isn_type == ISN_COMPARESTRING)
5331 {
5332 status = typval_compare_string(tv1, tv2,
5333 exprtype, ic, &res);
5334 }
Bram Moolenaarbcf31ec2023-01-02 20:32:24 +00005335 else if (iptr->isn_type == ISN_COMPAREBLOB)
Bram Moolenaar265f8112021-12-19 12:33:05 +00005336 {
5337 status = typval_compare_blob(tv1, tv2, exprtype, &res);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005338 }
Bram Moolenaarbcf31ec2023-01-02 20:32:24 +00005339 else // ISN_COMPAREOBJECT
5340 {
5341 status = typval_compare_object(tv1, tv2,
Bram Moolenaar03ff0c62023-01-02 20:38:01 +00005342 exprtype, FALSE, &res);
Bram Moolenaarbcf31ec2023-01-02 20:32:24 +00005343 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02005344 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005345 clear_tv(tv1);
5346 clear_tv(tv2);
5347 tv1->v_type = VAR_BOOL;
Bram Moolenaar265f8112021-12-19 12:33:05 +00005348 tv1->vval.v_number = res ? VVAL_TRUE : VVAL_FALSE;
5349 if (status == FAIL)
5350 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005351 }
5352 break;
5353
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005354 case ISN_COMPAREANY:
5355 {
5356 typval_T *tv1 = STACK_TV_BOT(-2);
5357 typval_T *tv2 = STACK_TV_BOT(-1);
Bram Moolenaar657137c2021-01-09 15:45:23 +01005358 exprtype_T exprtype = iptr->isn_arg.op.op_type;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005359 int ic = iptr->isn_arg.op.op_ic;
Bram Moolenaar265f8112021-12-19 12:33:05 +00005360 int status;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005361
Bram Moolenaareb26f432020-09-14 16:50:05 +02005362 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar265f8112021-12-19 12:33:05 +00005363 status = typval_compare(tv1, tv2, exprtype, ic);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005364 clear_tv(tv2);
Bram Moolenaar4c137212021-04-19 16:48:48 +02005365 --ectx->ec_stack.ga_len;
Bram Moolenaar265f8112021-12-19 12:33:05 +00005366 if (status == FAIL)
5367 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005368 }
5369 break;
5370
5371 case ISN_ADDLIST:
5372 case ISN_ADDBLOB:
5373 {
5374 typval_T *tv1 = STACK_TV_BOT(-2);
5375 typval_T *tv2 = STACK_TV_BOT(-1);
5376
Bram Moolenaar1dcae592020-10-19 19:02:42 +02005377 // add two lists or blobs
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005378 if (iptr->isn_type == ISN_ADDLIST)
Bram Moolenaar07802042021-09-09 23:01:14 +02005379 {
5380 if (iptr->isn_arg.op.op_type == EXPR_APPEND
5381 && tv1->vval.v_list != NULL)
5382 list_extend(tv1->vval.v_list, tv2->vval.v_list,
5383 NULL);
5384 else
5385 eval_addlist(tv1, tv2);
5386 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005387 else
5388 eval_addblob(tv1, tv2);
5389 clear_tv(tv2);
Bram Moolenaar4c137212021-04-19 16:48:48 +02005390 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005391 }
5392 break;
5393
Bram Moolenaar1dcae592020-10-19 19:02:42 +02005394 case ISN_LISTAPPEND:
5395 {
5396 typval_T *tv1 = STACK_TV_BOT(-2);
5397 typval_T *tv2 = STACK_TV_BOT(-1);
5398 list_T *l = tv1->vval.v_list;
5399
5400 // add an item to a list
Bram Moolenaar1f4a3452022-01-01 18:29:21 +00005401 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar1dcae592020-10-19 19:02:42 +02005402 if (l == NULL)
5403 {
Bram Moolenaar1dcae592020-10-19 19:02:42 +02005404 emsg(_(e_cannot_add_to_null_list));
5405 goto on_error;
5406 }
Bram Moolenaar1f4a3452022-01-01 18:29:21 +00005407 if (value_check_lock(l->lv_lock, NULL, FALSE))
5408 goto on_error;
Bram Moolenaar1dcae592020-10-19 19:02:42 +02005409 if (list_append_tv(l, tv2) == FAIL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02005410 goto theend;
Bram Moolenaar955347c2020-10-19 23:01:46 +02005411 clear_tv(tv2);
Bram Moolenaar4c137212021-04-19 16:48:48 +02005412 --ectx->ec_stack.ga_len;
Bram Moolenaar1dcae592020-10-19 19:02:42 +02005413 }
5414 break;
5415
Bram Moolenaar80b0e5e2020-10-19 20:45:36 +02005416 case ISN_BLOBAPPEND:
5417 {
5418 typval_T *tv1 = STACK_TV_BOT(-2);
5419 typval_T *tv2 = STACK_TV_BOT(-1);
5420 blob_T *b = tv1->vval.v_blob;
5421 int error = FALSE;
5422 varnumber_T n;
5423
5424 // add a number to a blob
5425 if (b == NULL)
5426 {
5427 SOURCING_LNUM = iptr->isn_lnum;
5428 emsg(_(e_cannot_add_to_null_blob));
5429 goto on_error;
5430 }
5431 n = tv_get_number_chk(tv2, &error);
5432 if (error)
5433 goto on_error;
5434 ga_append(&b->bv_ga, (int)n);
Bram Moolenaar4c137212021-04-19 16:48:48 +02005435 --ectx->ec_stack.ga_len;
Bram Moolenaar80b0e5e2020-10-19 20:45:36 +02005436 }
5437 break;
5438
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005439 // Computation with two arguments of unknown type
5440 case ISN_OPANY:
5441 {
5442 typval_T *tv1 = STACK_TV_BOT(-2);
5443 typval_T *tv2 = STACK_TV_BOT(-1);
5444 varnumber_T n1, n2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005445 float_T f1 = 0, f2 = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005446 int error = FALSE;
5447
5448 if (iptr->isn_arg.op.op_type == EXPR_ADD)
5449 {
5450 if (tv1->v_type == VAR_LIST && tv2->v_type == VAR_LIST)
5451 {
5452 eval_addlist(tv1, tv2);
5453 clear_tv(tv2);
Bram Moolenaar4c137212021-04-19 16:48:48 +02005454 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005455 break;
5456 }
5457 else if (tv1->v_type == VAR_BLOB
5458 && tv2->v_type == VAR_BLOB)
5459 {
5460 eval_addblob(tv1, tv2);
5461 clear_tv(tv2);
Bram Moolenaar4c137212021-04-19 16:48:48 +02005462 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005463 break;
5464 }
5465 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005466 if (tv1->v_type == VAR_FLOAT)
5467 {
5468 f1 = tv1->vval.v_float;
5469 n1 = 0;
5470 }
5471 else
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005472 {
Bram Moolenaarf665e972020-12-05 19:17:16 +01005473 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005474 n1 = tv_get_number_chk(tv1, &error);
5475 if (error)
Bram Moolenaard032f342020-07-18 18:13:02 +02005476 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005477 if (tv2->v_type == VAR_FLOAT)
5478 f1 = n1;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005479 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005480 if (tv2->v_type == VAR_FLOAT)
5481 {
5482 f2 = tv2->vval.v_float;
5483 n2 = 0;
5484 }
5485 else
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005486 {
5487 n2 = tv_get_number_chk(tv2, &error);
5488 if (error)
Bram Moolenaard032f342020-07-18 18:13:02 +02005489 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005490 if (tv1->v_type == VAR_FLOAT)
5491 f2 = n2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005492 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005493 // if there is a float on either side the result is a float
5494 if (tv1->v_type == VAR_FLOAT || tv2->v_type == VAR_FLOAT)
5495 {
5496 switch (iptr->isn_arg.op.op_type)
5497 {
5498 case EXPR_MULT: f1 = f1 * f2; break;
5499 case EXPR_DIV: f1 = f1 / f2; break;
5500 case EXPR_SUB: f1 = f1 - f2; break;
5501 case EXPR_ADD: f1 = f1 + f2; break;
Bram Moolenaar7517ffd2020-08-14 18:35:07 +02005502 default: SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005503 emsg(_(e_cannot_use_percent_with_float));
Bram Moolenaarf0b9f432020-07-17 23:03:17 +02005504 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005505 }
5506 clear_tv(tv1);
5507 clear_tv(tv2);
5508 tv1->v_type = VAR_FLOAT;
5509 tv1->vval.v_float = f1;
Bram Moolenaar4c137212021-04-19 16:48:48 +02005510 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005511 }
5512 else
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005513 {
Bram Moolenaarb1f28572021-01-21 13:03:20 +01005514 int failed = FALSE;
5515
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005516 switch (iptr->isn_arg.op.op_type)
5517 {
5518 case EXPR_MULT: n1 = n1 * n2; break;
Bram Moolenaarb1f28572021-01-21 13:03:20 +01005519 case EXPR_DIV: n1 = num_divide(n1, n2, &failed);
5520 if (failed)
Bram Moolenaar99880f92021-01-20 21:23:14 +01005521 goto on_error;
5522 break;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005523 case EXPR_SUB: n1 = n1 - n2; break;
5524 case EXPR_ADD: n1 = n1 + n2; break;
Bram Moolenaarb1f28572021-01-21 13:03:20 +01005525 default: n1 = num_modulus(n1, n2, &failed);
5526 if (failed)
Bram Moolenaar99880f92021-01-20 21:23:14 +01005527 goto on_error;
5528 break;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005529 }
5530 clear_tv(tv1);
5531 clear_tv(tv2);
5532 tv1->v_type = VAR_NUMBER;
5533 tv1->vval.v_number = n1;
Bram Moolenaar4c137212021-04-19 16:48:48 +02005534 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005535 }
5536 }
5537 break;
5538
Bram Moolenaarbf9d8c32020-07-19 17:55:44 +02005539 case ISN_STRINDEX:
Bram Moolenaar11107ba2020-08-15 21:10:16 +02005540 case ISN_STRSLICE:
Bram Moolenaarbf9d8c32020-07-19 17:55:44 +02005541 {
Bram Moolenaar11107ba2020-08-15 21:10:16 +02005542 int is_slice = iptr->isn_type == ISN_STRSLICE;
5543 varnumber_T n1 = 0, n2;
Bram Moolenaarbf9d8c32020-07-19 17:55:44 +02005544 char_u *res;
5545
5546 // string index: string is at stack-2, index at stack-1
Bram Moolenaar11107ba2020-08-15 21:10:16 +02005547 // string slice: string is at stack-3, first index at
5548 // stack-2, second index at stack-1
Bram Moolenaar11107ba2020-08-15 21:10:16 +02005549 if (is_slice)
5550 {
5551 tv = STACK_TV_BOT(-2);
Bram Moolenaar11107ba2020-08-15 21:10:16 +02005552 n1 = tv->vval.v_number;
5553 }
5554
Bram Moolenaarbf9d8c32020-07-19 17:55:44 +02005555 tv = STACK_TV_BOT(-1);
Bram Moolenaar11107ba2020-08-15 21:10:16 +02005556 n2 = tv->vval.v_number;
Bram Moolenaarbf9d8c32020-07-19 17:55:44 +02005557
Bram Moolenaar4c137212021-04-19 16:48:48 +02005558 ectx->ec_stack.ga_len -= is_slice ? 2 : 1;
Bram Moolenaarbf9d8c32020-07-19 17:55:44 +02005559 tv = STACK_TV_BOT(-1);
Bram Moolenaar11107ba2020-08-15 21:10:16 +02005560 if (is_slice)
5561 // Slice: Select the characters from the string
Bram Moolenaar6601b622021-01-13 21:47:15 +01005562 res = string_slice(tv->vval.v_string, n1, n2, FALSE);
Bram Moolenaar11107ba2020-08-15 21:10:16 +02005563 else
5564 // Index: The resulting variable is a string of a
Bram Moolenaar0289a092021-03-14 18:40:19 +01005565 // single character (including composing characters).
5566 // If the index is too big or negative the result is
5567 // empty.
Bram Moolenaar11107ba2020-08-15 21:10:16 +02005568 res = char_from_string(tv->vval.v_string, n2);
Bram Moolenaarbf9d8c32020-07-19 17:55:44 +02005569 vim_free(tv->vval.v_string);
5570 tv->vval.v_string = res;
5571 }
5572 break;
5573
5574 case ISN_LISTINDEX:
Bram Moolenaared591872020-08-15 22:14:53 +02005575 case ISN_LISTSLICE:
Bram Moolenaarcfc30232021-04-11 20:26:34 +02005576 case ISN_BLOBINDEX:
5577 case ISN_BLOBSLICE:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005578 {
Bram Moolenaarcfc30232021-04-11 20:26:34 +02005579 int is_slice = iptr->isn_type == ISN_LISTSLICE
5580 || iptr->isn_type == ISN_BLOBSLICE;
5581 int is_blob = iptr->isn_type == ISN_BLOBINDEX
5582 || iptr->isn_type == ISN_BLOBSLICE;
Bram Moolenaared591872020-08-15 22:14:53 +02005583 varnumber_T n1, n2;
Bram Moolenaarcfc30232021-04-11 20:26:34 +02005584 typval_T *val_tv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005585
5586 // list index: list is at stack-2, index at stack-1
Bram Moolenaared591872020-08-15 22:14:53 +02005587 // list slice: list is at stack-3, indexes at stack-2 and
5588 // stack-1
Bram Moolenaarcfc30232021-04-11 20:26:34 +02005589 // Same for blob.
5590 val_tv = is_slice ? STACK_TV_BOT(-3) : STACK_TV_BOT(-2);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005591
5592 tv = STACK_TV_BOT(-1);
Bram Moolenaared591872020-08-15 22:14:53 +02005593 n1 = n2 = tv->vval.v_number;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005594 clear_tv(tv);
Bram Moolenaared591872020-08-15 22:14:53 +02005595
5596 if (is_slice)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005597 {
Bram Moolenaared591872020-08-15 22:14:53 +02005598 tv = STACK_TV_BOT(-2);
Bram Moolenaared591872020-08-15 22:14:53 +02005599 n1 = tv->vval.v_number;
5600 clear_tv(tv);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005601 }
Bram Moolenaared591872020-08-15 22:14:53 +02005602
Bram Moolenaar4c137212021-04-19 16:48:48 +02005603 ectx->ec_stack.ga_len -= is_slice ? 2 : 1;
Bram Moolenaar435d8972020-07-05 16:42:13 +02005604 tv = STACK_TV_BOT(-1);
Bram Moolenaar1d634542020-08-18 13:41:50 +02005605 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaarcfc30232021-04-11 20:26:34 +02005606 if (is_blob)
5607 {
5608 if (blob_slice_or_index(val_tv->vval.v_blob, is_slice,
5609 n1, n2, FALSE, tv) == FAIL)
5610 goto on_error;
5611 }
5612 else
5613 {
5614 if (list_slice_or_index(val_tv->vval.v_list, is_slice,
5615 n1, n2, FALSE, tv, TRUE) == FAIL)
5616 goto on_error;
5617 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005618 }
5619 break;
5620
Bram Moolenaarcc673e72020-08-16 17:33:35 +02005621 case ISN_ANYINDEX:
5622 case ISN_ANYSLICE:
5623 {
5624 int is_slice = iptr->isn_type == ISN_ANYSLICE;
5625 typval_T *var1, *var2;
5626 int res;
5627
5628 // index: composite is at stack-2, index at stack-1
5629 // slice: composite is at stack-3, indexes at stack-2 and
5630 // stack-1
5631 tv = is_slice ? STACK_TV_BOT(-3) : STACK_TV_BOT(-2);
Bram Moolenaar3affe7a2020-08-18 20:34:13 +02005632 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaarcc673e72020-08-16 17:33:35 +02005633 if (check_can_index(tv, TRUE, TRUE) == FAIL)
5634 goto on_error;
5635 var1 = is_slice ? STACK_TV_BOT(-2) : STACK_TV_BOT(-1);
5636 var2 = is_slice ? STACK_TV_BOT(-1) : NULL;
Bram Moolenaar6601b622021-01-13 21:47:15 +01005637 res = eval_index_inner(tv, is_slice, var1, var2,
5638 FALSE, NULL, -1, TRUE);
Bram Moolenaarcc673e72020-08-16 17:33:35 +02005639 clear_tv(var1);
5640 if (is_slice)
5641 clear_tv(var2);
Bram Moolenaar4c137212021-04-19 16:48:48 +02005642 ectx->ec_stack.ga_len -= is_slice ? 2 : 1;
Bram Moolenaarcc673e72020-08-16 17:33:35 +02005643 if (res == FAIL)
5644 goto on_error;
5645 }
5646 break;
5647
Bram Moolenaar9af78762020-06-16 11:34:42 +02005648 case ISN_SLICE:
5649 {
5650 list_T *list;
5651 int count = iptr->isn_arg.number;
5652
Bram Moolenaarc5b1c202020-06-18 22:43:27 +02005653 // type will have been checked to be a list
Bram Moolenaar9af78762020-06-16 11:34:42 +02005654 tv = STACK_TV_BOT(-1);
Bram Moolenaar9af78762020-06-16 11:34:42 +02005655 list = tv->vval.v_list;
5656
5657 // no error for short list, expect it to be checked earlier
5658 if (list != NULL && list->lv_len >= count)
5659 {
5660 list_T *newlist = list_slice(list,
5661 count, list->lv_len - 1);
5662
5663 if (newlist != NULL)
5664 {
5665 list_unref(list);
5666 tv->vval.v_list = newlist;
5667 ++newlist->lv_refcount;
5668 }
5669 }
5670 }
5671 break;
5672
Bram Moolenaar47a519a2020-06-14 23:05:10 +02005673 case ISN_GETITEM:
5674 {
5675 listitem_T *li;
Bram Moolenaar035bd1c2021-06-21 19:44:11 +02005676 getitem_T *gi = &iptr->isn_arg.getitem;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02005677
Bram Moolenaarc785b9a2020-06-19 18:34:15 +02005678 // Get list item: list is at stack-1, push item.
5679 // List type and length is checked for when compiling.
Bram Moolenaar035bd1c2021-06-21 19:44:11 +02005680 tv = STACK_TV_BOT(-1 - gi->gi_with_op);
5681 li = list_find(tv->vval.v_list, gi->gi_index);
Bram Moolenaar47a519a2020-06-14 23:05:10 +02005682
Bram Moolenaar35578162021-08-02 19:10:38 +02005683 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02005684 goto theend;
Bram Moolenaar4c137212021-04-19 16:48:48 +02005685 ++ectx->ec_stack.ga_len;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02005686 copy_tv(&li->li_tv, STACK_TV_BOT(-1));
Bram Moolenaarf785aa12021-02-11 21:19:34 +01005687
5688 // Useful when used in unpack assignment. Reset at
5689 // ISN_DROP.
Bram Moolenaar035bd1c2021-06-21 19:44:11 +02005690 ectx->ec_where.wt_index = gi->gi_index + 1;
LemonBoyc5d27442023-08-19 13:02:35 +02005691 ectx->ec_where.wt_kind = WT_VARIABLE;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02005692 }
5693 break;
5694
Yegappan Lakshmanan56d45f12024-11-11 19:58:55 +01005695 // dict member with string key (dict['member'])
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005696 case ISN_MEMBER:
5697 {
5698 dict_T *dict;
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02005699 char_u *key;
5700 dictitem_T *di;
5701
5702 // dict member: dict is at stack-2, key at stack-1
5703 tv = STACK_TV_BOT(-2);
Bram Moolenaar4dac32c2020-05-15 21:44:19 +02005704 // no need to check for VAR_DICT, CHECKTYPE will check.
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02005705 dict = tv->vval.v_dict;
5706
5707 tv = STACK_TV_BOT(-1);
Bram Moolenaar4dac32c2020-05-15 21:44:19 +02005708 // no need to check for VAR_STRING, 2STRING will check.
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02005709 key = tv->vval.v_string;
Bram Moolenaar086fc9a2020-10-30 18:33:02 +01005710 if (key == NULL)
5711 key = (char_u *)"";
Bram Moolenaar4dac32c2020-05-15 21:44:19 +02005712
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02005713 if ((di = dict_find(dict, key, -1)) == NULL)
5714 {
Bram Moolenaar7517ffd2020-08-14 18:35:07 +02005715 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00005716 semsg(_(e_key_not_present_in_dictionary_str), key);
Bram Moolenaar4029cab2020-12-05 18:13:27 +01005717
5718 // If :silent! is used we will continue, make sure the
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02005719 // stack contents makes sense and the dict stack is
5720 // updated.
Bram Moolenaar4029cab2020-12-05 18:13:27 +01005721 clear_tv(tv);
Bram Moolenaar4c137212021-04-19 16:48:48 +02005722 --ectx->ec_stack.ga_len;
Bram Moolenaar4029cab2020-12-05 18:13:27 +01005723 tv = STACK_TV_BOT(-1);
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02005724 (void) dict_stack_save(tv);
Bram Moolenaar4029cab2020-12-05 18:13:27 +01005725 tv->v_type = VAR_NUMBER;
5726 tv->vval.v_number = 0;
Bram Moolenaaraf0df472020-12-02 20:51:22 +01005727 goto on_fatal_error;
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02005728 }
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02005729 clear_tv(tv);
Bram Moolenaar4c137212021-04-19 16:48:48 +02005730 --ectx->ec_stack.ga_len;
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02005731 // Put the dict used on the dict stack, it might be used by
5732 // a dict function later.
Bram Moolenaar50788ef2020-07-05 16:51:26 +02005733 tv = STACK_TV_BOT(-1);
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02005734 if (dict_stack_save(tv) == FAIL)
5735 goto on_fatal_error;
Bram Moolenaar50788ef2020-07-05 16:51:26 +02005736 copy_tv(&di->di_tv, tv);
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02005737 }
5738 break;
5739
Yegappan Lakshmanan56d45f12024-11-11 19:58:55 +01005740 // dict member with string key (dict.member)
5741 // or can be an object
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02005742 case ISN_STRINGMEMBER:
5743 {
5744 dict_T *dict;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005745 dictitem_T *di;
5746
5747 tv = STACK_TV_BOT(-1);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005748
Yegappan Lakshmanan778ada42025-02-17 20:21:23 +01005749 if (tv->v_type == VAR_OBJECT
5750 || tv->v_type == VAR_CLASS)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005751 {
Yegappan Lakshmanan56d45f12024-11-11 19:58:55 +01005752 if (dict_stack_save(tv) == FAIL)
5753 goto on_fatal_error;
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02005754
Yegappan Lakshmanan56d45f12024-11-11 19:58:55 +01005755 ufunc_T *ufunc = (((dfunc_T *)def_functions.ga_data)
5756 + ectx->ec_dfunc_idx)->df_ufunc;
Yegappan Lakshmanan778ada42025-02-17 20:21:23 +01005757 // Class or an object (not a Dict)
5758 if (var_any_get_oc_member(ufunc->uf_class, iptr, tv) == FAIL)
Yegappan Lakshmanan56d45f12024-11-11 19:58:55 +01005759 goto on_error;
5760 }
5761 else
5762 {
5763 if (tv->v_type != VAR_DICT || tv->vval.v_dict == NULL)
5764 {
5765 SOURCING_LNUM = iptr->isn_lnum;
5766 emsg(_(e_dictionary_required));
5767 goto on_error;
5768 }
5769 dict = tv->vval.v_dict;
5770
5771 if ((di = dict_find(dict, iptr->isn_arg.string, -1))
5772 == NULL)
5773 {
5774 SOURCING_LNUM = iptr->isn_lnum;
5775 semsg(_(e_key_not_present_in_dictionary_str),
5776 iptr->isn_arg.string);
5777 goto on_error;
5778 }
5779 // Put the dict used on the dict stack, it might be
5780 // used by a dict function later.
5781 if (dict_stack_save(tv) == FAIL)
5782 goto on_fatal_error;
5783
5784 copy_tv(&di->di_tv, tv);
5785 }
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02005786 }
5787 break;
5788
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00005789 case ISN_GET_OBJ_MEMBER:
Bram Moolenaar29ac5df2023-01-16 19:43:47 +00005790 case ISN_GET_ITF_MEMBER:
Bram Moolenaarffdaca92022-12-09 21:41:48 +00005791 {
5792 tv = STACK_TV_BOT(-1);
5793 if (tv->v_type != VAR_OBJECT)
5794 {
5795 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaard0200c82023-01-28 15:19:40 +00005796 object_required_error(tv);
Bram Moolenaarffdaca92022-12-09 21:41:48 +00005797 goto on_error;
5798 }
Bram Moolenaar29ac5df2023-01-16 19:43:47 +00005799
Bram Moolenaarffdaca92022-12-09 21:41:48 +00005800 object_T *obj = tv->vval.v_object;
Bram Moolenaarc3f971f2023-03-02 17:38:33 +00005801 if (obj == NULL)
5802 {
5803 SOURCING_LNUM = iptr->isn_lnum;
5804 emsg(_(e_using_null_object));
5805 goto on_error;
5806 }
5807
Bram Moolenaar29ac5df2023-01-16 19:43:47 +00005808 int idx;
5809 if (iptr->isn_type == ISN_GET_OBJ_MEMBER)
Ernie Rael18143d32023-09-04 22:30:41 +02005810 idx = iptr->isn_arg.classmember.cm_idx;
Bram Moolenaar29ac5df2023-01-16 19:43:47 +00005811 else
5812 {
5813 idx = iptr->isn_arg.classmember.cm_idx;
5814 // convert the interface index to the object index
5815 idx = object_index_from_itf_index(
Ernie Rael18143d32023-09-04 22:30:41 +02005816 iptr->isn_arg.classmember.cm_class,
Yegappan Lakshmanan5a05d372023-09-29 19:43:11 +02005817 FALSE, idx, obj->obj_class);
Bram Moolenaar29ac5df2023-01-16 19:43:47 +00005818 }
5819
Ernie Rael18143d32023-09-04 22:30:41 +02005820 // The members are located right after the object struct.
Yegappan Lakshmanan5a05d372023-09-29 19:43:11 +02005821 typval_T *mtv = ((typval_T *)(obj + 1)) + idx;
Yegappan Lakshmananb04af4c2025-01-03 10:50:08 +01005822 if (mtv->v_type == VAR_UNKNOWN)
5823 {
5824 // Referencing an object variable (without a type)
5825 // which is not yet initialized. So the type is not
5826 // yet known.
5827 ocmember_T *m = &obj->obj_class->class_obj_members[idx];
5828 SOURCING_LNUM = iptr->isn_lnum;
5829 semsg(_(e_uninitialized_object_var_reference),
5830 m->ocm_name);
5831 goto on_error;
5832 }
Bram Moolenaar590162c2022-12-24 21:24:06 +00005833 copy_tv(mtv, tv);
Bram Moolenaarffdaca92022-12-09 21:41:48 +00005834
5835 // Unreference the object after getting the member, it may
5836 // be freed.
5837 object_unref(obj);
5838 }
5839 break;
5840
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00005841 case ISN_STORE_THIS:
5842 {
5843 int idx = iptr->isn_arg.number;
5844 object_T *obj = STACK_TV_VAR(0)->vval.v_object;
5845 // the members are located right after the object struct
5846 typval_T *mtv = ((typval_T *)(obj + 1)) + idx;
5847 clear_tv(mtv);
5848 *mtv = *STACK_TV_BOT(-1);
5849 --ectx->ec_stack.ga_len;
5850 }
5851 break;
5852
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02005853 case ISN_CLEARDICT:
5854 dict_stack_drop();
5855 break;
5856
5857 case ISN_USEDICT:
5858 {
5859 typval_T *dict_tv = dict_stack_get_tv();
5860
5861 // Turn "dict.Func" into a partial for "Func" bound to
5862 // "dict". Don't do this when "Func" is already a partial
5863 // that was bound explicitly (pt_auto is FALSE).
5864 tv = STACK_TV_BOT(-1);
5865 if (dict_tv != NULL
5866 && dict_tv->v_type == VAR_DICT
5867 && dict_tv->vval.v_dict != NULL
5868 && (tv->v_type == VAR_FUNC
5869 || (tv->v_type == VAR_PARTIAL
5870 && (tv->vval.v_partial->pt_auto
5871 || tv->vval.v_partial->pt_dict == NULL))))
5872 dict_tv->vval.v_dict =
5873 make_partial(dict_tv->vval.v_dict, tv);
5874 dict_stack_drop();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005875 }
5876 break;
5877
5878 case ISN_NEGATENR:
5879 tv = STACK_TV_BOT(-1);
Bram Moolenaar0c7f2612022-02-17 19:44:07 +00005880 // CHECKTYPE should have checked the variable type
Bram Moolenaarc58164c2020-03-29 18:40:30 +02005881 if (tv->v_type == VAR_FLOAT)
5882 tv->vval.v_float = -tv->vval.v_float;
5883 else
Bram Moolenaarc58164c2020-03-29 18:40:30 +02005884 tv->vval.v_number = -tv->vval.v_number;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005885 break;
5886
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005887 case ISN_CHECKTYPE:
5888 {
5889 checktype_T *ct = &iptr->isn_arg.type;
Bram Moolenaarb1040dc2022-05-18 11:00:48 +01005890 int r;
LemonBoyc5d27442023-08-19 13:02:35 +02005891 where_T where = WHERE_INIT;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005892
Bram Moolenaarb3005ce2021-01-22 17:51:06 +01005893 tv = STACK_TV_BOT((int)ct->ct_off);
Bram Moolenaar5e654232020-09-16 15:22:00 +02005894 SOURCING_LNUM = iptr->isn_lnum;
LemonBoyc5d27442023-08-19 13:02:35 +02005895 if (ct->ct_arg_idx > 0)
5896 {
5897 where.wt_index = ct->ct_arg_idx;
5898 where.wt_kind = ct->ct_is_var ? WT_VARIABLE : WT_ARGUMENT;
LemonBoyc5d27442023-08-19 13:02:35 +02005899 }
LemonBoyf244b2f2023-08-19 16:02:04 +02005900 where.wt_func_name = ectx->ec_where.wt_func_name;
LemonBoyc5d27442023-08-19 13:02:35 +02005901 r = check_typval_type(ct->ct_type, tv, where);
Bram Moolenaarb1040dc2022-05-18 11:00:48 +01005902 if (r == FAIL)
5903 goto on_error;
Bram Moolenaar5e654232020-09-16 15:22:00 +02005904
5905 // number 0 is FALSE, number 1 is TRUE
5906 if (tv->v_type == VAR_NUMBER
5907 && ct->ct_type->tt_type == VAR_BOOL
5908 && (tv->vval.v_number == 0
5909 || tv->vval.v_number == 1))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005910 {
Bram Moolenaar5e654232020-09-16 15:22:00 +02005911 tv->v_type = VAR_BOOL;
5912 tv->vval.v_number = tv->vval.v_number
Bram Moolenaardadaddd2020-09-12 19:11:23 +02005913 ? VVAL_TRUE : VVAL_FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005914 }
5915 }
5916 break;
5917
Bram Moolenaar9af78762020-06-16 11:34:42 +02005918 case ISN_CHECKLEN:
5919 {
5920 int min_len = iptr->isn_arg.checklen.cl_min_len;
5921 list_T *list = NULL;
5922
5923 tv = STACK_TV_BOT(-1);
5924 if (tv->v_type == VAR_LIST)
5925 list = tv->vval.v_list;
5926 if (list == NULL || list->lv_len < min_len
5927 || (list->lv_len > min_len
5928 && !iptr->isn_arg.checklen.cl_more_OK))
5929 {
Bram Moolenaar7517ffd2020-08-14 18:35:07 +02005930 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar451c2e32020-08-15 16:33:28 +02005931 semsg(_(e_expected_nr_items_but_got_nr),
Bram Moolenaar9af78762020-06-16 11:34:42 +02005932 min_len, list == NULL ? 0 : list->lv_len);
Bram Moolenaarf0b9f432020-07-17 23:03:17 +02005933 goto on_error;
Bram Moolenaar9af78762020-06-16 11:34:42 +02005934 }
5935 }
5936 break;
5937
Bram Moolenaaraa210a32021-01-02 15:41:03 +01005938 case ISN_SETTYPE:
Bram Moolenaar381692b2022-02-02 20:01:27 +00005939 set_tv_type(STACK_TV_BOT(-1), iptr->isn_arg.type.ct_type);
Bram Moolenaaraa210a32021-01-02 15:41:03 +01005940 break;
5941
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005942 case ISN_2BOOL:
Bram Moolenaar2bb26582020-10-03 22:52:39 +02005943 case ISN_COND2BOOL:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005944 {
5945 int n;
Bram Moolenaar2bb26582020-10-03 22:52:39 +02005946 int error = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005947
Bram Moolenaar2bb26582020-10-03 22:52:39 +02005948 if (iptr->isn_type == ISN_2BOOL)
5949 {
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02005950 tv = STACK_TV_BOT(iptr->isn_arg.tobool.offset);
Bram Moolenaar2bb26582020-10-03 22:52:39 +02005951 n = tv2bool(tv);
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02005952 if (iptr->isn_arg.tobool.invert)
Bram Moolenaar2bb26582020-10-03 22:52:39 +02005953 n = !n;
5954 }
5955 else
5956 {
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02005957 tv = STACK_TV_BOT(-1);
Bram Moolenaar2bb26582020-10-03 22:52:39 +02005958 SOURCING_LNUM = iptr->isn_lnum;
5959 n = tv_get_bool_chk(tv, &error);
5960 if (error)
5961 goto on_error;
5962 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005963 clear_tv(tv);
5964 tv->v_type = VAR_BOOL;
5965 tv->vval.v_number = n ? VVAL_TRUE : VVAL_FALSE;
5966 }
5967 break;
5968
5969 case ISN_2STRING:
Bram Moolenaar418f1df2020-08-12 21:34:49 +02005970 case ISN_2STRING_ANY:
Bram Moolenaar0acbf5a2021-01-05 20:58:25 +01005971 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02005972 if (do_2string(STACK_TV_BOT(iptr->isn_arg.tostring.offset),
5973 iptr->isn_type == ISN_2STRING_ANY,
Yegappan Lakshmananbce51d92024-04-15 19:19:52 +02005974 iptr->isn_arg.tostring.flags) == FAIL)
Bram Moolenaar4f5e3972020-12-21 17:30:50 +01005975 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005976 break;
5977
Bram Moolenaar08597872020-12-10 19:43:40 +01005978 case ISN_RANGE:
5979 {
5980 exarg_T ea;
5981 char *errormsg;
5982
Bram Moolenaarece0b872021-01-08 20:40:45 +01005983 ea.line2 = 0;
Bram Moolenaard1510ee2021-01-04 16:15:58 +01005984 ea.addr_count = 0;
Bram Moolenaar08597872020-12-10 19:43:40 +01005985 ea.addr_type = ADDR_LINES;
5986 ea.cmd = iptr->isn_arg.string;
Bram Moolenaarece0b872021-01-08 20:40:45 +01005987 ea.skip = FALSE;
Bram Moolenaar08597872020-12-10 19:43:40 +01005988 if (parse_cmd_address(&ea, &errormsg, FALSE) == FAIL)
Bram Moolenaarece0b872021-01-08 20:40:45 +01005989 goto on_error;
Bram Moolenaara28639e2021-01-19 22:48:09 +01005990
Bram Moolenaar35578162021-08-02 19:10:38 +02005991 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02005992 goto theend;
Bram Moolenaar4c137212021-04-19 16:48:48 +02005993 ++ectx->ec_stack.ga_len;
Bram Moolenaara28639e2021-01-19 22:48:09 +01005994 tv = STACK_TV_BOT(-1);
5995 tv->v_type = VAR_NUMBER;
5996 tv->v_lock = 0;
Bram Moolenaar06651632022-04-27 17:54:25 +01005997 tv->vval.v_number = ea.line2;
Bram Moolenaar08597872020-12-10 19:43:40 +01005998 }
5999 break;
6000
Bram Moolenaarc3516f72020-09-08 22:45:35 +02006001 case ISN_PUT:
64-bitman250739d2025-03-16 21:10:47 +01006002 isn_put_do(ectx, iptr, tv, FALSE);
6003 break;
6004 case ISN_IPUT:
6005 isn_put_do(ectx, iptr, tv, TRUE);
Bram Moolenaarc3516f72020-09-08 22:45:35 +02006006 break;
6007
Bram Moolenaar02194d22020-10-24 23:08:38 +02006008 case ISN_CMDMOD:
Bram Moolenaar4c137212021-04-19 16:48:48 +02006009 ectx->ec_funclocal.floc_save_cmdmod = cmdmod;
6010 ectx->ec_funclocal.floc_restore_cmdmod = TRUE;
6011 ectx->ec_funclocal.floc_restore_cmdmod_stacklen =
6012 ectx->ec_stack.ga_len;
Bram Moolenaar02194d22020-10-24 23:08:38 +02006013 cmdmod = *iptr->isn_arg.cmdmod.cf_cmdmod;
6014 apply_cmdmod(&cmdmod);
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +02006015 break;
6016
Bram Moolenaar02194d22020-10-24 23:08:38 +02006017 case ISN_CMDMOD_REV:
6018 // filter regprog is owned by the instruction, don't free it
6019 cmdmod.cmod_filter_regmatch.regprog = NULL;
6020 undo_cmdmod(&cmdmod);
Bram Moolenaar4c137212021-04-19 16:48:48 +02006021 cmdmod = ectx->ec_funclocal.floc_save_cmdmod;
6022 ectx->ec_funclocal.floc_restore_cmdmod = FALSE;
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +02006023 break;
6024
Bram Moolenaar792f7862020-11-23 08:31:18 +01006025 case ISN_UNPACK:
6026 {
6027 int count = iptr->isn_arg.unpack.unp_count;
6028 int semicolon = iptr->isn_arg.unpack.unp_semicolon;
6029 list_T *l;
6030 listitem_T *li;
6031 int i;
6032
6033 // Check there is a valid list to unpack.
6034 tv = STACK_TV_BOT(-1);
6035 if (tv->v_type != VAR_LIST)
6036 {
6037 SOURCING_LNUM = iptr->isn_lnum;
6038 emsg(_(e_for_argument_must_be_sequence_of_lists));
6039 goto on_error;
6040 }
6041 l = tv->vval.v_list;
6042 if (l == NULL
6043 || l->lv_len < (semicolon ? count - 1 : count))
6044 {
6045 SOURCING_LNUM = iptr->isn_lnum;
6046 emsg(_(e_list_value_does_not_have_enough_items));
6047 goto on_error;
6048 }
6049 else if (!semicolon && l->lv_len > count)
6050 {
6051 SOURCING_LNUM = iptr->isn_lnum;
6052 emsg(_(e_list_value_has_more_items_than_targets));
6053 goto on_error;
6054 }
6055
6056 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar35578162021-08-02 19:10:38 +02006057 if (GA_GROW_FAILS(&ectx->ec_stack, count - 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02006058 goto theend;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006059 ectx->ec_stack.ga_len += count - 1;
Bram Moolenaar792f7862020-11-23 08:31:18 +01006060
6061 // Variable after semicolon gets a list with the remaining
6062 // items.
6063 if (semicolon)
6064 {
6065 list_T *rem_list =
6066 list_alloc_with_items(l->lv_len - count + 1);
6067
6068 if (rem_list == NULL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02006069 goto theend;
Bram Moolenaar792f7862020-11-23 08:31:18 +01006070 tv = STACK_TV_BOT(-count);
6071 tv->vval.v_list = rem_list;
6072 ++rem_list->lv_refcount;
6073 tv->v_lock = 0;
6074 li = l->lv_first;
6075 for (i = 0; i < count - 1; ++i)
6076 li = li->li_next;
6077 for (i = 0; li != NULL; ++i)
6078 {
Bram Moolenaar61efa162022-03-18 13:10:48 +00006079 typval_T tvcopy;
6080
6081 copy_tv(&li->li_tv, &tvcopy);
6082 list_set_item(rem_list, i, &tvcopy);
Bram Moolenaar792f7862020-11-23 08:31:18 +01006083 li = li->li_next;
6084 }
6085 --count;
6086 }
6087
6088 // Produce the values in reverse order, first item last.
6089 li = l->lv_first;
6090 for (i = 0; i < count; ++i)
6091 {
6092 tv = STACK_TV_BOT(-i - 1);
6093 copy_tv(&li->li_tv, tv);
6094 li = li->li_next;
6095 }
6096
6097 list_unref(l);
6098 }
6099 break;
6100
Bram Moolenaarb2049902021-01-24 12:53:53 +01006101 case ISN_PROF_START:
6102 case ISN_PROF_END:
6103 {
Bram Moolenaarf002a412021-01-24 13:34:18 +01006104#ifdef FEAT_PROFILE
Bram Moolenaarca16c602022-09-06 18:57:08 +01006105 funccall_T cookie;
6106 ufunc_T *cur_ufunc =
Bram Moolenaarb2049902021-01-24 12:53:53 +01006107 (((dfunc_T *)def_functions.ga_data)
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02006108 + ectx->ec_dfunc_idx)->df_ufunc;
Bram Moolenaarb2049902021-01-24 12:53:53 +01006109
Bram Moolenaarca16c602022-09-06 18:57:08 +01006110 cookie.fc_func = cur_ufunc;
Bram Moolenaarb2049902021-01-24 12:53:53 +01006111 if (iptr->isn_type == ISN_PROF_START)
6112 {
6113 func_line_start(&cookie, iptr->isn_lnum);
6114 // if we get here the instruction is executed
6115 func_line_exec(&cookie);
6116 }
6117 else
6118 func_line_end(&cookie);
Bram Moolenaarf002a412021-01-24 13:34:18 +01006119#endif
Bram Moolenaarb2049902021-01-24 12:53:53 +01006120 }
6121 break;
6122
Bram Moolenaare99d4222021-06-13 14:01:26 +02006123 case ISN_DEBUG:
Bram Moolenaar4f8f5422021-06-20 19:28:14 +02006124 handle_debug(iptr, ectx);
Bram Moolenaare99d4222021-06-13 14:01:26 +02006125 break;
6126
Bram Moolenaar389df252020-07-09 21:20:47 +02006127 case ISN_SHUFFLE:
6128 {
Bram Moolenaar792f7862020-11-23 08:31:18 +01006129 typval_T tmp_tv;
6130 int item = iptr->isn_arg.shuffle.shfl_item;
6131 int up = iptr->isn_arg.shuffle.shfl_up;
Bram Moolenaar389df252020-07-09 21:20:47 +02006132
6133 tmp_tv = *STACK_TV_BOT(-item);
6134 for ( ; up > 0 && item > 1; --up)
6135 {
6136 *STACK_TV_BOT(-item) = *STACK_TV_BOT(-item + 1);
6137 --item;
6138 }
6139 *STACK_TV_BOT(-item) = tmp_tv;
6140 }
6141 break;
6142
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006143 case ISN_DROP:
Bram Moolenaar4c137212021-04-19 16:48:48 +02006144 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006145 clear_tv(STACK_TV_BOT(0));
LemonBoyc5d27442023-08-19 13:02:35 +02006146 ectx->ec_where = (where_T)WHERE_INIT;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006147 break;
Yegappan Lakshmanan16f2d3a2025-02-24 19:23:43 +01006148
6149 case ISN_SCRIPTCTX_SET:
6150 // change the script context. Used to evaluate an object
6151 // member variable initialization expression in the context of
6152 // the script where the class is defined.
6153 current_sctx = iptr->isn_arg.setsctx;
6154 break;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006155 }
Bram Moolenaarf0b9f432020-07-17 23:03:17 +02006156 continue;
6157
Bram Moolenaard032f342020-07-18 18:13:02 +02006158func_return:
Bram Moolenaar7cbfaa52020-09-18 21:25:32 +02006159 // Restore previous function. If the frame pointer is where we started
6160 // then there is none and we are done.
Bram Moolenaar4c137212021-04-19 16:48:48 +02006161 if (ectx->ec_frame_idx == ectx->ec_initial_frame_idx)
Bram Moolenaard032f342020-07-18 18:13:02 +02006162 goto done;
Bram Moolenaar7cbfaa52020-09-18 21:25:32 +02006163
Bram Moolenaar4c137212021-04-19 16:48:48 +02006164 if (func_return(ectx) == FAIL)
Bram Moolenaard032f342020-07-18 18:13:02 +02006165 // only fails when out of memory
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02006166 goto theend;
Bram Moolenaarc7db5772020-07-21 20:55:50 +02006167 continue;
Bram Moolenaard032f342020-07-18 18:13:02 +02006168
Bram Moolenaarf0b9f432020-07-17 23:03:17 +02006169on_error:
Bram Moolenaaraf0df472020-12-02 20:51:22 +01006170 // Jump here for an error that does not require aborting execution.
Bram Moolenaar56602ba2020-12-05 21:22:08 +01006171 // If "emsg_silent" is set then ignore the error, unless it was set
6172 // when calling the function.
Bram Moolenaar4c137212021-04-19 16:48:48 +02006173 if (did_emsg_cumul + did_emsg == ectx->ec_did_emsg_before
Bram Moolenaar56602ba2020-12-05 21:22:08 +01006174 && emsg_silent && did_emsg_def == 0)
Bram Moolenaarf9041332021-01-21 19:41:16 +01006175 {
6176 // If a sequence of instructions causes an error while ":silent!"
6177 // was used, restore the stack length and jump ahead to restoring
6178 // the cmdmod.
Bram Moolenaar4c137212021-04-19 16:48:48 +02006179 if (ectx->ec_funclocal.floc_restore_cmdmod)
Bram Moolenaarf9041332021-01-21 19:41:16 +01006180 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02006181 while (ectx->ec_stack.ga_len
6182 > ectx->ec_funclocal.floc_restore_cmdmod_stacklen)
Bram Moolenaarf9041332021-01-21 19:41:16 +01006183 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02006184 --ectx->ec_stack.ga_len;
Bram Moolenaarf9041332021-01-21 19:41:16 +01006185 clear_tv(STACK_TV_BOT(0));
6186 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02006187 while (ectx->ec_instr[ectx->ec_iidx].isn_type != ISN_CMDMOD_REV)
6188 ++ectx->ec_iidx;
Bram Moolenaarf9041332021-01-21 19:41:16 +01006189 }
Bram Moolenaarcd030c42020-10-30 21:49:40 +01006190 continue;
Bram Moolenaarf9041332021-01-21 19:41:16 +01006191 }
Bram Moolenaaraf0df472020-12-02 20:51:22 +01006192on_fatal_error:
6193 // Jump here for an error that messes up the stack.
Bram Moolenaar171fb922020-10-28 16:54:47 +01006194 // If we are not inside a try-catch started here, abort execution.
Bram Moolenaar4c137212021-04-19 16:48:48 +02006195 if (trylevel <= ectx->ec_trylevel_at_start)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02006196 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006197 }
6198
6199done:
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02006200 ret = OK;
6201theend:
Bram Moolenaar58779852022-09-06 18:31:14 +01006202 may_invoke_defer_funcs(ectx);
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006203
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02006204 dict_stack_clear(dict_stack_len_at_start);
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02006205 ectx->ec_trylevel_at_start = save_trylevel_at_start;
6206 return ret;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006207}
6208
6209/*
Bram Moolenaar806a2732022-09-04 15:40:36 +01006210 * Execute the instructions from a VAR_INSTR typval and put the result in
Bram Moolenaarf18332f2021-05-07 17:55:55 +02006211 * "rettv".
6212 * Return OK or FAIL.
6213 */
6214 int
6215exe_typval_instr(typval_T *tv, typval_T *rettv)
6216{
6217 ectx_T *ectx = tv->vval.v_instr->instr_ectx;
6218 isn_T *save_instr = ectx->ec_instr;
6219 int save_iidx = ectx->ec_iidx;
6220 int res;
6221
LemonBoyf3b48952022-05-05 13:53:03 +01006222 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
6223 // even when the compilation fails.
6224 rettv->v_type = VAR_UNKNOWN;
6225
Bram Moolenaarf18332f2021-05-07 17:55:55 +02006226 ectx->ec_instr = tv->vval.v_instr->instr_instr;
6227 res = exec_instructions(ectx);
6228 if (res == OK)
6229 {
6230 *rettv = *STACK_TV_BOT(-1);
6231 --ectx->ec_stack.ga_len;
6232 }
6233
6234 ectx->ec_instr = save_instr;
6235 ectx->ec_iidx = save_iidx;
6236
6237 return res;
6238}
6239
6240/*
Bram Moolenaar4c137212021-04-19 16:48:48 +02006241 * Execute the instructions from an ISN_SUBSTITUTE command, which are in
6242 * "substitute_instr".
6243 */
6244 char_u *
6245exe_substitute_instr(void)
6246{
6247 ectx_T *ectx = substitute_instr->subs_ectx;
6248 isn_T *save_instr = ectx->ec_instr;
6249 int save_iidx = ectx->ec_iidx;
6250 char_u *res;
6251
6252 ectx->ec_instr = substitute_instr->subs_instr;
6253 if (exec_instructions(ectx) == OK)
Bram Moolenaar90193e62021-04-04 20:49:50 +02006254 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02006255 typval_T *tv = STACK_TV_BOT(-1);
6256
Bram Moolenaar27523602021-06-05 21:36:19 +02006257 res = typval2string(tv, TRUE);
Bram Moolenaar4c137212021-04-19 16:48:48 +02006258 --ectx->ec_stack.ga_len;
6259 clear_tv(tv);
Bram Moolenaar90193e62021-04-04 20:49:50 +02006260 }
6261 else
6262 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02006263 substitute_instr->subs_status = FAIL;
6264 res = vim_strsave((char_u *)"");
Bram Moolenaar90193e62021-04-04 20:49:50 +02006265 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006266
Bram Moolenaar4c137212021-04-19 16:48:48 +02006267 ectx->ec_instr = save_instr;
6268 ectx->ec_iidx = save_iidx;
6269
6270 return res;
6271}
6272
6273/*
6274 * Call a "def" function from old Vim script.
6275 * Return OK or FAIL.
6276 */
6277 int
6278call_def_function(
6279 ufunc_T *ufunc,
6280 int argc_arg, // nr of arguments
6281 typval_T *argv, // arguments
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01006282 int flags, // DEF_ flags
Bram Moolenaar4c137212021-04-19 16:48:48 +02006283 partial_T *partial, // optional partial for context
Bram Moolenaarffdaca92022-12-09 21:41:48 +00006284 object_T *object, // object, e.g. for this.Func()
Bram Moolenaar58779852022-09-06 18:31:14 +01006285 funccall_T *funccal,
Bram Moolenaar4c137212021-04-19 16:48:48 +02006286 typval_T *rettv) // return value
6287{
6288 ectx_T ectx; // execution context
6289 int argc = argc_arg;
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01006290 int partial_argc = partial == NULL
6291 || (flags & DEF_USE_PT_ARGV) == 0
6292 ? 0 : partial->pt_argc;
6293 int total_argc = argc + partial_argc;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006294 typval_T *tv;
6295 int idx;
6296 int ret = FAIL;
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01006297 int defcount = ufunc->uf_args.ga_len - total_argc;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006298 sctx_T save_current_sctx = current_sctx;
6299 int did_emsg_before = did_emsg_cumul + did_emsg;
6300 int save_suppress_errthrow = suppress_errthrow;
6301 msglist_T **saved_msg_list = NULL;
6302 msglist_T *private_msg_list = NULL;
6303 int save_emsg_silent_def = emsg_silent_def;
6304 int save_did_emsg_def = did_emsg_def;
6305 int orig_funcdepth;
Bram Moolenaare99d4222021-06-13 14:01:26 +02006306 int orig_nesting_level = ex_nesting_level;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006307
6308// Get pointer to item in the stack.
6309#undef STACK_TV
6310#define STACK_TV(idx) (((typval_T *)ectx.ec_stack.ga_data) + idx)
6311
6312// Get pointer to item at the bottom of the stack, -1 is the bottom.
6313#undef STACK_TV_BOT
6314#define STACK_TV_BOT(idx) (((typval_T *)ectx.ec_stack.ga_data) + ectx.ec_stack.ga_len + idx)
6315
6316// Get pointer to a local variable on the stack. Negative for arguments.
6317#undef STACK_TV_VAR
6318#define STACK_TV_VAR(idx) (((typval_T *)ectx.ec_stack.ga_data) + ectx.ec_frame_idx + STACK_FRAME_SIZE + idx)
6319
6320 if (ufunc->uf_def_status == UF_NOT_COMPILED
6321 || ufunc->uf_def_status == UF_COMPILE_ERROR
Bram Moolenaar139575d2022-03-15 19:29:30 +00006322 || (func_needs_compiling(ufunc, get_compile_type(ufunc))
6323 && compile_def_function(ufunc, FALSE,
6324 get_compile_type(ufunc), NULL) == FAIL))
Bram Moolenaar4c137212021-04-19 16:48:48 +02006325 {
6326 if (did_emsg_cumul + did_emsg == did_emsg_before)
6327 semsg(_(e_function_is_not_compiled_str),
6328 printable_func_name(ufunc));
6329 return FAIL;
6330 }
6331
6332 {
6333 // Check the function was really compiled.
6334 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
6335 + ufunc->uf_dfunc_idx;
Bram Moolenaarcc341812022-09-19 15:54:34 +01006336 if (dfunc->df_ufunc == NULL)
6337 {
6338 semsg(_(e_function_was_deleted_str), printable_func_name(ufunc));
6339 return FAIL;
6340 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02006341 if (INSTRUCTIONS(dfunc) == NULL)
6342 {
6343 iemsg("using call_def_function() on not compiled function");
6344 return FAIL;
6345 }
6346 }
6347
6348 // If depth of calling is getting too high, don't execute the function.
6349 orig_funcdepth = funcdepth_get();
6350 if (funcdepth_increment() == FAIL)
6351 return FAIL;
6352
6353 CLEAR_FIELD(ectx);
6354 ectx.ec_dfunc_idx = ufunc->uf_dfunc_idx;
6355 ga_init2(&ectx.ec_stack, sizeof(typval_T), 500);
Bram Moolenaar35578162021-08-02 19:10:38 +02006356 if (GA_GROW_FAILS(&ectx.ec_stack, 20))
Bram Moolenaar4c137212021-04-19 16:48:48 +02006357 {
6358 funcdepth_decrement();
6359 return FAIL;
6360 }
6361 ga_init2(&ectx.ec_trystack, sizeof(trycmd_T), 10);
6362 ga_init2(&ectx.ec_funcrefs, sizeof(partial_T *), 10);
6363 ectx.ec_did_emsg_before = did_emsg_before;
Bram Moolenaare99d4222021-06-13 14:01:26 +02006364 ++ex_nesting_level;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006365
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01006366 idx = total_argc - ufunc->uf_args.ga_len;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006367 if (idx > 0 && ufunc->uf_va_name == NULL)
6368 {
Matvey Tarasovd14bb1a2022-06-29 13:18:27 +01006369 semsg(NGETTEXT(e_one_argument_too_many, e_nr_arguments_too_many,
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01006370 idx), idx);
Bram Moolenaar4c137212021-04-19 16:48:48 +02006371 goto failed_early;
6372 }
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01006373 idx = total_argc - ufunc->uf_args.ga_len + ufunc->uf_def_args.ga_len;
Bram Moolenaarc6d71532021-06-05 18:49:38 +02006374 if (idx < 0)
Bram Moolenaar8da6d6d2021-06-05 18:15:09 +02006375 {
Matvey Tarasovd14bb1a2022-06-29 13:18:27 +01006376 semsg(NGETTEXT(e_one_argument_too_few, e_nr_arguments_too_few,
Bram Moolenaar98aff652022-09-06 21:02:35 +01006377 -idx), -idx);
Bram Moolenaar8da6d6d2021-06-05 18:15:09 +02006378 goto failed_early;
6379 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02006380
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01006381 // Put values from the partial and arguments on the stack, but no more than
6382 // what the function expects. A lambda can be called with more arguments
6383 // than it uses.
6384 for (idx = 0; idx < total_argc
Bram Moolenaar4c137212021-04-19 16:48:48 +02006385 && (ufunc->uf_va_name != NULL || idx < ufunc->uf_args.ga_len);
6386 ++idx)
6387 {
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01006388 int argv_idx = idx - partial_argc;
6389
6390 tv = idx < partial_argc ? partial->pt_argv + idx : argv + argv_idx;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006391 if (idx >= ufunc->uf_args.ga_len - ufunc->uf_def_args.ga_len
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01006392 && tv->v_type == VAR_SPECIAL
6393 && tv->vval.v_number == VVAL_NONE)
Bram Moolenaar4c137212021-04-19 16:48:48 +02006394 {
6395 // Use the default value.
6396 STACK_TV_BOT(0)->v_type = VAR_UNKNOWN;
6397 }
6398 else
6399 {
Bram Moolenaar47bba532023-01-20 18:49:46 +00006400 int done = FALSE;
6401 if (ufunc->uf_arg_types != NULL && idx < ufunc->uf_args.ga_len)
6402 {
6403 type_T *expected = ufunc->uf_arg_types[idx];
6404 if (expected->tt_type == VAR_FLOAT && tv->v_type == VAR_NUMBER)
6405 {
6406 // When a float is expected and a number was given, convert
6407 // the value.
6408 STACK_TV_BOT(0)->v_type = VAR_FLOAT;
6409 STACK_TV_BOT(0)->v_lock = 0;
6410 STACK_TV_BOT(0)->vval.v_float = tv->vval.v_number;
6411 done = TRUE;
6412 }
6413 else if (check_typval_arg_type(expected, tv,
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01006414 NULL, argv_idx + 1) == FAIL)
Bram Moolenaar47bba532023-01-20 18:49:46 +00006415 goto failed_early;
Yegappan Lakshmanan92195ae2024-12-22 14:44:35 +01006416 }
Bram Moolenaar47bba532023-01-20 18:49:46 +00006417 if (!done)
6418 copy_tv(tv, STACK_TV_BOT(0));
Bram Moolenaar4c137212021-04-19 16:48:48 +02006419 }
6420 ++ectx.ec_stack.ga_len;
6421 }
6422
6423 // Turn varargs into a list. Empty list if no args.
6424 if (ufunc->uf_va_name != NULL)
6425 {
6426 int vararg_count = argc - ufunc->uf_args.ga_len;
6427
6428 if (vararg_count < 0)
6429 vararg_count = 0;
6430 else
6431 argc -= vararg_count;
6432 if (exe_newlist(vararg_count, &ectx) == FAIL)
6433 goto failed_early;
6434
6435 // Check the type of the list items.
6436 tv = STACK_TV_BOT(-1);
6437 if (ufunc->uf_va_type != NULL
6438 && ufunc->uf_va_type != &t_list_any
6439 && ufunc->uf_va_type->tt_member != &t_any
6440 && tv->vval.v_list != NULL)
6441 {
6442 type_T *expected = ufunc->uf_va_type->tt_member;
6443 listitem_T *li = tv->vval.v_list->lv_first;
6444
6445 for (idx = 0; idx < vararg_count; ++idx)
6446 {
6447 if (check_typval_arg_type(expected, &li->li_tv,
Bram Moolenaar7a3fe3e2021-07-22 14:58:47 +02006448 NULL, argc + idx + 1) == FAIL)
Bram Moolenaar4c137212021-04-19 16:48:48 +02006449 goto failed_early;
6450 li = li->li_next;
6451 }
6452 }
6453
6454 if (defcount > 0)
6455 // Move varargs list to below missing default arguments.
6456 *STACK_TV_BOT(defcount - 1) = *STACK_TV_BOT(-1);
6457 --ectx.ec_stack.ga_len;
6458 }
6459
6460 // Make space for omitted arguments, will store default value below.
6461 // Any varargs list goes after them.
6462 if (defcount > 0)
6463 for (idx = 0; idx < defcount; ++idx)
6464 {
6465 STACK_TV_BOT(0)->v_type = VAR_UNKNOWN;
6466 ++ectx.ec_stack.ga_len;
6467 }
6468 if (ufunc->uf_va_name != NULL)
6469 ++ectx.ec_stack.ga_len;
6470
6471 // Frame pointer points to just after arguments.
6472 ectx.ec_frame_idx = ectx.ec_stack.ga_len;
6473 ectx.ec_initial_frame_idx = ectx.ec_frame_idx;
6474
6475 {
6476 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
6477 + ufunc->uf_dfunc_idx;
6478 ufunc_T *base_ufunc = dfunc->df_ufunc;
6479
6480 // "uf_partial" is on the ufunc that "df_ufunc" points to, as is done
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01006481 // by copy_lambda_to_global_func().
Bram Moolenaar4c137212021-04-19 16:48:48 +02006482 if (partial != NULL || base_ufunc->uf_partial != NULL)
6483 {
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02006484 ectx.ec_outer_ref = ALLOC_CLEAR_ONE(outer_ref_T);
6485 if (ectx.ec_outer_ref == NULL)
Bram Moolenaar4c137212021-04-19 16:48:48 +02006486 goto failed_early;
6487 if (partial != NULL)
6488 {
Bram Moolenaar7aca5ca2022-02-07 19:56:43 +00006489 outer_T *outer = get_pt_outer(partial);
6490
Bram Moolenaar6d313be2022-09-22 16:36:25 +01006491 if (outer->out_stack == NULL && outer->out_loop_size == 0)
Bram Moolenaar4c137212021-04-19 16:48:48 +02006492 {
Bram Moolenaar6d313be2022-09-22 16:36:25 +01006493 // no stack was set
Bram Moolenaarfe1bfc92022-02-06 13:55:03 +00006494 if (current_ectx != NULL)
6495 {
6496 if (current_ectx->ec_outer_ref != NULL
6497 && current_ectx->ec_outer_ref->or_outer != NULL)
6498 ectx.ec_outer_ref->or_outer =
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02006499 current_ectx->ec_outer_ref->or_outer;
Bram Moolenaarfe1bfc92022-02-06 13:55:03 +00006500 }
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01006501 // else: should there be an error here?
Bram Moolenaar4c137212021-04-19 16:48:48 +02006502 }
6503 else
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02006504 {
Bram Moolenaar7aca5ca2022-02-07 19:56:43 +00006505 ectx.ec_outer_ref->or_outer = outer;
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02006506 ++partial->pt_refcount;
6507 ectx.ec_outer_ref->or_partial = partial;
6508 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02006509 }
6510 else
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02006511 {
6512 ectx.ec_outer_ref->or_outer = &base_ufunc->uf_partial->pt_outer;
6513 ++base_ufunc->uf_partial->pt_refcount;
6514 ectx.ec_outer_ref->or_partial = base_ufunc->uf_partial;
6515 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02006516 }
6517 }
6518
6519 // dummy frame entries
6520 for (idx = 0; idx < STACK_FRAME_SIZE; ++idx)
6521 {
6522 STACK_TV(ectx.ec_stack.ga_len)->v_type = VAR_UNKNOWN;
6523 ++ectx.ec_stack.ga_len;
6524 }
6525
6526 {
6527 // Reserve space for local variables and any closure reference count.
6528 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
6529 + ufunc->uf_dfunc_idx;
6530
Bram Moolenaar5cd64792021-12-25 18:23:24 +00006531 // Initialize variables to zero. That avoids having to generate
6532 // initializing instructions for "var nr: number", "var x: any", etc.
Bram Moolenaar4c137212021-04-19 16:48:48 +02006533 for (idx = 0; idx < dfunc->df_varcount; ++idx)
Bram Moolenaar5cd64792021-12-25 18:23:24 +00006534 {
6535 STACK_TV_VAR(idx)->v_type = VAR_NUMBER;
6536 STACK_TV_VAR(idx)->vval.v_number = 0;
6537 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02006538 ectx.ec_stack.ga_len += dfunc->df_varcount;
Bram Moolenaarffdaca92022-12-09 21:41:48 +00006539
6540 if (object != NULL)
6541 {
6542 // the object is always the variable at index zero
6543 tv = STACK_TV_VAR(0);
6544 tv->v_type = VAR_OBJECT;
6545 tv->vval.v_object = object;
6546 }
6547
Bram Moolenaar4c137212021-04-19 16:48:48 +02006548 if (dfunc->df_has_closure)
6549 {
Bram Moolenaarcc341812022-09-19 15:54:34 +01006550 // Initialize the variable that counts how many closures were
6551 // created. This is used in handle_closure_in_use().
Bram Moolenaar4c137212021-04-19 16:48:48 +02006552 STACK_TV_VAR(idx)->v_type = VAR_NUMBER;
6553 STACK_TV_VAR(idx)->vval.v_number = 0;
6554 ++ectx.ec_stack.ga_len;
6555 }
6556
6557 ectx.ec_instr = INSTRUCTIONS(dfunc);
6558 }
6559
Bram Moolenaar58779852022-09-06 18:31:14 +01006560 // Store the execution context in funccal, used by invoke_all_defer().
6561 if (funccal != NULL)
6562 funccal->fc_ectx = &ectx;
6563
Bram Moolenaar4c137212021-04-19 16:48:48 +02006564 // Following errors are in the function, not the caller.
6565 // Commands behave like vim9script.
6566 estack_push_ufunc(ufunc, 1);
6567 current_sctx = ufunc->uf_script_ctx;
6568 current_sctx.sc_version = SCRIPT_VERSION_VIM9;
6569
6570 // Use a specific location for storing error messages to be converted to an
6571 // exception.
6572 saved_msg_list = msg_list;
6573 msg_list = &private_msg_list;
6574
6575 // Do turn errors into exceptions.
6576 suppress_errthrow = FALSE;
6577
6578 // Do not delete the function while executing it.
6579 ++ufunc->uf_calls;
6580
6581 // When ":silent!" was used before calling then we still abort the
6582 // function. If ":silent!" is used in the function then we don't.
6583 emsg_silent_def = emsg_silent;
6584 did_emsg_def = 0;
6585
LemonBoyc5d27442023-08-19 13:02:35 +02006586 ectx.ec_where = (where_T)WHERE_INIT;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006587
Bram Moolenaar5800c792022-09-22 17:34:01 +01006588 /*
6589 * Execute the instructions until done.
6590 */
Bram Moolenaar4c137212021-04-19 16:48:48 +02006591 ret = exec_instructions(&ectx);
6592 if (ret == OK)
6593 {
6594 // function finished, get result from the stack.
6595 if (ufunc->uf_ret_type == &t_void)
6596 {
6597 rettv->v_type = VAR_VOID;
6598 }
6599 else
6600 {
6601 tv = STACK_TV_BOT(-1);
6602 *rettv = *tv;
6603 tv->v_type = VAR_UNKNOWN;
6604 }
6605 }
6606
Bram Moolenaar7eeefd42020-02-26 21:24:23 +01006607 // When failed need to unwind the call stack.
Bram Moolenaar58779852022-09-06 18:31:14 +01006608 unwind_def_callstack(&ectx);
Bram Moolenaarbf67ea12020-05-02 17:52:42 +02006609
Bram Moolenaarc70bdab2020-09-26 19:59:38 +02006610 // Deal with any remaining closures, they may be in use somewhere.
6611 if (ectx.ec_funcrefs.ga_len > 0)
Bram Moolenaarf112f302020-12-20 17:47:52 +01006612 {
Bram Moolenaarc70bdab2020-09-26 19:59:38 +02006613 handle_closure_in_use(&ectx, FALSE);
Bram Moolenaardc7c3662021-12-20 15:04:29 +00006614 ga_clear(&ectx.ec_funcrefs);
Bram Moolenaarf112f302020-12-20 17:47:52 +01006615 }
Bram Moolenaarc70bdab2020-09-26 19:59:38 +02006616
Bram Moolenaaree8580e2020-08-28 17:19:07 +02006617 estack_pop();
6618 current_sctx = save_current_sctx;
6619
Bram Moolenaar2336c372021-12-06 15:06:54 +00006620 if (--ufunc->uf_calls <= 0 && ufunc->uf_refcount <= 0)
6621 // Function was unreferenced while being used, free it now.
6622 func_clear_free(ufunc, FALSE);
Bram Moolenaarc970e422021-03-17 15:03:04 +01006623
Bram Moolenaar352134b2020-10-17 22:04:08 +02006624 if (*msg_list != NULL && saved_msg_list != NULL)
6625 {
6626 msglist_T **plist = saved_msg_list;
6627
6628 // Append entries from the current msg_list (uncaught exceptions) to
6629 // the saved msg_list.
6630 while (*plist != NULL)
6631 plist = &(*plist)->next;
6632
6633 *plist = *msg_list;
6634 }
6635 msg_list = saved_msg_list;
6636
Bram Moolenaar4c137212021-04-19 16:48:48 +02006637 if (ectx.ec_funclocal.floc_restore_cmdmod)
Bram Moolenaar02194d22020-10-24 23:08:38 +02006638 {
6639 cmdmod.cmod_filter_regmatch.regprog = NULL;
6640 undo_cmdmod(&cmdmod);
Bram Moolenaar4c137212021-04-19 16:48:48 +02006641 cmdmod = ectx.ec_funclocal.floc_save_cmdmod;
Bram Moolenaar02194d22020-10-24 23:08:38 +02006642 }
Bram Moolenaar56602ba2020-12-05 21:22:08 +01006643 emsg_silent_def = save_emsg_silent_def;
6644 did_emsg_def += save_did_emsg_def;
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +02006645
Bram Moolenaaree8580e2020-08-28 17:19:07 +02006646failed_early:
Bram Moolenaar0d1f55c2022-04-05 17:30:29 +01006647 // Free all arguments and local variables.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006648 for (idx = 0; idx < ectx.ec_stack.ga_len; ++idx)
Bram Moolenaar1936c762022-09-28 15:19:10 +01006649 {
6650 tv = STACK_TV(idx);
6651 if (tv->v_type != VAR_NUMBER && tv->v_type != VAR_UNKNOWN)
6652 clear_tv(tv);
6653 }
Bram Moolenaare99d4222021-06-13 14:01:26 +02006654 ex_nesting_level = orig_nesting_level;
Bram Moolenaarbf67ea12020-05-02 17:52:42 +02006655
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006656 vim_free(ectx.ec_stack.ga_data);
Bram Moolenaar20431c92020-03-20 18:39:46 +01006657 vim_free(ectx.ec_trystack.ga_data);
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02006658 if (ectx.ec_outer_ref != NULL)
Bram Moolenaar0186e582021-01-10 18:33:11 +01006659 {
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02006660 if (ectx.ec_outer_ref->or_outer_allocated)
6661 vim_free(ectx.ec_outer_ref->or_outer);
6662 partial_unref(ectx.ec_outer_ref->or_partial);
6663 vim_free(ectx.ec_outer_ref);
Bram Moolenaar0186e582021-01-10 18:33:11 +01006664 }
6665
Bram Moolenaar77e5dcc2020-09-17 21:29:03 +02006666 // Not sure if this is necessary.
6667 suppress_errthrow = save_suppress_errthrow;
6668
Bram Moolenaarb5841b92021-07-15 18:09:53 +02006669 if (ret != OK && did_emsg_cumul + did_emsg == did_emsg_before
6670 && !need_rethrow)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02006671 semsg(_(e_unknown_error_while_executing_str),
Bram Moolenaar682d0a12020-07-19 20:48:59 +02006672 printable_func_name(ufunc));
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01006673 funcdepth_restore(orig_funcdepth);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006674 return ret;
6675}
6676
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006677/*
Bram Moolenaar58779852022-09-06 18:31:14 +01006678 * Called when a def function has finished (possibly failed).
6679 * Invoke all the function returns to clean up and invoke deferred functions,
6680 * except the toplevel one.
6681 */
6682 void
6683unwind_def_callstack(ectx_T *ectx)
6684{
6685 while (ectx->ec_frame_idx != ectx->ec_initial_frame_idx)
6686 func_return(ectx);
6687}
6688
6689/*
dundargocc57b5bc2022-11-02 13:30:51 +00006690 * Invoke any deferred functions for the top function in "ectx".
Bram Moolenaar58779852022-09-06 18:31:14 +01006691 */
6692 void
6693may_invoke_defer_funcs(ectx_T *ectx)
6694{
6695 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data) + ectx->ec_dfunc_idx;
6696
6697 if (dfunc->df_defer_var_idx > 0)
6698 invoke_defer_funcs(ectx);
6699}
6700
6701/*
Bram Moolenaarcc341812022-09-19 15:54:34 +01006702 * Return loopvarinfo in a printable form in allocated memory.
6703 */
6704 static char_u *
6705printable_loopvarinfo(loopvarinfo_T *lvi)
6706{
6707 garray_T ga;
6708 int depth;
6709
6710 ga_init2(&ga, 1, 100);
6711 for (depth = 0; depth < lvi->lvi_depth; ++depth)
6712 {
6713 if (ga_grow(&ga, 50) == FAIL)
6714 break;
6715 if (lvi->lvi_loop[depth].var_idx == 0)
Bram Moolenaarc9e4a6f2022-09-19 16:08:04 +01006716 STRCPY((char *)ga.ga_data + ga.ga_len, " -");
Bram Moolenaarcc341812022-09-19 15:54:34 +01006717 else
Bram Moolenaarc9e4a6f2022-09-19 16:08:04 +01006718 vim_snprintf((char *)ga.ga_data + ga.ga_len, 50, " $%d-$%d",
Bram Moolenaarcc341812022-09-19 15:54:34 +01006719 lvi->lvi_loop[depth].var_idx,
6720 lvi->lvi_loop[depth].var_idx
6721 + lvi->lvi_loop[depth].var_count - 1);
Bram Moolenaarc9e4a6f2022-09-19 16:08:04 +01006722 ga.ga_len = (int)STRLEN(ga.ga_data);
Bram Moolenaarcc341812022-09-19 15:54:34 +01006723 }
6724 return ga.ga_data;
6725}
6726
6727/*
Bram Moolenaar4c137212021-04-19 16:48:48 +02006728 * List instructions "instr" up to "instr_count" or until ISN_FINISH.
6729 * "ufunc" has the source lines, NULL for the instructions of ISN_SUBSTITUTE.
6730 * "pfx" is prefixed to every line.
6731 */
6732 static void
6733list_instructions(char *pfx, isn_T *instr, int instr_count, ufunc_T *ufunc)
6734{
6735 int line_idx = 0;
6736 int prev_current = 0;
6737 int current;
Bram Moolenaar9ce47ec2021-04-20 22:16:39 +02006738 int def_arg_idx = 0;
Yegappan Lakshmanan16f2d3a2025-02-24 19:23:43 +01006739 sctx_T script_ctx = current_sctx;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006740
6741 for (current = 0; current < instr_count; ++current)
6742 {
6743 isn_T *iptr = &instr[current];
6744 char *line;
6745
6746 if (ufunc != NULL)
Bram Moolenaar9ce47ec2021-04-20 22:16:39 +02006747 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02006748 while (line_idx < iptr->isn_lnum
6749 && line_idx < ufunc->uf_lines.ga_len)
6750 {
6751 if (current > prev_current)
6752 {
6753 msg_puts("\n\n");
6754 prev_current = current;
6755 }
6756 line = ((char **)ufunc->uf_lines.ga_data)[line_idx++];
6757 if (line != NULL)
6758 msg(line);
6759 }
Bram Moolenaar9ce47ec2021-04-20 22:16:39 +02006760 if (iptr->isn_type == ISN_JUMP_IF_ARG_SET)
6761 {
6762 int first_def_arg = ufunc->uf_args.ga_len
6763 - ufunc->uf_def_args.ga_len;
6764
6765 if (def_arg_idx > 0)
6766 msg_puts("\n\n");
6767 msg_start();
6768 msg_puts(" ");
6769 msg_puts(((char **)(ufunc->uf_args.ga_data))[
6770 first_def_arg + def_arg_idx]);
6771 msg_puts(" = ");
6772 msg_puts(((char **)(ufunc->uf_def_args.ga_data))[def_arg_idx++]);
6773 msg_clr_eos();
6774 msg_end();
6775 }
6776 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02006777
6778 switch (iptr->isn_type)
6779 {
Bram Moolenaar00b28d62022-12-08 15:32:33 +00006780 case ISN_CONSTRUCT:
6781 smsg("%s%4d NEW %s size %d", pfx, current,
6782 iptr->isn_arg.construct.construct_class->class_name,
6783 (int)iptr->isn_arg.construct.construct_size);
6784 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006785 case ISN_EXEC:
6786 smsg("%s%4d EXEC %s", pfx, current, iptr->isn_arg.string);
6787 break;
Bram Moolenaar20677332021-06-06 17:02:53 +02006788 case ISN_EXEC_SPLIT:
6789 smsg("%s%4d EXEC_SPLIT %s", pfx, current, iptr->isn_arg.string);
6790 break;
Bram Moolenaare4eed8c2021-12-01 15:22:56 +00006791 case ISN_EXECRANGE:
6792 smsg("%s%4d EXECRANGE %s", pfx, current, iptr->isn_arg.string);
6793 break;
Bram Moolenaar3b1373b2021-05-17 00:01:42 +02006794 case ISN_LEGACY_EVAL:
6795 smsg("%s%4d EVAL legacy %s", pfx, current,
6796 iptr->isn_arg.string);
6797 break;
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02006798 case ISN_REDIRSTART:
6799 smsg("%s%4d REDIR", pfx, current);
6800 break;
6801 case ISN_REDIREND:
6802 smsg("%s%4d REDIR END%s", pfx, current,
6803 iptr->isn_arg.number ? " append" : "");
6804 break;
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02006805 case ISN_CEXPR_AUCMD:
Bram Moolenaarb7c97812021-05-05 22:51:39 +02006806#ifdef FEAT_QUICKFIX
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02006807 smsg("%s%4d CEXPR pre %s", pfx, current,
6808 cexpr_get_auname(iptr->isn_arg.number));
Bram Moolenaarb7c97812021-05-05 22:51:39 +02006809#endif
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02006810 break;
6811 case ISN_CEXPR_CORE:
Bram Moolenaarb7c97812021-05-05 22:51:39 +02006812#ifdef FEAT_QUICKFIX
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02006813 {
6814 cexprref_T *cer = iptr->isn_arg.cexpr.cexpr_ref;
6815
6816 smsg("%s%4d CEXPR core %s%s \"%s\"", pfx, current,
6817 cexpr_get_auname(cer->cer_cmdidx),
6818 cer->cer_forceit ? "!" : "",
6819 cer->cer_cmdline);
6820 }
Bram Moolenaarb7c97812021-05-05 22:51:39 +02006821#endif
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02006822 break;
Bram Moolenaarf18332f2021-05-07 17:55:55 +02006823 case ISN_INSTR:
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01006824 smsg("%s%4d INSTR", pfx, current);
6825 list_instructions(" ", iptr->isn_arg.instr, INT_MAX, NULL);
6826 msg(" -------------");
6827 break;
6828 case ISN_SOURCE:
Bram Moolenaarf18332f2021-05-07 17:55:55 +02006829 {
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01006830 scriptitem_T *si = SCRIPT_ITEM(iptr->isn_arg.number);
6831
6832 smsg("%s%4d SOURCE %s", pfx, current, si->sn_name);
Bram Moolenaarf18332f2021-05-07 17:55:55 +02006833 }
6834 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006835 case ISN_SUBSTITUTE:
6836 {
6837 subs_T *subs = &iptr->isn_arg.subs;
6838
6839 smsg("%s%4d SUBSTITUTE %s", pfx, current, subs->subs_cmd);
6840 list_instructions(" ", subs->subs_instr, INT_MAX, NULL);
6841 msg(" -------------");
6842 }
6843 break;
6844 case ISN_EXECCONCAT:
6845 smsg("%s%4d EXECCONCAT %lld", pfx, current,
6846 (varnumber_T)iptr->isn_arg.number);
6847 break;
6848 case ISN_ECHO:
6849 {
6850 echo_T *echo = &iptr->isn_arg.echo;
6851
6852 smsg("%s%4d %s %d", pfx, current,
6853 echo->echo_with_white ? "ECHO" : "ECHON",
6854 echo->echo_count);
6855 }
6856 break;
6857 case ISN_EXECUTE:
6858 smsg("%s%4d EXECUTE %lld", pfx, current,
Bram Moolenaar7de62622021-08-07 15:05:47 +02006859 (varnumber_T)(iptr->isn_arg.number));
Bram Moolenaar4c137212021-04-19 16:48:48 +02006860 break;
6861 case ISN_ECHOMSG:
6862 smsg("%s%4d ECHOMSG %lld", pfx, current,
Bram Moolenaar7de62622021-08-07 15:05:47 +02006863 (varnumber_T)(iptr->isn_arg.number));
6864 break;
Bram Moolenaar7d7ad7b2022-09-01 16:00:53 +01006865 case ISN_ECHOWINDOW:
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01006866 if (iptr->isn_arg.echowin.ewin_time > 0)
6867 smsg("%s%4d ECHOWINDOW %d (%ld sec)", pfx, current,
6868 iptr->isn_arg.echowin.ewin_count,
6869 iptr->isn_arg.echowin.ewin_time);
6870 else
6871 smsg("%s%4d ECHOWINDOW %d", pfx, current,
6872 iptr->isn_arg.echowin.ewin_count);
Bram Moolenaar7d7ad7b2022-09-01 16:00:53 +01006873 break;
Bram Moolenaar7de62622021-08-07 15:05:47 +02006874 case ISN_ECHOCONSOLE:
6875 smsg("%s%4d ECHOCONSOLE %lld", pfx, current,
6876 (varnumber_T)(iptr->isn_arg.number));
Bram Moolenaar4c137212021-04-19 16:48:48 +02006877 break;
6878 case ISN_ECHOERR:
6879 smsg("%s%4d ECHOERR %lld", pfx, current,
Bram Moolenaar7de62622021-08-07 15:05:47 +02006880 (varnumber_T)(iptr->isn_arg.number));
Bram Moolenaar4c137212021-04-19 16:48:48 +02006881 break;
6882 case ISN_LOAD:
6883 {
6884 if (iptr->isn_arg.number < 0)
6885 smsg("%s%4d LOAD arg[%lld]", pfx, current,
6886 (varnumber_T)(iptr->isn_arg.number
6887 + STACK_FRAME_SIZE));
6888 else
6889 smsg("%s%4d LOAD $%lld", pfx, current,
6890 (varnumber_T)(iptr->isn_arg.number));
6891 }
6892 break;
6893 case ISN_LOADOUTER:
6894 {
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01006895 isn_outer_T *outer = &iptr->isn_arg.outer;
6896
6897 if (outer->outer_idx < 0)
Bram Moolenaar4c137212021-04-19 16:48:48 +02006898 smsg("%s%4d LOADOUTER level %d arg[%d]", pfx, current,
Bram Moolenaarcc341812022-09-19 15:54:34 +01006899 outer->outer_depth,
6900 outer->outer_idx + STACK_FRAME_SIZE);
6901 else if (outer->outer_depth < 0)
6902 smsg("%s%4d LOADOUTER $%d in loop level %d",
6903 pfx, current,
6904 outer->outer_idx,
6905 -outer->outer_depth);
Bram Moolenaar4c137212021-04-19 16:48:48 +02006906 else
6907 smsg("%s%4d LOADOUTER level %d $%d", pfx, current,
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01006908 outer->outer_depth,
6909 outer->outer_idx);
Bram Moolenaar4c137212021-04-19 16:48:48 +02006910 }
6911 break;
6912 case ISN_LOADV:
6913 smsg("%s%4d LOADV v:%s", pfx, current,
6914 get_vim_var_name(iptr->isn_arg.number));
6915 break;
6916 case ISN_LOADSCRIPT:
6917 {
Bram Moolenaar6db660b2021-08-01 14:08:54 +02006918 scriptref_T *sref = iptr->isn_arg.script.scriptref;
6919 scriptitem_T *si = SCRIPT_ITEM(sref->sref_sid);
6920 svar_T *sv;
Yegappan Lakshmanan16f2d3a2025-02-24 19:23:43 +01006921 sctx_T save_sctx = current_sctx;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006922
Yegappan Lakshmanan16f2d3a2025-02-24 19:23:43 +01006923 current_sctx = script_ctx;
Bram Moolenaar6db660b2021-08-01 14:08:54 +02006924 sv = get_script_svar(sref, -1);
Yegappan Lakshmanan16f2d3a2025-02-24 19:23:43 +01006925 current_sctx = save_sctx;
Bram Moolenaar6db660b2021-08-01 14:08:54 +02006926 if (sv == NULL)
6927 smsg("%s%4d LOADSCRIPT [deleted] from %s",
6928 pfx, current, si->sn_name);
6929 else
6930 smsg("%s%4d LOADSCRIPT %s-%d from %s", pfx, current,
Bram Moolenaar4c137212021-04-19 16:48:48 +02006931 sv->sv_name,
6932 sref->sref_idx,
6933 si->sn_name);
6934 }
6935 break;
6936 case ISN_LOADS:
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01006937 case ISN_LOADEXPORT:
Bram Moolenaar4c137212021-04-19 16:48:48 +02006938 {
6939 scriptitem_T *si = SCRIPT_ITEM(
6940 iptr->isn_arg.loadstore.ls_sid);
6941
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01006942 smsg("%s%4d %s s:%s from %s", pfx, current,
6943 iptr->isn_type == ISN_LOADS ? "LOADS"
6944 : "LOADEXPORT",
6945 iptr->isn_arg.loadstore.ls_name, si->sn_name);
Bram Moolenaar4c137212021-04-19 16:48:48 +02006946 }
6947 break;
6948 case ISN_LOADAUTO:
6949 smsg("%s%4d LOADAUTO %s", pfx, current, iptr->isn_arg.string);
6950 break;
6951 case ISN_LOADG:
6952 smsg("%s%4d LOADG g:%s", pfx, current, iptr->isn_arg.string);
6953 break;
6954 case ISN_LOADB:
6955 smsg("%s%4d LOADB b:%s", pfx, current, iptr->isn_arg.string);
6956 break;
6957 case ISN_LOADW:
6958 smsg("%s%4d LOADW w:%s", pfx, current, iptr->isn_arg.string);
6959 break;
6960 case ISN_LOADT:
6961 smsg("%s%4d LOADT t:%s", pfx, current, iptr->isn_arg.string);
6962 break;
6963 case ISN_LOADGDICT:
6964 smsg("%s%4d LOAD g:", pfx, current);
6965 break;
6966 case ISN_LOADBDICT:
6967 smsg("%s%4d LOAD b:", pfx, current);
6968 break;
6969 case ISN_LOADWDICT:
6970 smsg("%s%4d LOAD w:", pfx, current);
6971 break;
6972 case ISN_LOADTDICT:
6973 smsg("%s%4d LOAD t:", pfx, current);
6974 break;
6975 case ISN_LOADOPT:
6976 smsg("%s%4d LOADOPT %s", pfx, current, iptr->isn_arg.string);
6977 break;
6978 case ISN_LOADENV:
6979 smsg("%s%4d LOADENV %s", pfx, current, iptr->isn_arg.string);
6980 break;
6981 case ISN_LOADREG:
Bram Moolenaar6db660b2021-08-01 14:08:54 +02006982 smsg("%s%4d LOADREG @%c", pfx, current,
6983 (int)(iptr->isn_arg.number));
Bram Moolenaar4c137212021-04-19 16:48:48 +02006984 break;
6985
6986 case ISN_STORE:
6987 if (iptr->isn_arg.number < 0)
6988 smsg("%s%4d STORE arg[%lld]", pfx, current,
6989 iptr->isn_arg.number + STACK_FRAME_SIZE);
6990 else
Bram Moolenaar6db660b2021-08-01 14:08:54 +02006991 smsg("%s%4d STORE $%lld", pfx, current,
6992 iptr->isn_arg.number);
Bram Moolenaar4c137212021-04-19 16:48:48 +02006993 break;
6994 case ISN_STOREOUTER:
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01006995 {
6996 isn_outer_T *outer = &iptr->isn_arg.outer;
6997
6998 if (outer->outer_depth == OUTER_LOOP_DEPTH)
6999 smsg("%s%4d STOREOUTER level 1 $%d in loop",
7000 pfx, current, outer->outer_idx);
7001 else
7002 smsg("%s%4d STOREOUTER level %d $%d", pfx, current,
7003 outer->outer_depth, outer->outer_idx);
7004 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02007005 break;
7006 case ISN_STOREV:
7007 smsg("%s%4d STOREV v:%s", pfx, current,
7008 get_vim_var_name(iptr->isn_arg.number));
7009 break;
7010 case ISN_STOREAUTO:
7011 smsg("%s%4d STOREAUTO %s", pfx, current, iptr->isn_arg.string);
7012 break;
7013 case ISN_STOREG:
7014 smsg("%s%4d STOREG %s", pfx, current, iptr->isn_arg.string);
7015 break;
7016 case ISN_STOREB:
7017 smsg("%s%4d STOREB %s", pfx, current, iptr->isn_arg.string);
7018 break;
7019 case ISN_STOREW:
7020 smsg("%s%4d STOREW %s", pfx, current, iptr->isn_arg.string);
7021 break;
7022 case ISN_STORET:
7023 smsg("%s%4d STORET %s", pfx, current, iptr->isn_arg.string);
7024 break;
7025 case ISN_STORES:
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01007026 case ISN_STOREEXPORT:
Bram Moolenaar4c137212021-04-19 16:48:48 +02007027 {
7028 scriptitem_T *si = SCRIPT_ITEM(
7029 iptr->isn_arg.loadstore.ls_sid);
7030
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01007031 smsg("%s%4d %s %s in %s", pfx, current,
7032 iptr->isn_type == ISN_STORES
7033 ? "STORES" : "STOREEXPORT",
Bram Moolenaar4c137212021-04-19 16:48:48 +02007034 iptr->isn_arg.loadstore.ls_name, si->sn_name);
7035 }
7036 break;
7037 case ISN_STORESCRIPT:
7038 {
Bram Moolenaar6db660b2021-08-01 14:08:54 +02007039 scriptref_T *sref = iptr->isn_arg.script.scriptref;
7040 scriptitem_T *si = SCRIPT_ITEM(sref->sref_sid);
7041 svar_T *sv;
Yegappan Lakshmanan16f2d3a2025-02-24 19:23:43 +01007042 sctx_T save_sctx = current_sctx;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007043
Yegappan Lakshmanan16f2d3a2025-02-24 19:23:43 +01007044 current_sctx = script_ctx;
Bram Moolenaar6db660b2021-08-01 14:08:54 +02007045 sv = get_script_svar(sref, -1);
Yegappan Lakshmanan16f2d3a2025-02-24 19:23:43 +01007046 current_sctx = save_sctx;
Bram Moolenaar6db660b2021-08-01 14:08:54 +02007047 if (sv == NULL)
7048 smsg("%s%4d STORESCRIPT [deleted] in %s",
7049 pfx, current, si->sn_name);
7050 else
7051 smsg("%s%4d STORESCRIPT %s-%d in %s", pfx, current,
Bram Moolenaar4c137212021-04-19 16:48:48 +02007052 sv->sv_name,
7053 sref->sref_idx,
7054 si->sn_name);
7055 }
7056 break;
7057 case ISN_STOREOPT:
Bram Moolenaardcb53be2021-12-09 14:23:43 +00007058 case ISN_STOREFUNCOPT:
7059 smsg("%s%4d %s &%s", pfx, current,
7060 iptr->isn_type == ISN_STOREOPT ? "STOREOPT" : "STOREFUNCOPT",
Bram Moolenaar4c137212021-04-19 16:48:48 +02007061 iptr->isn_arg.storeopt.so_name);
7062 break;
7063 case ISN_STOREENV:
7064 smsg("%s%4d STOREENV $%s", pfx, current, iptr->isn_arg.string);
7065 break;
7066 case ISN_STOREREG:
Bram Moolenaar6db660b2021-08-01 14:08:54 +02007067 smsg("%s%4d STOREREG @%c", pfx, current,
7068 (int)iptr->isn_arg.number);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007069 break;
7070 case ISN_STORENR:
7071 smsg("%s%4d STORE %lld in $%d", pfx, current,
7072 iptr->isn_arg.storenr.stnr_val,
7073 iptr->isn_arg.storenr.stnr_idx);
7074 break;
7075
7076 case ISN_STOREINDEX:
7077 smsg("%s%4d STOREINDEX %s", pfx, current,
Bram Moolenaarf7d1c6e2023-01-16 20:47:57 +00007078 vartype_name(iptr->isn_arg.storeindex.si_vartype));
Bram Moolenaar4c137212021-04-19 16:48:48 +02007079 break;
7080
7081 case ISN_STORERANGE:
7082 smsg("%s%4d STORERANGE", pfx, current);
7083 break;
7084
Bram Moolenaard505d172022-12-18 21:42:55 +00007085 case ISN_LOAD_CLASSMEMBER:
7086 case ISN_STORE_CLASSMEMBER:
7087 {
7088 class_T *cl = iptr->isn_arg.classmember.cm_class;
7089 int idx = iptr->isn_arg.classmember.cm_idx;
7090 ocmember_T *ocm = &cl->class_class_members[idx];
7091 smsg("%s%4d %s CLASSMEMBER %s.%s", pfx, current,
7092 iptr->isn_type == ISN_LOAD_CLASSMEMBER
7093 ? "LOAD" : "STORE",
7094 cl->class_name, ocm->ocm_name);
7095 }
7096 break;
7097
Bram Moolenaar4c137212021-04-19 16:48:48 +02007098 // constants
7099 case ISN_PUSHNR:
7100 smsg("%s%4d PUSHNR %lld", pfx, current,
7101 (varnumber_T)(iptr->isn_arg.number));
7102 break;
7103 case ISN_PUSHBOOL:
7104 case ISN_PUSHSPEC:
7105 smsg("%s%4d PUSH %s", pfx, current,
7106 get_var_special_name(iptr->isn_arg.number));
7107 break;
7108 case ISN_PUSHF:
Bram Moolenaar4c137212021-04-19 16:48:48 +02007109 smsg("%s%4d PUSHF %g", pfx, current, iptr->isn_arg.fnumber);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007110 break;
7111 case ISN_PUSHS:
7112 smsg("%s%4d PUSHS \"%s\"", pfx, current, iptr->isn_arg.string);
7113 break;
7114 case ISN_PUSHBLOB:
7115 {
7116 char_u *r;
7117 char_u numbuf[NUMBUFLEN];
7118 char_u *tofree;
7119
7120 r = blob2string(iptr->isn_arg.blob, &tofree, numbuf);
7121 smsg("%s%4d PUSHBLOB %s", pfx, current, r);
7122 vim_free(tofree);
7123 }
7124 break;
7125 case ISN_PUSHFUNC:
7126 {
7127 char *name = (char *)iptr->isn_arg.string;
7128
7129 smsg("%s%4d PUSHFUNC \"%s\"", pfx, current,
7130 name == NULL ? "[none]" : name);
7131 }
7132 break;
7133 case ISN_PUSHCHANNEL:
7134#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar397a87a2022-03-20 21:14:15 +00007135 smsg("%s%4d PUSHCHANNEL 0", pfx, current);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007136#endif
7137 break;
7138 case ISN_PUSHJOB:
7139#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar397a87a2022-03-20 21:14:15 +00007140 smsg("%s%4d PUSHJOB \"no process\"", pfx, current);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007141#endif
7142 break;
Bram Moolenaarc4e1b862023-02-26 18:58:23 +00007143 case ISN_PUSHOBJ:
7144 smsg("%s%4d PUSHOBJ null", pfx, current);
7145 break;
7146 case ISN_PUSHCLASS:
7147 smsg("%s%4d PUSHCLASS %s", pfx, current,
Bram Moolenaar30a84472023-02-27 08:07:14 +00007148 iptr->isn_arg.classarg == NULL ? "null"
7149 : (char *)iptr->isn_arg.classarg->class_name);
Bram Moolenaarc4e1b862023-02-26 18:58:23 +00007150 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007151 case ISN_PUSHEXC:
7152 smsg("%s%4d PUSH v:exception", pfx, current);
7153 break;
Bram Moolenaar06b77222022-01-25 15:51:56 +00007154 case ISN_AUTOLOAD:
7155 smsg("%s%4d AUTOLOAD %s", pfx, current, iptr->isn_arg.string);
7156 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007157 case ISN_UNLET:
7158 smsg("%s%4d UNLET%s %s", pfx, current,
7159 iptr->isn_arg.unlet.ul_forceit ? "!" : "",
7160 iptr->isn_arg.unlet.ul_name);
7161 break;
7162 case ISN_UNLETENV:
7163 smsg("%s%4d UNLETENV%s $%s", pfx, current,
7164 iptr->isn_arg.unlet.ul_forceit ? "!" : "",
7165 iptr->isn_arg.unlet.ul_name);
7166 break;
7167 case ISN_UNLETINDEX:
7168 smsg("%s%4d UNLETINDEX", pfx, current);
7169 break;
7170 case ISN_UNLETRANGE:
7171 smsg("%s%4d UNLETRANGE", pfx, current);
7172 break;
Bram Moolenaaraacc9662021-08-13 19:40:51 +02007173 case ISN_LOCKUNLOCK:
7174 smsg("%s%4d LOCKUNLOCK %s", pfx, current, iptr->isn_arg.string);
7175 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007176 case ISN_LOCKCONST:
7177 smsg("%s%4d LOCKCONST", pfx, current);
7178 break;
7179 case ISN_NEWLIST:
7180 smsg("%s%4d NEWLIST size %lld", pfx, current,
Bram Moolenaar1936c762022-09-28 15:19:10 +01007181 (varnumber_T)(iptr->isn_arg.number));
Bram Moolenaar4c137212021-04-19 16:48:48 +02007182 break;
7183 case ISN_NEWDICT:
7184 smsg("%s%4d NEWDICT size %lld", pfx, current,
Bram Moolenaar1936c762022-09-28 15:19:10 +01007185 (varnumber_T)(iptr->isn_arg.number));
Bram Moolenaar4c137212021-04-19 16:48:48 +02007186 break;
Bram Moolenaar8acb9cc2022-03-08 13:18:55 +00007187 case ISN_NEWPARTIAL:
7188 smsg("%s%4d NEWPARTIAL", pfx, current);
7189 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007190
7191 // function call
7192 case ISN_BCALL:
7193 {
7194 cbfunc_T *cbfunc = &iptr->isn_arg.bfunc;
7195
7196 smsg("%s%4d BCALL %s(argc %d)", pfx, current,
7197 internal_func_name(cbfunc->cbf_idx),
7198 cbfunc->cbf_argcount);
7199 }
7200 break;
7201 case ISN_DCALL:
7202 {
7203 cdfunc_T *cdfunc = &iptr->isn_arg.dfunc;
7204 dfunc_T *df = ((dfunc_T *)def_functions.ga_data)
7205 + cdfunc->cdf_idx;
7206
7207 smsg("%s%4d DCALL %s(argc %d)", pfx, current,
Bram Moolenaar6db660b2021-08-01 14:08:54 +02007208 printable_func_name(df->df_ufunc),
7209 cdfunc->cdf_argcount);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007210 }
7211 break;
Bram Moolenaard0200c82023-01-28 15:19:40 +00007212 case ISN_METHODCALL:
7213 {
7214 cmfunc_T *mfunc = iptr->isn_arg.mfunc;
7215
7216 smsg("%s%4d METHODCALL %s.%s(argc %d)", pfx, current,
7217 mfunc->cmf_itf->class_name,
7218 mfunc->cmf_itf->class_obj_methods[
7219 mfunc->cmf_idx]->uf_name,
7220 mfunc->cmf_argcount);
7221 }
7222 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007223 case ISN_UCALL:
7224 {
7225 cufunc_T *cufunc = &iptr->isn_arg.ufunc;
7226
7227 smsg("%s%4d UCALL %s(argc %d)", pfx, current,
7228 cufunc->cuf_name, cufunc->cuf_argcount);
7229 }
7230 break;
7231 case ISN_PCALL:
7232 {
7233 cpfunc_T *cpfunc = &iptr->isn_arg.pfunc;
7234
7235 smsg("%s%4d PCALL%s (argc %d)", pfx, current,
7236 cpfunc->cpf_top ? " top" : "", cpfunc->cpf_argcount);
7237 }
7238 break;
7239 case ISN_PCALL_END:
7240 smsg("%s%4d PCALL end", pfx, current);
7241 break;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01007242 case ISN_DEFER:
Yegappan Lakshmananf3eac692023-10-17 11:00:45 +02007243 smsg("%s%4d DEFER %d args", pfx, current,
Bram Moolenaar1d84f762022-09-03 21:35:53 +01007244 (int)iptr->isn_arg.defer.defer_argcount);
7245 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007246 case ISN_RETURN:
7247 smsg("%s%4d RETURN", pfx, current);
7248 break;
Bram Moolenaarf57b43c2021-06-15 22:13:27 +02007249 case ISN_RETURN_VOID:
7250 smsg("%s%4d RETURN void", pfx, current);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007251 break;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00007252 case ISN_RETURN_OBJECT:
7253 smsg("%s%4d RETURN object", pfx, current);
7254 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007255 case ISN_FUNCREF:
7256 {
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01007257 funcref_T *funcref = &iptr->isn_arg.funcref;
7258 funcref_extra_T *extra = funcref->fr_extra;
7259 char_u *name;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007260
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01007261 if (extra == NULL || extra->fre_func_name == NULL)
Bram Moolenaar38453522021-11-28 22:00:12 +00007262 {
7263 dfunc_T *df = ((dfunc_T *)def_functions.ga_data)
7264 + funcref->fr_dfunc_idx;
7265 name = df->df_ufunc->uf_name;
7266 }
7267 else
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01007268 name = extra->fre_func_name;
Bram Moolenaar313e4722023-02-08 20:55:27 +00007269 if (extra != NULL && extra->fre_class != NULL)
7270 {
7271 smsg("%s%4d FUNCREF %s.%s", pfx, current,
7272 extra->fre_class->class_name, name);
7273 }
7274 else if (extra == NULL
7275 || extra->fre_loopvar_info.lvi_depth == 0)
7276 {
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01007277 smsg("%s%4d FUNCREF %s", pfx, current, name);
Bram Moolenaar313e4722023-02-08 20:55:27 +00007278 }
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01007279 else
Bram Moolenaarcc341812022-09-19 15:54:34 +01007280 {
7281 char_u *info = printable_loopvarinfo(
7282 &extra->fre_loopvar_info);
7283
7284 smsg("%s%4d FUNCREF %s vars %s", pfx, current,
7285 name, info);
7286 vim_free(info);
7287 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02007288 }
7289 break;
7290
7291 case ISN_NEWFUNC:
7292 {
Bram Moolenaarcc341812022-09-19 15:54:34 +01007293 newfuncarg_T *arg = iptr->isn_arg.newfunc.nf_arg;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007294
Bram Moolenaarcc341812022-09-19 15:54:34 +01007295 if (arg->nfa_loopvar_info.lvi_depth == 0)
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01007296 smsg("%s%4d NEWFUNC %s %s", pfx, current,
7297 arg->nfa_lambda, arg->nfa_global);
7298 else
Bram Moolenaarcc341812022-09-19 15:54:34 +01007299 {
7300 char_u *info = printable_loopvarinfo(
7301 &arg->nfa_loopvar_info);
7302
7303 smsg("%s%4d NEWFUNC %s %s vars %s", pfx, current,
7304 arg->nfa_lambda, arg->nfa_global, info);
7305 vim_free(info);
7306 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02007307 }
7308 break;
7309
7310 case ISN_DEF:
7311 {
7312 char_u *name = iptr->isn_arg.string;
7313
7314 smsg("%s%4d DEF %s", pfx, current,
7315 name == NULL ? (char_u *)"" : name);
7316 }
7317 break;
7318
7319 case ISN_JUMP:
7320 {
7321 char *when = "?";
7322
7323 switch (iptr->isn_arg.jump.jump_when)
7324 {
7325 case JUMP_ALWAYS:
7326 when = "JUMP";
7327 break;
Bram Moolenaar1a7ee4d2021-09-16 16:15:07 +02007328 case JUMP_NEVER:
7329 iemsg("JUMP_NEVER should not be used");
7330 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007331 case JUMP_AND_KEEP_IF_TRUE:
7332 when = "JUMP_AND_KEEP_IF_TRUE";
7333 break;
7334 case JUMP_IF_FALSE:
7335 when = "JUMP_IF_FALSE";
7336 break;
Bram Moolenaarb46c0832022-09-15 17:19:37 +01007337 case JUMP_WHILE_FALSE:
7338 when = "JUMP_WHILE_FALSE"; // unused
7339 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007340 case JUMP_IF_COND_FALSE:
7341 when = "JUMP_IF_COND_FALSE";
7342 break;
7343 case JUMP_IF_COND_TRUE:
7344 when = "JUMP_IF_COND_TRUE";
7345 break;
7346 }
7347 smsg("%s%4d %s -> %d", pfx, current, when,
7348 iptr->isn_arg.jump.jump_where);
7349 }
7350 break;
7351
7352 case ISN_JUMP_IF_ARG_SET:
7353 smsg("%s%4d JUMP_IF_ARG_SET arg[%d] -> %d", pfx, current,
7354 iptr->isn_arg.jumparg.jump_arg_off + STACK_FRAME_SIZE,
7355 iptr->isn_arg.jump.jump_where);
7356 break;
7357
Bram Moolenaar65b0d162022-12-13 18:43:22 +00007358 case ISN_JUMP_IF_ARG_NOT_SET:
7359 smsg("%s%4d JUMP_IF_ARG_NOT_SET arg[%d] -> %d", pfx, current,
7360 iptr->isn_arg.jumparg.jump_arg_off + STACK_FRAME_SIZE,
7361 iptr->isn_arg.jump.jump_where);
7362 break;
7363
Bram Moolenaar4c137212021-04-19 16:48:48 +02007364 case ISN_FOR:
7365 {
7366 forloop_T *forloop = &iptr->isn_arg.forloop;
7367
7368 smsg("%s%4d FOR $%d -> %d", pfx, current,
Bram Moolenaarcc341812022-09-19 15:54:34 +01007369 forloop->for_loop_idx, forloop->for_end);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007370 }
7371 break;
7372
Bram Moolenaarb46c0832022-09-15 17:19:37 +01007373 case ISN_ENDLOOP:
7374 {
7375 endloop_T *endloop = &iptr->isn_arg.endloop;
7376
Bram Moolenaarcc341812022-09-19 15:54:34 +01007377 smsg("%s%4d ENDLOOP ref $%d save $%d-$%d depth %d",
7378 pfx, current,
Bram Moolenaarb46c0832022-09-15 17:19:37 +01007379 endloop->end_funcref_idx,
7380 endloop->end_var_idx,
Bram Moolenaarcc341812022-09-19 15:54:34 +01007381 endloop->end_var_idx + endloop->end_var_count - 1,
7382 endloop->end_depth);
Bram Moolenaarb46c0832022-09-15 17:19:37 +01007383 }
7384 break;
7385
7386 case ISN_WHILE:
7387 {
7388 whileloop_T *whileloop = &iptr->isn_arg.whileloop;
7389
7390 smsg("%s%4d WHILE $%d -> %d", pfx, current,
7391 whileloop->while_funcref_idx,
7392 whileloop->while_end);
7393 }
7394 break;
7395
Bram Moolenaar4c137212021-04-19 16:48:48 +02007396 case ISN_TRY:
7397 {
Bram Moolenaar0d807102021-12-21 09:42:09 +00007398 try_T *try = &iptr->isn_arg.tryref;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007399
7400 if (try->try_ref->try_finally == 0)
7401 smsg("%s%4d TRY catch -> %d, endtry -> %d",
7402 pfx, current,
7403 try->try_ref->try_catch,
7404 try->try_ref->try_endtry);
7405 else
7406 smsg("%s%4d TRY catch -> %d, finally -> %d, endtry -> %d",
7407 pfx, current,
7408 try->try_ref->try_catch,
7409 try->try_ref->try_finally,
7410 try->try_ref->try_endtry);
7411 }
7412 break;
7413 case ISN_CATCH:
Bram Moolenaar4c137212021-04-19 16:48:48 +02007414 smsg("%s%4d CATCH", pfx, current);
7415 break;
7416 case ISN_TRYCONT:
7417 {
7418 trycont_T *trycont = &iptr->isn_arg.trycont;
7419
7420 smsg("%s%4d TRY-CONTINUE %d level%s -> %d", pfx, current,
7421 trycont->tct_levels,
7422 trycont->tct_levels == 1 ? "" : "s",
7423 trycont->tct_where);
7424 }
7425 break;
7426 case ISN_FINALLY:
7427 smsg("%s%4d FINALLY", pfx, current);
7428 break;
7429 case ISN_ENDTRY:
7430 smsg("%s%4d ENDTRY", pfx, current);
7431 break;
7432 case ISN_THROW:
7433 smsg("%s%4d THROW", pfx, current);
7434 break;
7435
7436 // expression operations on number
7437 case ISN_OPNR:
7438 case ISN_OPFLOAT:
7439 case ISN_OPANY:
7440 {
7441 char *what;
7442 char *ins;
7443
7444 switch (iptr->isn_arg.op.op_type)
7445 {
7446 case EXPR_MULT: what = "*"; break;
7447 case EXPR_DIV: what = "/"; break;
7448 case EXPR_REM: what = "%"; break;
7449 case EXPR_SUB: what = "-"; break;
7450 case EXPR_ADD: what = "+"; break;
Yegappan Lakshmanana061f342022-05-22 19:13:49 +01007451 case EXPR_LSHIFT: what = "<<"; break;
7452 case EXPR_RSHIFT: what = ">>"; break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007453 default: what = "???"; break;
7454 }
7455 switch (iptr->isn_type)
7456 {
7457 case ISN_OPNR: ins = "OPNR"; break;
7458 case ISN_OPFLOAT: ins = "OPFLOAT"; break;
7459 case ISN_OPANY: ins = "OPANY"; break;
7460 default: ins = "???"; break;
7461 }
7462 smsg("%s%4d %s %s", pfx, current, ins, what);
7463 }
7464 break;
7465
7466 case ISN_COMPAREBOOL:
7467 case ISN_COMPARESPECIAL:
Bram Moolenaar7a222242022-03-01 19:23:24 +00007468 case ISN_COMPARENULL:
Bram Moolenaar4c137212021-04-19 16:48:48 +02007469 case ISN_COMPARENR:
7470 case ISN_COMPAREFLOAT:
7471 case ISN_COMPARESTRING:
7472 case ISN_COMPAREBLOB:
7473 case ISN_COMPARELIST:
7474 case ISN_COMPAREDICT:
7475 case ISN_COMPAREFUNC:
Bram Moolenaarbcf31ec2023-01-02 20:32:24 +00007476 case ISN_COMPAREOBJECT:
Bram Moolenaar4c137212021-04-19 16:48:48 +02007477 case ISN_COMPAREANY:
7478 {
7479 char *p;
7480 char buf[10];
7481 char *type;
7482
7483 switch (iptr->isn_arg.op.op_type)
7484 {
7485 case EXPR_EQUAL: p = "=="; break;
7486 case EXPR_NEQUAL: p = "!="; break;
7487 case EXPR_GREATER: p = ">"; break;
7488 case EXPR_GEQUAL: p = ">="; break;
7489 case EXPR_SMALLER: p = "<"; break;
7490 case EXPR_SEQUAL: p = "<="; break;
7491 case EXPR_MATCH: p = "=~"; break;
7492 case EXPR_IS: p = "is"; break;
7493 case EXPR_ISNOT: p = "isnot"; break;
7494 case EXPR_NOMATCH: p = "!~"; break;
7495 default: p = "???"; break;
7496 }
7497 STRCPY(buf, p);
7498 if (iptr->isn_arg.op.op_ic == TRUE)
7499 strcat(buf, "?");
7500 switch(iptr->isn_type)
7501 {
7502 case ISN_COMPAREBOOL: type = "COMPAREBOOL"; break;
7503 case ISN_COMPARESPECIAL:
7504 type = "COMPARESPECIAL"; break;
Bram Moolenaar7a222242022-03-01 19:23:24 +00007505 case ISN_COMPARENULL: type = "COMPARENULL"; break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007506 case ISN_COMPARENR: type = "COMPARENR"; break;
7507 case ISN_COMPAREFLOAT: type = "COMPAREFLOAT"; break;
7508 case ISN_COMPARESTRING:
7509 type = "COMPARESTRING"; break;
7510 case ISN_COMPAREBLOB: type = "COMPAREBLOB"; break;
7511 case ISN_COMPARELIST: type = "COMPARELIST"; break;
7512 case ISN_COMPAREDICT: type = "COMPAREDICT"; break;
7513 case ISN_COMPAREFUNC: type = "COMPAREFUNC"; break;
Bram Moolenaarbcf31ec2023-01-02 20:32:24 +00007514 case ISN_COMPAREOBJECT:
7515 type = "COMPAREOBJECT"; break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007516 case ISN_COMPAREANY: type = "COMPAREANY"; break;
7517 default: type = "???"; break;
7518 }
7519
7520 smsg("%s%4d %s %s", pfx, current, type, buf);
7521 }
7522 break;
7523
7524 case ISN_ADDLIST: smsg("%s%4d ADDLIST", pfx, current); break;
7525 case ISN_ADDBLOB: smsg("%s%4d ADDBLOB", pfx, current); break;
7526
7527 // expression operations
LemonBoy372bcce2022-04-25 12:43:20 +01007528 case ISN_CONCAT:
7529 smsg("%s%4d CONCAT size %lld", pfx, current,
7530 (varnumber_T)(iptr->isn_arg.number));
7531 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007532 case ISN_STRINDEX: smsg("%s%4d STRINDEX", pfx, current); break;
7533 case ISN_STRSLICE: smsg("%s%4d STRSLICE", pfx, current); break;
7534 case ISN_BLOBINDEX: smsg("%s%4d BLOBINDEX", pfx, current); break;
7535 case ISN_BLOBSLICE: smsg("%s%4d BLOBSLICE", pfx, current); break;
7536 case ISN_LISTAPPEND: smsg("%s%4d LISTAPPEND", pfx, current); break;
7537 case ISN_BLOBAPPEND: smsg("%s%4d BLOBAPPEND", pfx, current); break;
7538 case ISN_LISTINDEX: smsg("%s%4d LISTINDEX", pfx, current); break;
7539 case ISN_LISTSLICE: smsg("%s%4d LISTSLICE", pfx, current); break;
7540 case ISN_ANYINDEX: smsg("%s%4d ANYINDEX", pfx, current); break;
7541 case ISN_ANYSLICE: smsg("%s%4d ANYSLICE", pfx, current); break;
7542 case ISN_SLICE: smsg("%s%4d SLICE %lld",
Bram Moolenaar4f0884d2021-08-11 21:49:23 +02007543 pfx, current, iptr->isn_arg.number); break;
Bram Moolenaar035bd1c2021-06-21 19:44:11 +02007544 case ISN_GETITEM: smsg("%s%4d ITEM %lld%s", pfx, current,
7545 iptr->isn_arg.getitem.gi_index,
7546 iptr->isn_arg.getitem.gi_with_op ?
7547 " with op" : ""); break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007548 case ISN_MEMBER: smsg("%s%4d MEMBER", pfx, current); break;
7549 case ISN_STRINGMEMBER: smsg("%s%4d MEMBER %s", pfx, current,
7550 iptr->isn_arg.string); break;
Yegappan Lakshmanan5a05d372023-09-29 19:43:11 +02007551 case ISN_GET_OBJ_MEMBER: smsg("%s%4d OBJ_MEMBER %d", pfx, current,
7552 (int)iptr->isn_arg.classmember.cm_idx);
Ernie Rael00df69e2023-09-05 07:38:09 +02007553 break;
Yegappan Lakshmanan5a05d372023-09-29 19:43:11 +02007554 case ISN_GET_ITF_MEMBER: smsg("%s%4d ITF_MEMBER %d on %s",
Bram Moolenaar29ac5df2023-01-16 19:43:47 +00007555 pfx, current,
7556 (int)iptr->isn_arg.classmember.cm_idx,
Yegappan Lakshmanan5a05d372023-09-29 19:43:11 +02007557 iptr->isn_arg.classmember.cm_class->class_name);
Bram Moolenaar29ac5df2023-01-16 19:43:47 +00007558 break;
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00007559 case ISN_STORE_THIS: smsg("%s%4d STORE_THIS %d", pfx, current,
Bram Moolenaarffdaca92022-12-09 21:41:48 +00007560 (int)iptr->isn_arg.number); break;
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02007561 case ISN_CLEARDICT: smsg("%s%4d CLEARDICT", pfx, current); break;
7562 case ISN_USEDICT: smsg("%s%4d USEDICT", pfx, current); break;
7563
Bram Moolenaar4c137212021-04-19 16:48:48 +02007564 case ISN_NEGATENR: smsg("%s%4d NEGATENR", pfx, current); break;
7565
Bram Moolenaar4c137212021-04-19 16:48:48 +02007566 case ISN_CHECKTYPE:
7567 {
Bram Moolenaarbd3a9d22022-05-17 16:12:39 +01007568 checktype_T *ct = &iptr->isn_arg.type;
Bram Moolenaarc6951a72022-12-29 20:56:24 +00007569 char *tofree = NULL;
7570 char *typename;
7571
7572 if (ct->ct_type->tt_type == VAR_FLOAT
7573 && (ct->ct_type->tt_flags & TTFLAG_NUMBER_OK))
7574 typename = "float|number";
7575 else
7576 typename = type_name(ct->ct_type, &tofree);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007577
7578 if (ct->ct_arg_idx == 0)
7579 smsg("%s%4d CHECKTYPE %s stack[%d]", pfx, current,
Bram Moolenaarc6951a72022-12-29 20:56:24 +00007580 typename,
Bram Moolenaar4c137212021-04-19 16:48:48 +02007581 (int)ct->ct_off);
7582 else
Bram Moolenaarbd3a9d22022-05-17 16:12:39 +01007583 smsg("%s%4d CHECKTYPE %s stack[%d] %s %d",
Bram Moolenaar4f0884d2021-08-11 21:49:23 +02007584 pfx, current,
Bram Moolenaarc6951a72022-12-29 20:56:24 +00007585 typename,
Bram Moolenaar4c137212021-04-19 16:48:48 +02007586 (int)ct->ct_off,
Bram Moolenaarbd3a9d22022-05-17 16:12:39 +01007587 ct->ct_is_var ? "var": "arg",
Bram Moolenaar4c137212021-04-19 16:48:48 +02007588 (int)ct->ct_arg_idx);
7589 vim_free(tofree);
7590 break;
7591 }
7592 case ISN_CHECKLEN: smsg("%s%4d CHECKLEN %s%d", pfx, current,
7593 iptr->isn_arg.checklen.cl_more_OK ? ">= " : "",
7594 iptr->isn_arg.checklen.cl_min_len);
7595 break;
7596 case ISN_SETTYPE:
7597 {
7598 char *tofree;
7599
7600 smsg("%s%4d SETTYPE %s", pfx, current,
7601 type_name(iptr->isn_arg.type.ct_type, &tofree));
7602 vim_free(tofree);
7603 break;
7604 }
7605 case ISN_COND2BOOL: smsg("%s%4d COND2BOOL", pfx, current); break;
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02007606 case ISN_2BOOL: if (iptr->isn_arg.tobool.invert)
7607 smsg("%s%4d INVERT %d (!val)", pfx, current,
7608 iptr->isn_arg.tobool.offset);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007609 else
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02007610 smsg("%s%4d 2BOOL %d (!!val)", pfx, current,
7611 iptr->isn_arg.tobool.offset);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007612 break;
7613 case ISN_2STRING: smsg("%s%4d 2STRING stack[%lld]", pfx, current,
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02007614 (varnumber_T)(iptr->isn_arg.tostring.offset));
Bram Moolenaar4c137212021-04-19 16:48:48 +02007615 break;
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02007616 case ISN_2STRING_ANY: smsg("%s%4d 2STRING_ANY stack[%lld]",
7617 pfx, current,
7618 (varnumber_T)(iptr->isn_arg.tostring.offset));
Bram Moolenaar4c137212021-04-19 16:48:48 +02007619 break;
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02007620 case ISN_RANGE: smsg("%s%4d RANGE %s", pfx, current,
7621 iptr->isn_arg.string);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007622 break;
7623 case ISN_PUT:
Bram Moolenaar6ed545e2022-05-09 20:09:23 +01007624 if (iptr->isn_arg.put.put_lnum == LNUM_VARIABLE_RANGE_ABOVE)
Bram Moolenaar4c137212021-04-19 16:48:48 +02007625 smsg("%s%4d PUT %c above range",
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02007626 pfx, current, iptr->isn_arg.put.put_regname);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007627 else if (iptr->isn_arg.put.put_lnum == LNUM_VARIABLE_RANGE)
7628 smsg("%s%4d PUT %c range",
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02007629 pfx, current, iptr->isn_arg.put.put_regname);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007630 else
7631 smsg("%s%4d PUT %c %ld", pfx, current,
7632 iptr->isn_arg.put.put_regname,
7633 (long)iptr->isn_arg.put.put_lnum);
7634 break;
64-bitman250739d2025-03-16 21:10:47 +01007635 case ISN_IPUT:
7636 if (iptr->isn_arg.put.put_lnum == LNUM_VARIABLE_RANGE_ABOVE)
7637 smsg("%s%4d PUT %c above range",
7638 pfx, current, iptr->isn_arg.put.put_regname);
7639 else if (iptr->isn_arg.put.put_lnum == LNUM_VARIABLE_RANGE)
7640 smsg("%s%4d PUT %c range",
7641 pfx, current, iptr->isn_arg.put.put_regname);
7642 else
7643 smsg("%s%4d PUT %c %ld", pfx, current,
7644 iptr->isn_arg.put.put_regname,
7645 (long)iptr->isn_arg.put.put_lnum);
7646 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007647 case ISN_CMDMOD:
7648 {
7649 char_u *buf;
7650 size_t len = produce_cmdmods(
7651 NULL, iptr->isn_arg.cmdmod.cf_cmdmod, FALSE);
7652
7653 buf = alloc(len + 1);
Dominique Pelle5a9e5842021-07-24 19:32:12 +02007654 if (likely(buf != NULL))
Bram Moolenaar4c137212021-04-19 16:48:48 +02007655 {
7656 (void)produce_cmdmods(
7657 buf, iptr->isn_arg.cmdmod.cf_cmdmod, FALSE);
7658 smsg("%s%4d CMDMOD %s", pfx, current, buf);
7659 vim_free(buf);
7660 }
7661 break;
7662 }
7663 case ISN_CMDMOD_REV: smsg("%s%4d CMDMOD_REV", pfx, current); break;
7664
7665 case ISN_PROF_START:
Bram Moolenaare99d4222021-06-13 14:01:26 +02007666 smsg("%s%4d PROFILE START line %d", pfx, current,
7667 iptr->isn_lnum);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007668 break;
7669
7670 case ISN_PROF_END:
7671 smsg("%s%4d PROFILE END", pfx, current);
7672 break;
7673
Bram Moolenaare99d4222021-06-13 14:01:26 +02007674 case ISN_DEBUG:
Bram Moolenaar8cec9272021-06-23 20:20:53 +02007675 smsg("%s%4d DEBUG line %d-%d varcount %lld", pfx, current,
7676 iptr->isn_arg.debug.dbg_break_lnum + 1,
7677 iptr->isn_lnum,
7678 iptr->isn_arg.debug.dbg_var_names_len);
Bram Moolenaare99d4222021-06-13 14:01:26 +02007679 break;
7680
Bram Moolenaar4c137212021-04-19 16:48:48 +02007681 case ISN_UNPACK: smsg("%s%4d UNPACK %d%s", pfx, current,
7682 iptr->isn_arg.unpack.unp_count,
7683 iptr->isn_arg.unpack.unp_semicolon ? " semicolon" : "");
7684 break;
7685 case ISN_SHUFFLE: smsg("%s%4d SHUFFLE %d up %d", pfx, current,
7686 iptr->isn_arg.shuffle.shfl_item,
7687 iptr->isn_arg.shuffle.shfl_up);
7688 break;
7689 case ISN_DROP: smsg("%s%4d DROP", pfx, current); break;
7690
Yegappan Lakshmanan16f2d3a2025-02-24 19:23:43 +01007691 case ISN_SCRIPTCTX_SET:
7692 {
7693 int sid = iptr->isn_arg.setsctx.sc_sid;
7694 scriptitem_T *si = SCRIPT_ITEM(sid);
7695 smsg("%s%4d SCRIPTCTX_SET %s", pfx, current, si->sn_name);
7696 script_ctx = iptr->isn_arg.setsctx;
7697 }
7698 break;
7699
Bram Moolenaar4c137212021-04-19 16:48:48 +02007700 case ISN_FINISH: // End of list of instructions for ISN_SUBSTITUTE.
7701 return;
7702 }
7703
7704 out_flush(); // output one line at a time
7705 ui_breakcheck();
7706 if (got_int)
7707 break;
7708 }
7709}
7710
7711/*
Bram Moolenaar4ee9d8e2021-06-13 18:38:48 +02007712 * Handle command line completion for the :disassemble command.
7713 */
7714 void
7715set_context_in_disassemble_cmd(expand_T *xp, char_u *arg)
7716{
7717 char_u *p;
7718
7719 // Default: expand user functions, "debug" and "profile"
7720 xp->xp_context = EXPAND_DISASSEMBLE;
7721 xp->xp_pattern = arg;
7722
7723 // first argument already typed: only user function names
7724 if (*arg != NUL && *(p = skiptowhite(arg)) != NUL)
7725 {
7726 xp->xp_context = EXPAND_USER_FUNC;
7727 xp->xp_pattern = skipwhite(p);
7728 }
7729}
7730
7731/*
7732 * Function given to ExpandGeneric() to obtain the list of :disassemble
7733 * arguments.
7734 */
7735 char_u *
7736get_disassemble_argument(expand_T *xp, int idx)
7737{
7738 if (idx == 0)
7739 return (char_u *)"debug";
7740 if (idx == 1)
7741 return (char_u *)"profile";
7742 return get_user_func_name(xp, idx - 2);
7743}
7744
7745/*
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01007746 * ":disassemble".
Bram Moolenaar777770f2020-02-06 21:27:08 +01007747 * We don't really need this at runtime, but we do have tests that require it,
7748 * so always include this.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007749 */
7750 void
7751ex_disassemble(exarg_T *eap)
7752{
Bram Moolenaar21456cd2020-02-13 21:29:32 +01007753 char_u *arg = eap->arg;
Bram Moolenaar0f18b6d2020-02-02 17:22:27 +01007754 ufunc_T *ufunc;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007755 dfunc_T *dfunc;
Bram Moolenaardafef512022-05-21 21:55:55 +01007756 isn_T *instr = NULL; // init to shut up gcc warning
7757 int instr_count = 0; // init to shut up gcc warning
Bram Moolenaar5a01caa2022-05-21 18:56:58 +01007758 compiletype_T compile_type = CT_NONE;
Bram Moolenaare99d4222021-06-13 14:01:26 +02007759
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01007760 ufunc = find_func_by_name(arg, &compile_type);
Bram Moolenaara26b9702020-04-18 19:53:28 +02007761 if (ufunc == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007762 return;
Bram Moolenaare99d4222021-06-13 14:01:26 +02007763 if (func_needs_compiling(ufunc, compile_type)
7764 && compile_def_function(ufunc, FALSE, compile_type, NULL) == FAIL)
Bram Moolenaar822ba242020-05-24 23:00:18 +02007765 return;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02007766 if (ufunc->uf_def_status != UF_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007767 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02007768 semsg(_(e_function_is_not_compiled_str), eap->arg);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007769 return;
7770 }
Bram Moolenaar6db660b2021-08-01 14:08:54 +02007771 msg((char *)printable_func_name(ufunc));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007772
7773 dfunc = ((dfunc_T *)def_functions.ga_data) + ufunc->uf_dfunc_idx;
Bram Moolenaare99d4222021-06-13 14:01:26 +02007774 switch (compile_type)
7775 {
7776 case CT_PROFILE:
Bram Moolenaarf002a412021-01-24 13:34:18 +01007777#ifdef FEAT_PROFILE
Bram Moolenaare99d4222021-06-13 14:01:26 +02007778 instr = dfunc->df_instr_prof;
7779 instr_count = dfunc->df_instr_prof_count;
7780 break;
Bram Moolenaarf002a412021-01-24 13:34:18 +01007781#endif
Bram Moolenaare99d4222021-06-13 14:01:26 +02007782 // FALLTHROUGH
7783 case CT_NONE:
7784 instr = dfunc->df_instr;
7785 instr_count = dfunc->df_instr_count;
7786 break;
7787 case CT_DEBUG:
7788 instr = dfunc->df_instr_debug;
7789 instr_count = dfunc->df_instr_debug_count;
7790 break;
7791 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007792
Bram Moolenaar4c137212021-04-19 16:48:48 +02007793 list_instructions("", instr, instr_count, ufunc);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007794}
7795
7796/*
Bram Moolenaar13106602020-10-04 16:06:05 +02007797 * Return TRUE when "tv" is not falsy: non-zero, non-empty string, non-empty
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007798 * list, etc. Mostly like what JavaScript does, except that empty list and
7799 * empty dictionary are FALSE.
7800 */
7801 int
7802tv2bool(typval_T *tv)
7803{
7804 switch (tv->v_type)
7805 {
7806 case VAR_NUMBER:
7807 return tv->vval.v_number != 0;
7808 case VAR_FLOAT:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007809 return tv->vval.v_float != 0.0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007810 case VAR_PARTIAL:
7811 return tv->vval.v_partial != NULL;
7812 case VAR_FUNC:
7813 case VAR_STRING:
7814 return tv->vval.v_string != NULL && *tv->vval.v_string != NUL;
7815 case VAR_LIST:
7816 return tv->vval.v_list != NULL && tv->vval.v_list->lv_len > 0;
7817 case VAR_DICT:
7818 return tv->vval.v_dict != NULL
7819 && tv->vval.v_dict->dv_hashtab.ht_used > 0;
7820 case VAR_BOOL:
7821 case VAR_SPECIAL:
7822 return tv->vval.v_number == VVAL_TRUE ? TRUE : FALSE;
7823 case VAR_JOB:
7824#ifdef FEAT_JOB_CHANNEL
7825 return tv->vval.v_job != NULL;
7826#else
7827 break;
7828#endif
7829 case VAR_CHANNEL:
7830#ifdef FEAT_JOB_CHANNEL
7831 return tv->vval.v_channel != NULL;
7832#else
7833 break;
7834#endif
7835 case VAR_BLOB:
7836 return tv->vval.v_blob != NULL && tv->vval.v_blob->bv_ga.ga_len > 0;
7837 case VAR_UNKNOWN:
Bram Moolenaar4c683752020-04-05 21:38:23 +02007838 case VAR_ANY:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007839 case VAR_VOID:
Bram Moolenaarf18332f2021-05-07 17:55:55 +02007840 case VAR_INSTR:
Bram Moolenaar00b28d62022-12-08 15:32:33 +00007841 case VAR_CLASS:
7842 case VAR_OBJECT:
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02007843 case VAR_TYPEALIAS:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007844 break;
7845 }
7846 return FALSE;
7847}
7848
Bram Moolenaarea2d4072020-11-12 12:08:51 +01007849 void
7850emsg_using_string_as(typval_T *tv, int as_number)
7851{
7852 semsg(_(as_number ? e_using_string_as_number_str
7853 : e_using_string_as_bool_str),
7854 tv->vval.v_string == NULL
7855 ? (char_u *)"" : tv->vval.v_string);
7856}
7857
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007858/*
7859 * If "tv" is a string give an error and return FAIL.
7860 */
7861 int
7862check_not_string(typval_T *tv)
7863{
7864 if (tv->v_type == VAR_STRING)
7865 {
Bram Moolenaarea2d4072020-11-12 12:08:51 +01007866 emsg_using_string_as(tv, TRUE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007867 clear_tv(tv);
7868 return FAIL;
7869 }
7870 return OK;
7871}
7872
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007873#endif // FEAT_EVAL