blob: de12d8e6a6caa5e61451254a942fc43103c596c3 [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
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002464 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 Lakshmanan56d45f12024-11-11 19:58:55 +01003165 * Accessing the member of an object stored in a variable of type "any".
3166 * Returns OK if the member variable is present.
3167 * Returns FAIL if the variable is not found.
3168 */
3169 static int
3170any_var_get_obj_member(class_T *current_class, isn_T *iptr, typval_T *tv)
3171{
3172 object_T *obj = tv->vval.v_object;
3173 typval_T mtv;
3174
3175 if (obj == NULL)
3176 {
3177 SOURCING_LNUM = iptr->isn_lnum;
3178 emsg(_(e_using_null_object));
3179 return FAIL;
3180 }
3181
3182 // get_member_tv() needs the object information in the typval argument.
3183 // So set the object information.
3184 copy_tv(tv, &mtv);
3185
3186 // 'name' can either be a object variable or a object method
Yegappan Lakshmanan084529c2024-12-24 09:50:01 +01003187 int namelen = (int)STRLEN(iptr->isn_arg.string);
Yegappan Lakshmanan56d45f12024-11-11 19:58:55 +01003188 int save_did_emsg = did_emsg;
3189
3190 if (get_member_tv(obj->obj_class, TRUE, iptr->isn_arg.string, namelen,
3191 current_class, &mtv) == OK)
3192 {
3193 copy_tv(&mtv, tv);
3194 clear_tv(&mtv);
3195 return OK;
3196 }
3197
3198 if (did_emsg != save_did_emsg)
3199 return FAIL;
3200
3201 // could be a member function
3202 ufunc_T *obj_method;
3203 int obj_method_idx;
3204
3205 obj_method = method_lookup(obj->obj_class, VAR_OBJECT,
3206 iptr->isn_arg.string, namelen,
3207 &obj_method_idx);
3208 if (obj_method == NULL)
3209 {
3210 SOURCING_LNUM = iptr->isn_lnum;
3211 semsg(_(e_variable_not_found_on_object_str_str), iptr->isn_arg.string,
3212 obj->obj_class->class_name);
3213 return FAIL;
3214 }
3215
3216 // Protected methods are not accessible outside the class
3217 if (*obj_method->uf_name == '_'
3218 && !class_instance_of(current_class, obj->obj_class))
3219 {
3220 semsg(_(e_cannot_access_protected_method_str), obj_method->uf_name);
3221 return FAIL;
3222 }
3223
3224 // Create a partial for the member function
3225 if (obj_method_to_partial_tv(obj, obj_method, tv) == FAIL)
3226 return FAIL;
3227
3228 return OK;
3229}
3230
3231/*
Bram Moolenaar4c137212021-04-19 16:48:48 +02003232 * Execute instructions in execution context "ectx".
3233 * Return OK or FAIL;
3234 */
3235 static int
3236exec_instructions(ectx_T *ectx)
3237{
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003238 int ret = FAIL;
3239 int save_trylevel_at_start = ectx->ec_trylevel_at_start;
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02003240 int dict_stack_len_at_start = dict_stack.ga_len;
Bram Moolenaarf785aa12021-02-11 21:19:34 +01003241
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +02003242 // Start execution at the first instruction.
Bram Moolenaar4c137212021-04-19 16:48:48 +02003243 ectx->ec_iidx = 0;
Bram Moolenaar170fcfc2020-02-06 17:51:35 +01003244
Bram Moolenaarff652882021-05-16 15:24:49 +02003245 // Only catch exceptions in this instruction list.
3246 ectx->ec_trylevel_at_start = trylevel;
3247
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003248 for (;;)
3249 {
Bram Moolenaara7490192021-07-22 12:26:14 +02003250 static int breakcheck_count = 0; // using "static" makes it faster
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003251 isn_T *iptr;
Bram Moolenaara7490192021-07-22 12:26:14 +02003252 typval_T *tv;
Bram Moolenaar20431c92020-03-20 18:39:46 +01003253
Dominique Pelle5a9e5842021-07-24 19:32:12 +02003254 if (unlikely(++breakcheck_count >= 100))
Bram Moolenaar270d0382020-05-15 21:42:53 +02003255 {
3256 line_breakcheck();
3257 breakcheck_count = 0;
3258 }
Dominique Pelle5a9e5842021-07-24 19:32:12 +02003259 if (unlikely(got_int))
Bram Moolenaar20431c92020-03-20 18:39:46 +01003260 {
3261 // Turn CTRL-C into an exception.
3262 got_int = FALSE;
Bram Moolenaar97acfc72020-03-22 13:44:28 +01003263 if (throw_exception("Vim:Interrupt", ET_INTERRUPT, NULL) == FAIL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003264 goto theend;
Bram Moolenaar20431c92020-03-20 18:39:46 +01003265 did_throw = TRUE;
3266 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003267
Dominique Pelle5a9e5842021-07-24 19:32:12 +02003268 if (unlikely(did_emsg && msg_list != NULL && *msg_list != NULL))
Bram Moolenaara26b9702020-04-18 19:53:28 +02003269 {
3270 // Turn an error message into an exception.
3271 did_emsg = FALSE;
3272 if (throw_exception(*msg_list, ET_ERROR, NULL) == FAIL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003273 goto theend;
Bram Moolenaara26b9702020-04-18 19:53:28 +02003274 did_throw = TRUE;
3275 *msg_list = NULL;
Bram Moolenaar3ef2e412023-04-30 18:50:48 +01003276
3277 // This exception was not caught (yet).
3278 garray_T *trystack = &ectx->ec_trystack;
3279 if (trystack->ga_len > 0)
3280 {
3281 trycmd_T *trycmd = ((trycmd_T *)trystack->ga_data)
3282 + trystack->ga_len - 1;
3283 if (trycmd->tcd_frame_idx == ectx->ec_frame_idx)
3284 trycmd->tcd_caught = FALSE;
3285 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003286 }
3287
Dominique Pelle5a9e5842021-07-24 19:32:12 +02003288 if (unlikely(did_throw))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003289 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02003290 garray_T *trystack = &ectx->ec_trystack;
Bram Moolenaar20431c92020-03-20 18:39:46 +01003291 trycmd_T *trycmd = NULL;
Bram Moolenaard3d8fee2021-06-30 19:54:43 +02003292 int index = trystack->ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003293
3294 // An exception jumps to the first catch, finally, or returns from
3295 // the current function.
Bram Moolenaard3d8fee2021-06-30 19:54:43 +02003296 while (index > 0)
3297 {
3298 trycmd = ((trycmd_T *)trystack->ga_data) + index - 1;
Bram Moolenaar3ef2e412023-04-30 18:50:48 +01003299 // 1. after :try and before :catch - jump to first :catch
3300 // 2. in :catch block - jump to :finally
3301 // 3. in :catch block and no finally - jump to :endtry
3302 if (!trycmd->tcd_in_catch || trycmd->tcd_finally_idx != 0
3303 || trycmd->tcd_frame_idx == ectx->ec_frame_idx)
Bram Moolenaard3d8fee2021-06-30 19:54:43 +02003304 break;
3305 // In the catch and finally block of this try we have to go up
3306 // one level.
3307 --index;
3308 trycmd = NULL;
3309 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02003310 if (trycmd != NULL && trycmd->tcd_frame_idx == ectx->ec_frame_idx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003311 {
Bram Moolenaar834193a2021-06-30 20:39:15 +02003312 if (trycmd->tcd_in_catch)
3313 {
Bram Moolenaar3ef2e412023-04-30 18:50:48 +01003314 if (trycmd->tcd_finally_idx > 0)
3315 {
3316 // exception inside ":catch", jump to ":finally" once
3317 ectx->ec_iidx = trycmd->tcd_finally_idx;
3318 trycmd->tcd_finally_idx = 0;
3319 }
3320 else
3321 {
3322 // exception inside ":catch" or ":finally", jump to
3323 // ":endtry"
3324 ectx->ec_iidx = trycmd->tcd_endtry_idx;
3325 }
Bram Moolenaar834193a2021-06-30 20:39:15 +02003326 }
3327 else
Bram Moolenaar3ef2e412023-04-30 18:50:48 +01003328 {
Bram Moolenaar834193a2021-06-30 20:39:15 +02003329 // jump to first ":catch"
3330 ectx->ec_iidx = trycmd->tcd_catch_idx;
Bram Moolenaar3ef2e412023-04-30 18:50:48 +01003331 trycmd->tcd_in_catch = TRUE;
3332 }
Bram Moolenaard3d8fee2021-06-30 19:54:43 +02003333 did_throw = FALSE; // don't come back here until :endtry
3334 trycmd->tcd_did_throw = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003335 }
3336 else
3337 {
Bram Moolenaar3ef2e412023-04-30 18:50:48 +01003338 // Not inside try or need to return from current function.
Bram Moolenaarcdd70f02020-08-13 21:40:18 +02003339 // Push a dummy return value.
Bram Moolenaar35578162021-08-02 19:10:38 +02003340 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003341 goto theend;
Bram Moolenaarcdd70f02020-08-13 21:40:18 +02003342 tv = STACK_TV_BOT(0);
3343 tv->v_type = VAR_NUMBER;
3344 tv->vval.v_number = 0;
Bram Moolenaar4c137212021-04-19 16:48:48 +02003345 ++ectx->ec_stack.ga_len;
3346 if (ectx->ec_frame_idx == ectx->ec_initial_frame_idx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003347 {
Bram Moolenaarcdd70f02020-08-13 21:40:18 +02003348 // At the toplevel we are done.
Bram Moolenaar257cc5e2020-02-19 17:06:11 +01003349 need_rethrow = TRUE;
Bram Moolenaar4c137212021-04-19 16:48:48 +02003350 if (handle_closure_in_use(ectx, FALSE) == FAIL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003351 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003352 goto done;
3353 }
3354
Bram Moolenaar4c137212021-04-19 16:48:48 +02003355 if (func_return(ectx) == FAIL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003356 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003357 }
3358 continue;
3359 }
3360
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00003361 /*
3362 * Big switch on the instruction. Most compilers will be turning this
3363 * into an efficient lookup table, since the "case" values are an enum
3364 * with sequential numbers. It may look ugly, but it should be the
3365 * most efficient way.
3366 */
Bram Moolenaar4c137212021-04-19 16:48:48 +02003367 iptr = &ectx->ec_instr[ectx->ec_iidx++];
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003368 switch (iptr->isn_type)
3369 {
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00003370 // Constructor, first instruction in a new() method.
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003371 case ISN_CONSTRUCT:
3372 // "this" is always the local variable at index zero
3373 tv = STACK_TV_VAR(0);
3374 tv->v_type = VAR_OBJECT;
3375 tv->vval.v_object = alloc_clear(
3376 iptr->isn_arg.construct.construct_size);
3377 tv->vval.v_object->obj_class =
3378 iptr->isn_arg.construct.construct_class;
Bram Moolenaard28d7b92022-12-08 20:42:00 +00003379 ++tv->vval.v_object->obj_class->class_refcount;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003380 tv->vval.v_object->obj_refcount = 1;
Bram Moolenaard28d7b92022-12-08 20:42:00 +00003381 object_created(tv->vval.v_object);
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01003382
3383 // When creating an enum value object, initialize the name and
3384 // ordinal object variables.
3385 class_T *en = tv->vval.v_object->obj_class;
3386 if (IS_ENUM(en))
3387 enum_set_internal_obj_vars(en, tv->vval.v_object);
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003388 break;
3389
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003390 // execute Ex command line
3391 case ISN_EXEC:
Ernie Raelee865f32023-09-29 19:53:55 +02003392 if (exec_command(iptr, iptr->isn_arg.string) == FAIL)
Bram Moolenaaraacc9662021-08-13 19:40:51 +02003393 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003394 break;
3395
Bram Moolenaar20677332021-06-06 17:02:53 +02003396 // execute Ex command line split at NL characters.
3397 case ISN_EXEC_SPLIT:
3398 {
3399 source_cookie_T cookie;
Bram Moolenaar518df272021-06-06 17:34:13 +02003400 char_u *line;
Bram Moolenaar20677332021-06-06 17:02:53 +02003401
3402 SOURCING_LNUM = iptr->isn_lnum;
3403 CLEAR_FIELD(cookie);
3404 cookie.sourcing_lnum = iptr->isn_lnum - 1;
3405 cookie.nextline = iptr->isn_arg.string;
Bram Moolenaar518df272021-06-06 17:34:13 +02003406 line = get_split_sourceline(0, &cookie, 0, 0);
3407 if (do_cmdline(line,
Bram Moolenaar20677332021-06-06 17:02:53 +02003408 get_split_sourceline, &cookie,
3409 DOCMD_VERBOSE|DOCMD_NOWAIT|DOCMD_KEYTYPED)
3410 == FAIL
3411 || did_emsg)
Bram Moolenaar518df272021-06-06 17:34:13 +02003412 {
3413 vim_free(line);
Bram Moolenaar20677332021-06-06 17:02:53 +02003414 goto on_error;
Bram Moolenaar518df272021-06-06 17:34:13 +02003415 }
3416 vim_free(line);
Bram Moolenaar20677332021-06-06 17:02:53 +02003417 }
3418 break;
3419
Bram Moolenaare4eed8c2021-12-01 15:22:56 +00003420 // execute Ex command line that is only a range
3421 case ISN_EXECRANGE:
3422 {
3423 exarg_T ea;
3424 char *error = NULL;
3425
3426 CLEAR_FIELD(ea);
3427 ea.cmdidx = CMD_SIZE;
3428 ea.addr_type = ADDR_LINES;
3429 ea.cmd = iptr->isn_arg.string;
Bram Moolenaar0c7f2612022-02-17 19:44:07 +00003430 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaare4eed8c2021-12-01 15:22:56 +00003431 parse_cmd_address(&ea, &error, FALSE);
Bram Moolenaar01a4dcb2021-12-04 13:15:10 +00003432 if (ea.cmd == NULL)
3433 goto on_error;
Bram Moolenaar0c7f2612022-02-17 19:44:07 +00003434 // error is always NULL when using ADDR_LINES
3435 error = ex_range_without_command(&ea);
Bram Moolenaare4eed8c2021-12-01 15:22:56 +00003436 if (error != NULL)
3437 {
Bram Moolenaare4eed8c2021-12-01 15:22:56 +00003438 emsg(error);
3439 goto on_error;
3440 }
3441 }
3442 break;
3443
Bram Moolenaar3b1373b2021-05-17 00:01:42 +02003444 // Evaluate an expression with legacy syntax, push it onto the
3445 // stack.
3446 case ISN_LEGACY_EVAL:
3447 {
3448 char_u *arg = iptr->isn_arg.string;
3449 int res;
3450 int save_flags = cmdmod.cmod_flags;
3451
Bram Moolenaar35578162021-08-02 19:10:38 +02003452 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003453 goto theend;
Bram Moolenaar3b1373b2021-05-17 00:01:42 +02003454 tv = STACK_TV_BOT(0);
3455 init_tv(tv);
3456 cmdmod.cmod_flags |= CMOD_LEGACY;
3457 res = eval0(arg, tv, NULL, &EVALARG_EVALUATE);
3458 cmdmod.cmod_flags = save_flags;
3459 if (res == FAIL)
3460 goto on_error;
3461 ++ectx->ec_stack.ga_len;
3462 }
3463 break;
3464
Bram Moolenaarf18332f2021-05-07 17:55:55 +02003465 // push typeval VAR_INSTR with instructions to be executed
3466 case ISN_INSTR:
3467 {
Bram Moolenaar35578162021-08-02 19:10:38 +02003468 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003469 goto theend;
Bram Moolenaarf18332f2021-05-07 17:55:55 +02003470 tv = STACK_TV_BOT(0);
3471 tv->vval.v_instr = ALLOC_ONE(instr_T);
3472 if (tv->vval.v_instr == NULL)
3473 goto on_error;
3474 ++ectx->ec_stack.ga_len;
3475
3476 tv->v_type = VAR_INSTR;
3477 tv->vval.v_instr->instr_ectx = ectx;
3478 tv->vval.v_instr->instr_instr = iptr->isn_arg.instr;
3479 }
3480 break;
3481
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003482 case ISN_SOURCE:
3483 {
Bram Moolenaar89445512022-04-14 12:58:23 +01003484 int notused;
LemonBoy77142312022-04-15 20:50:46 +01003485
Bram Moolenaar89445512022-04-14 12:58:23 +01003486 SOURCING_LNUM = iptr->isn_lnum;
3487 if (may_load_script((int)iptr->isn_arg.number, &notused)
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003488 == FAIL)
Bram Moolenaar89445512022-04-14 12:58:23 +01003489 goto on_error;
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003490 }
3491 break;
3492
Bram Moolenaar4c137212021-04-19 16:48:48 +02003493 // execute :substitute with an expression
3494 case ISN_SUBSTITUTE:
3495 {
3496 subs_T *subs = &iptr->isn_arg.subs;
3497 source_cookie_T cookie;
3498 struct subs_expr_S *save_instr = substitute_instr;
3499 struct subs_expr_S subs_instr;
3500 int res;
3501
3502 subs_instr.subs_ectx = ectx;
3503 subs_instr.subs_instr = subs->subs_instr;
3504 subs_instr.subs_status = OK;
3505 substitute_instr = &subs_instr;
3506
3507 SOURCING_LNUM = iptr->isn_lnum;
3508 // This is very much like ISN_EXEC
3509 CLEAR_FIELD(cookie);
3510 cookie.sourcing_lnum = iptr->isn_lnum - 1;
3511 res = do_cmdline(subs->subs_cmd,
3512 getsourceline, &cookie,
3513 DOCMD_VERBOSE|DOCMD_NOWAIT|DOCMD_KEYTYPED);
3514 substitute_instr = save_instr;
3515
3516 if (res == FAIL || did_emsg
3517 || subs_instr.subs_status == FAIL)
3518 goto on_error;
3519 }
3520 break;
3521
3522 case ISN_FINISH:
3523 goto done;
3524
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02003525 case ISN_REDIRSTART:
3526 // create a dummy entry for var_redir_str()
3527 if (alloc_redir_lval() == FAIL)
3528 goto on_error;
3529
3530 // The output is stored in growarray "redir_ga" until
3531 // redirection ends.
3532 init_redir_ga();
3533 redir_vname = 1;
3534 break;
3535
3536 case ISN_REDIREND:
3537 {
3538 char_u *res = get_clear_redir_ga();
3539
3540 // End redirection, put redirected text on the stack.
3541 clear_redir_lval();
3542 redir_vname = 0;
3543
Bram Moolenaar35578162021-08-02 19:10:38 +02003544 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02003545 {
3546 vim_free(res);
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003547 goto theend;
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02003548 }
3549 tv = STACK_TV_BOT(0);
3550 tv->v_type = VAR_STRING;
3551 tv->vval.v_string = res;
3552 ++ectx->ec_stack.ga_len;
3553 }
3554 break;
3555
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02003556 case ISN_CEXPR_AUCMD:
Bram Moolenaarb7c97812021-05-05 22:51:39 +02003557#ifdef FEAT_QUICKFIX
Bram Moolenaar397a87a2022-03-20 21:14:15 +00003558 force_abort = TRUE;
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02003559 if (trigger_cexpr_autocmd(iptr->isn_arg.number) == FAIL)
3560 goto on_error;
Bram Moolenaar397a87a2022-03-20 21:14:15 +00003561 force_abort = FALSE;
Bram Moolenaarb7c97812021-05-05 22:51:39 +02003562#endif
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02003563 break;
3564
3565 case ISN_CEXPR_CORE:
Bram Moolenaarb7c97812021-05-05 22:51:39 +02003566#ifdef FEAT_QUICKFIX
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02003567 {
3568 exarg_T ea;
3569 int res;
3570
3571 CLEAR_FIELD(ea);
3572 ea.cmdidx = iptr->isn_arg.cexpr.cexpr_ref->cer_cmdidx;
3573 ea.forceit = iptr->isn_arg.cexpr.cexpr_ref->cer_forceit;
3574 ea.cmdlinep = &iptr->isn_arg.cexpr.cexpr_ref->cer_cmdline;
3575 --ectx->ec_stack.ga_len;
3576 tv = STACK_TV_BOT(0);
Bram Moolenaarbd683e32022-07-18 17:49:03 +01003577 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02003578 res = cexpr_core(&ea, tv);
3579 clear_tv(tv);
3580 if (res == FAIL)
3581 goto on_error;
3582 }
Bram Moolenaarb7c97812021-05-05 22:51:39 +02003583#endif
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02003584 break;
3585
Bram Moolenaarcfe435d2020-04-25 20:02:55 +02003586 // execute Ex command from pieces on the stack
3587 case ISN_EXECCONCAT:
3588 {
3589 int count = iptr->isn_arg.number;
Bram Moolenaar7f6f56f2020-04-30 20:21:43 +02003590 size_t len = 0;
Bram Moolenaarcfe435d2020-04-25 20:02:55 +02003591 int pass;
3592 int i;
3593 char_u *cmd = NULL;
3594 char_u *str;
3595
3596 for (pass = 1; pass <= 2; ++pass)
3597 {
3598 for (i = 0; i < count; ++i)
3599 {
3600 tv = STACK_TV_BOT(i - count);
3601 str = tv->vval.v_string;
3602 if (str != NULL && *str != NUL)
3603 {
3604 if (pass == 2)
3605 STRCPY(cmd + len, str);
3606 len += STRLEN(str);
3607 }
3608 if (pass == 2)
3609 clear_tv(tv);
3610 }
3611 if (pass == 1)
3612 {
3613 cmd = alloc(len + 1);
Dominique Pelle5a9e5842021-07-24 19:32:12 +02003614 if (unlikely(cmd == NULL))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003615 goto theend;
Bram Moolenaarcfe435d2020-04-25 20:02:55 +02003616 len = 0;
3617 }
3618 }
3619
Bram Moolenaar6378c4f2020-04-26 13:50:41 +02003620 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaarcfe435d2020-04-25 20:02:55 +02003621 do_cmdline_cmd(cmd);
3622 vim_free(cmd);
3623 }
3624 break;
3625
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003626 // execute :echo {string} ...
3627 case ISN_ECHO:
3628 {
3629 int count = iptr->isn_arg.echo.echo_count;
3630 int atstart = TRUE;
3631 int needclr = TRUE;
Bram Moolenaar4c137212021-04-19 16:48:48 +02003632 int idx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003633
3634 for (idx = 0; idx < count; ++idx)
3635 {
3636 tv = STACK_TV_BOT(idx - count);
3637 echo_one(tv, iptr->isn_arg.echo.echo_with_white,
3638 &atstart, &needclr);
3639 clear_tv(tv);
3640 }
Bram Moolenaare0807ea2020-02-20 22:18:06 +01003641 if (needclr)
3642 msg_clr_eos();
Bram Moolenaar4c137212021-04-19 16:48:48 +02003643 ectx->ec_stack.ga_len -= count;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003644 }
3645 break;
3646
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +02003647 // :execute {string} ...
3648 // :echomsg {string} ...
Bram Moolenaar7d7ad7b2022-09-01 16:00:53 +01003649 // :echowindow {string} ...
Bram Moolenaar7de62622021-08-07 15:05:47 +02003650 // :echoconsole {string} ...
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +02003651 // :echoerr {string} ...
Bram Moolenaarad39c092020-02-26 18:23:43 +01003652 case ISN_EXECUTE:
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +02003653 case ISN_ECHOMSG:
Bram Moolenaar7d7ad7b2022-09-01 16:00:53 +01003654 case ISN_ECHOWINDOW:
Bram Moolenaar7de62622021-08-07 15:05:47 +02003655 case ISN_ECHOCONSOLE:
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +02003656 case ISN_ECHOERR:
Bram Moolenaarad39c092020-02-26 18:23:43 +01003657 {
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003658 int count;
Bram Moolenaarad39c092020-02-26 18:23:43 +01003659 garray_T ga;
3660 char_u buf[NUMBUFLEN];
3661 char_u *p;
3662 int len;
3663 int failed = FALSE;
Bram Moolenaar4c137212021-04-19 16:48:48 +02003664 int idx;
Bram Moolenaarad39c092020-02-26 18:23:43 +01003665
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003666 if (iptr->isn_type == ISN_ECHOWINDOW)
3667 count = iptr->isn_arg.echowin.ewin_count;
3668 else
3669 count = iptr->isn_arg.number;
Bram Moolenaarad39c092020-02-26 18:23:43 +01003670 ga_init2(&ga, 1, 80);
3671 for (idx = 0; idx < count; ++idx)
3672 {
3673 tv = STACK_TV_BOT(idx - count);
Bram Moolenaare5abf7a2020-08-16 18:29:35 +02003674 if (iptr->isn_type == ISN_EXECUTE)
Bram Moolenaarad39c092020-02-26 18:23:43 +01003675 {
Bram Moolenaare5abf7a2020-08-16 18:29:35 +02003676 if (tv->v_type == VAR_CHANNEL
3677 || tv->v_type == VAR_JOB)
3678 {
3679 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar68db9962021-05-09 23:19:22 +02003680 semsg(_(e_using_invalid_value_as_string_str),
3681 vartype_name(tv->v_type));
Bram Moolenaare5abf7a2020-08-16 18:29:35 +02003682 break;
3683 }
3684 else
3685 p = tv_get_string_buf(tv, buf);
Bram Moolenaarad39c092020-02-26 18:23:43 +01003686 }
3687 else
Ernie Raelbe828252024-07-26 18:37:02 +02003688 {
3689 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaare5abf7a2020-08-16 18:29:35 +02003690 p = tv_stringify(tv, buf);
Ernie Raelbe828252024-07-26 18:37:02 +02003691 }
Bram Moolenaarad39c092020-02-26 18:23:43 +01003692
3693 len = (int)STRLEN(p);
Bram Moolenaar35578162021-08-02 19:10:38 +02003694 if (GA_GROW_FAILS(&ga, len + 2))
Bram Moolenaarad39c092020-02-26 18:23:43 +01003695 failed = TRUE;
3696 else
3697 {
3698 if (ga.ga_len > 0)
3699 ((char_u *)(ga.ga_data))[ga.ga_len++] = ' ';
3700 STRCPY((char_u *)(ga.ga_data) + ga.ga_len, p);
3701 ga.ga_len += len;
3702 }
3703 clear_tv(tv);
3704 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02003705 ectx->ec_stack.ga_len -= count;
Bram Moolenaare5abf7a2020-08-16 18:29:35 +02003706 if (failed)
Bram Moolenaarc71ee822020-11-21 11:45:50 +01003707 {
3708 ga_clear(&ga);
Bram Moolenaare5abf7a2020-08-16 18:29:35 +02003709 goto on_error;
Bram Moolenaarc71ee822020-11-21 11:45:50 +01003710 }
Bram Moolenaarad39c092020-02-26 18:23:43 +01003711
Bram Moolenaare5abf7a2020-08-16 18:29:35 +02003712 if (ga.ga_data != NULL)
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +02003713 {
3714 if (iptr->isn_type == ISN_EXECUTE)
Bram Moolenaar430deb12020-08-23 16:29:11 +02003715 {
3716 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +02003717 do_cmdline_cmd((char_u *)ga.ga_data);
Bram Moolenaareeece9e2020-11-20 19:26:48 +01003718 if (did_emsg)
Bram Moolenaarc71ee822020-11-21 11:45:50 +01003719 {
3720 ga_clear(&ga);
Bram Moolenaareeece9e2020-11-20 19:26:48 +01003721 goto on_error;
Bram Moolenaarc71ee822020-11-21 11:45:50 +01003722 }
Bram Moolenaar430deb12020-08-23 16:29:11 +02003723 }
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +02003724 else
3725 {
3726 msg_sb_eol();
3727 if (iptr->isn_type == ISN_ECHOMSG)
3728 {
3729 msg_attr(ga.ga_data, echo_attr);
3730 out_flush();
3731 }
Bram Moolenaar7d7ad7b2022-09-01 16:00:53 +01003732#ifdef HAS_MESSAGE_WINDOW
3733 else if (iptr->isn_type == ISN_ECHOWINDOW)
3734 {
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003735 start_echowindow(
3736 iptr->isn_arg.echowin.ewin_time);
Bram Moolenaar7d7ad7b2022-09-01 16:00:53 +01003737 msg_attr(ga.ga_data, echo_attr);
3738 end_echowindow();
3739 }
3740#endif
Bram Moolenaar7de62622021-08-07 15:05:47 +02003741 else if (iptr->isn_type == ISN_ECHOCONSOLE)
3742 {
3743 ui_write(ga.ga_data, (int)STRLEN(ga.ga_data),
3744 TRUE);
3745 ui_write((char_u *)"\r\n", 2, TRUE);
3746 }
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +02003747 else
3748 {
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +02003749 SOURCING_LNUM = iptr->isn_lnum;
3750 emsg(ga.ga_data);
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +02003751 }
3752 }
3753 }
Bram Moolenaarad39c092020-02-26 18:23:43 +01003754 ga_clear(&ga);
3755 }
3756 break;
3757
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003758 // load local variable or argument
3759 case ISN_LOAD:
Bram Moolenaar35578162021-08-02 19:10:38 +02003760 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003761 goto theend;
Bram Moolenaar2ed57ac2023-04-01 22:05:38 +01003762 tv = STACK_TV_VAR(iptr->isn_arg.number);
3763 if (tv->v_type == VAR_UNKNOWN)
3764 {
3765 // missing argument or default value v:none
3766 STACK_TV_BOT(0)->v_type = VAR_SPECIAL;
3767 STACK_TV_BOT(0)->vval.v_number = VVAL_NONE;
3768 }
3769 else
3770 copy_tv(tv, STACK_TV_BOT(0));
Bram Moolenaar4c137212021-04-19 16:48:48 +02003771 ++ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003772 break;
3773
3774 // load v: variable
3775 case ISN_LOADV:
Bram Moolenaar35578162021-08-02 19:10:38 +02003776 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003777 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003778 copy_tv(get_vim_var_tv(iptr->isn_arg.number), STACK_TV_BOT(0));
Bram Moolenaar4c137212021-04-19 16:48:48 +02003779 ++ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003780 break;
3781
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01003782 // load s: variable in Vim9 script
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003783 case ISN_LOADSCRIPT:
3784 {
Bram Moolenaar4aab88d2020-12-24 21:56:41 +01003785 scriptref_T *sref = iptr->isn_arg.script.scriptref;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003786 svar_T *sv;
3787
Bram Moolenaar6db660b2021-08-01 14:08:54 +02003788 sv = get_script_svar(sref, ectx->ec_dfunc_idx);
Bram Moolenaar07a65d22020-12-26 20:09:15 +01003789 if (sv == NULL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003790 goto theend;
Bram Moolenaar859cc212022-03-28 15:22:35 +01003791 allocate_if_null(sv);
Bram Moolenaar35578162021-08-02 19:10:38 +02003792 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003793 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003794 copy_tv(sv->sv_tv, STACK_TV_BOT(0));
Bram Moolenaar4c137212021-04-19 16:48:48 +02003795 ++ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003796 }
3797 break;
3798
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003799 // load s: variable in old script or autoload import
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003800 case ISN_LOADS:
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003801 case ISN_LOADEXPORT:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003802 {
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003803 int sid = iptr->isn_arg.loadstore.ls_sid;
3804 hashtab_T *ht = &SCRIPT_VARS(sid);
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01003805 char_u *name = iptr->isn_arg.loadstore.ls_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003806 dictitem_T *di = find_var_in_ht(ht, 0, name, TRUE);
Bram Moolenaar0bbf7222020-02-19 22:31:48 +01003807
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003808 if (di == NULL)
3809 {
Bram Moolenaar7517ffd2020-08-14 18:35:07 +02003810 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003811 semsg(_(e_undefined_variable_str), name);
Bram Moolenaarf0b9f432020-07-17 23:03:17 +02003812 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003813 }
3814 else
3815 {
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003816 if (iptr->isn_type == ISN_LOADEXPORT)
3817 {
3818 int idx = get_script_item_idx(sid, name, 0,
3819 NULL, NULL);
3820 svar_T *sv;
3821
3822 if (idx >= 0)
3823 {
3824 sv = ((svar_T *)SCRIPT_ITEM(sid)
3825 ->sn_var_vals.ga_data) + idx;
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003826 if ((sv->sv_flags & SVFLAG_EXPORTED) == 0)
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003827 {
3828 SOURCING_LNUM = iptr->isn_lnum;
3829 semsg(_(e_item_not_exported_in_script_str),
3830 name);
3831 goto on_error;
3832 }
3833 }
3834 }
Bram Moolenaar35578162021-08-02 19:10:38 +02003835 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003836 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003837 copy_tv(&di->di_tv, STACK_TV_BOT(0));
Bram Moolenaar4c137212021-04-19 16:48:48 +02003838 ++ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003839 }
3840 }
3841 break;
3842
Bram Moolenaard3aac292020-04-19 14:32:17 +02003843 // load g:/b:/w:/t: variable
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003844 case ISN_LOADG:
Bram Moolenaard3aac292020-04-19 14:32:17 +02003845 case ISN_LOADB:
3846 case ISN_LOADW:
3847 case ISN_LOADT:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003848 {
Bram Moolenaar06b77222022-01-25 15:51:56 +00003849 int res = load_namespace_var(ectx, iptr->isn_type, iptr);
Bram Moolenaar2f8ce0a2020-07-19 19:47:35 +02003850
Bram Moolenaar06b77222022-01-25 15:51:56 +00003851 if (res == NOTDONE)
Bram Moolenaarcbbc48f2022-01-18 12:58:28 +00003852 goto theend;
Bram Moolenaar06b77222022-01-25 15:51:56 +00003853 if (res == FAIL)
Bram Moolenaarf0b9f432020-07-17 23:03:17 +02003854 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003855 }
Bram Moolenaar06b77222022-01-25 15:51:56 +00003856
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003857 break;
3858
Bram Moolenaar03290b82020-12-19 16:30:44 +01003859 // load autoload variable
3860 case ISN_LOADAUTO:
3861 {
3862 char_u *name = iptr->isn_arg.string;
3863
Bram Moolenaar35578162021-08-02 19:10:38 +02003864 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003865 goto theend;
Bram Moolenaar03290b82020-12-19 16:30:44 +01003866 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003867 if (eval_variable(name, (int)STRLEN(name), 0,
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01003868 STACK_TV_BOT(0), NULL, EVAL_VAR_VERBOSE) == FAIL)
Bram Moolenaar03290b82020-12-19 16:30:44 +01003869 goto on_error;
Bram Moolenaar4c137212021-04-19 16:48:48 +02003870 ++ectx->ec_stack.ga_len;
Bram Moolenaar03290b82020-12-19 16:30:44 +01003871 }
3872 break;
3873
Bram Moolenaar2f8ce0a2020-07-19 19:47:35 +02003874 // load g:/b:/w:/t: namespace
3875 case ISN_LOADGDICT:
3876 case ISN_LOADBDICT:
3877 case ISN_LOADWDICT:
3878 case ISN_LOADTDICT:
3879 {
3880 dict_T *d = NULL;
3881
3882 switch (iptr->isn_type)
3883 {
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003884 case ISN_LOADGDICT: d = get_globvar_dict(); break;
3885 case ISN_LOADBDICT: d = curbuf->b_vars; break;
3886 case ISN_LOADWDICT: d = curwin->w_vars; break;
3887 case ISN_LOADTDICT: d = curtab->tp_vars; break;
Bram Moolenaar2f8ce0a2020-07-19 19:47:35 +02003888 default: // Cannot reach here
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003889 goto theend;
Bram Moolenaar2f8ce0a2020-07-19 19:47:35 +02003890 }
Bram Moolenaar35578162021-08-02 19:10:38 +02003891 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003892 goto theend;
Bram Moolenaar2f8ce0a2020-07-19 19:47:35 +02003893 tv = STACK_TV_BOT(0);
3894 tv->v_type = VAR_DICT;
3895 tv->v_lock = 0;
3896 tv->vval.v_dict = d;
Bram Moolenaar1bd3cb22021-02-24 12:27:31 +01003897 ++d->dv_refcount;
Bram Moolenaar4c137212021-04-19 16:48:48 +02003898 ++ectx->ec_stack.ga_len;
Bram Moolenaar2f8ce0a2020-07-19 19:47:35 +02003899 }
3900 break;
3901
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003902 // load &option
3903 case ISN_LOADOPT:
3904 {
3905 typval_T optval;
3906 char_u *name = iptr->isn_arg.string;
3907
Bram Moolenaara8c17702020-04-01 21:17:24 +02003908 // This is not expected to fail, name is checked during
3909 // compilation: don't set SOURCING_LNUM.
Bram Moolenaar35578162021-08-02 19:10:38 +02003910 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003911 goto theend;
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02003912 if (eval_option(&name, &optval, TRUE) == FAIL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003913 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003914 *STACK_TV_BOT(0) = optval;
Bram Moolenaar4c137212021-04-19 16:48:48 +02003915 ++ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003916 }
3917 break;
3918
3919 // load $ENV
3920 case ISN_LOADENV:
3921 {
3922 typval_T optval;
3923 char_u *name = iptr->isn_arg.string;
3924
Bram Moolenaar35578162021-08-02 19:10:38 +02003925 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003926 goto theend;
Bram Moolenaar0bbf7222020-02-19 22:31:48 +01003927 // name is always valid, checked when compiling
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02003928 (void)eval_env_var(&name, &optval, TRUE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003929 *STACK_TV_BOT(0) = optval;
Bram Moolenaar4c137212021-04-19 16:48:48 +02003930 ++ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003931 }
3932 break;
3933
3934 // load @register
3935 case ISN_LOADREG:
Bram Moolenaar35578162021-08-02 19:10:38 +02003936 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003937 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003938 tv = STACK_TV_BOT(0);
3939 tv->v_type = VAR_STRING;
Bram Moolenaar2f8ce0a2020-07-19 19:47:35 +02003940 tv->v_lock = 0;
Bram Moolenaar1e021e62020-10-16 20:25:23 +02003941 // This may result in NULL, which should be equivalent to an
3942 // empty string.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003943 tv->vval.v_string = get_reg_contents(
3944 iptr->isn_arg.number, GREG_EXPR_SRC);
Bram Moolenaar4c137212021-04-19 16:48:48 +02003945 ++ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003946 break;
3947
3948 // store local variable
3949 case ISN_STORE:
Bram Moolenaar4c137212021-04-19 16:48:48 +02003950 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003951 tv = STACK_TV_VAR(iptr->isn_arg.number);
Ernie Rael9ed53752023-12-11 17:40:46 +01003952 if (check_typval_is_value(STACK_TV_BOT(0)) == FAIL)
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02003953 {
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02003954 clear_tv(STACK_TV_BOT(0));
3955 goto on_error;
3956 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003957 clear_tv(tv);
3958 *tv = *STACK_TV_BOT(0);
3959 break;
3960
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003961 // store s: variable in old script or autoload import
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01003962 case ISN_STORES:
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003963 case ISN_STOREEXPORT:
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01003964 {
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003965 int sid = iptr->isn_arg.loadstore.ls_sid;
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01003966 char_u *name = iptr->isn_arg.loadstore.ls_name;
Ernie Rael3f821d62024-04-24 20:07:50 +02003967 dictitem_T *di = NULL;
3968 // First check for a variable from an exported autoload
3969 // with an autoload_prefix; it would be in globals.
3970 if (iptr->isn_type == ISN_STOREEXPORT)
3971 di = find_var_autoload_prefix(name, sid, NULL, NULL);
3972 // Then look for a variable in the script's variables.
3973 if (di == NULL)
3974 {
3975 hashtab_T *ht = &SCRIPT_VARS(sid);
3976 di = find_var_in_ht(ht, 0, STRNCMP("s:", name, 2) == 0
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003977 ? name + 2 : name, TRUE);
Ernie Rael3f821d62024-04-24 20:07:50 +02003978 }
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01003979
Bram Moolenaar4c137212021-04-19 16:48:48 +02003980 --ectx->ec_stack.ga_len;
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003981 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar0bbf7222020-02-19 22:31:48 +01003982 if (di == NULL)
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003983 {
3984 if (iptr->isn_type == ISN_STOREEXPORT)
3985 {
3986 semsg(_(e_undefined_variable_str), name);
Bram Moolenaard1d26842022-03-31 10:13:47 +01003987 clear_tv(STACK_TV_BOT(0));
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003988 goto on_error;
3989 }
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003990 store_var(name, STACK_TV_BOT(0));
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003991 }
Bram Moolenaar0bbf7222020-02-19 22:31:48 +01003992 else
3993 {
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003994 if (iptr->isn_type == ISN_STOREEXPORT)
3995 {
3996 int idx = get_script_item_idx(sid, name, 0,
3997 NULL, NULL);
3998
Bram Moolenaar06651632022-04-27 17:54:25 +01003999 // can this ever fail?
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01004000 if (idx >= 0)
4001 {
4002 svar_T *sv = ((svar_T *)SCRIPT_ITEM(sid)
4003 ->sn_var_vals.ga_data) + idx;
4004
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01004005 if ((sv->sv_flags & SVFLAG_EXPORTED) == 0)
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01004006 {
4007 semsg(_(e_item_not_exported_in_script_str),
4008 name);
Bram Moolenaard1d26842022-03-31 10:13:47 +01004009 clear_tv(STACK_TV_BOT(0));
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01004010 goto on_error;
4011 }
4012 }
4013 }
Bram Moolenaardcf29ac2021-04-02 14:44:02 +02004014 if (var_check_permission(di, name) == FAIL)
Bram Moolenaar6e50ec22021-04-03 19:32:44 +02004015 {
4016 clear_tv(STACK_TV_BOT(0));
Bram Moolenaardcf29ac2021-04-02 14:44:02 +02004017 goto on_error;
Bram Moolenaar6e50ec22021-04-03 19:32:44 +02004018 }
Bram Moolenaar0bbf7222020-02-19 22:31:48 +01004019 clear_tv(&di->di_tv);
4020 di->di_tv = *STACK_TV_BOT(0);
4021 }
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01004022 }
4023 break;
4024
4025 // store script-local variable in Vim9 script
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004026 case ISN_STORESCRIPT:
4027 {
Bram Moolenaar07a65d22020-12-26 20:09:15 +01004028 scriptref_T *sref = iptr->isn_arg.script.scriptref;
4029 svar_T *sv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004030
Bram Moolenaar6db660b2021-08-01 14:08:54 +02004031 sv = get_script_svar(sref, ectx->ec_dfunc_idx);
Bram Moolenaar07a65d22020-12-26 20:09:15 +01004032 if (sv == NULL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004033 goto theend;
Bram Moolenaar4c137212021-04-19 16:48:48 +02004034 --ectx->ec_stack.ga_len;
Bram Moolenaarf5906aa2021-04-02 14:35:15 +02004035
4036 // "const" and "final" are checked at compile time, locking
4037 // the value needs to be checked here.
4038 SOURCING_LNUM = iptr->isn_lnum;
4039 if (value_check_lock(sv->sv_tv->v_lock, sv->sv_name, FALSE))
Bram Moolenaar6e50ec22021-04-03 19:32:44 +02004040 {
4041 clear_tv(STACK_TV_BOT(0));
Bram Moolenaarf5906aa2021-04-02 14:35:15 +02004042 goto on_error;
Bram Moolenaar6e50ec22021-04-03 19:32:44 +02004043 }
Bram Moolenaarf5906aa2021-04-02 14:35:15 +02004044
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004045 clear_tv(sv->sv_tv);
4046 *sv->sv_tv = *STACK_TV_BOT(0);
4047 }
4048 break;
4049
4050 // store option
4051 case ISN_STOREOPT:
Bram Moolenaardcb53be2021-12-09 14:23:43 +00004052 case ISN_STOREFUNCOPT:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004053 {
Bram Moolenaardcb53be2021-12-09 14:23:43 +00004054 char_u *opt_name = iptr->isn_arg.storeopt.so_name;
4055 int opt_flags = iptr->isn_arg.storeopt.so_flags;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004056 long n = 0;
4057 char_u *s = NULL;
4058 char *msg;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00004059 char_u numbuf[NUMBUFLEN];
4060 char_u *tofree = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004061
Bram Moolenaar4c137212021-04-19 16:48:48 +02004062 --ectx->ec_stack.ga_len;
LemonBoy32f34612023-09-02 21:52:05 +02004063 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004064 tv = STACK_TV_BOT(0);
4065 if (tv->v_type == VAR_STRING)
Bram Moolenaar97a2af32020-01-28 22:52:48 +01004066 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004067 s = tv->vval.v_string;
Bram Moolenaar97a2af32020-01-28 22:52:48 +01004068 if (s == NULL)
4069 s = (char_u *)"";
4070 }
Bram Moolenaardcb53be2021-12-09 14:23:43 +00004071 else if (iptr->isn_type == ISN_STOREFUNCOPT)
4072 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00004073 // If the option can be set to a function reference or
4074 // a lambda and the passed value is a function
4075 // reference, then convert it to the name (string) of
4076 // the function reference.
4077 s = tv2string(tv, &tofree, numbuf, 0);
4078 if (s == NULL || *s == NUL)
Bram Moolenaardcb53be2021-12-09 14:23:43 +00004079 {
Bram Moolenaar397a87a2022-03-20 21:14:15 +00004080 // cannot happen?
Bram Moolenaardcb53be2021-12-09 14:23:43 +00004081 clear_tv(tv);
Bram Moolenaar397a87a2022-03-20 21:14:15 +00004082 vim_free(tofree);
Bram Moolenaardcb53be2021-12-09 14:23:43 +00004083 goto on_error;
4084 }
Bram Moolenaardcb53be2021-12-09 14:23:43 +00004085 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004086 else
Bram Moolenaara6e67e42020-05-15 23:36:40 +02004087 // must be VAR_NUMBER, CHECKTYPE makes sure
4088 n = tv->vval.v_number;
Bram Moolenaardcb53be2021-12-09 14:23:43 +00004089 msg = set_option_value(opt_name, n, s, opt_flags);
Bram Moolenaare75ba262020-05-16 15:43:31 +02004090 clear_tv(tv);
Bram Moolenaar2ef91562021-12-11 16:14:07 +00004091 vim_free(tofree);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004092 if (msg != NULL)
4093 {
Bram Moolenaar7517ffd2020-08-14 18:35:07 +02004094 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004095 emsg(_(msg));
Bram Moolenaare8593122020-07-18 15:17:02 +02004096 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004097 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004098 }
4099 break;
4100
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01004101 // store $ENV
4102 case ISN_STOREENV:
Bram Moolenaar4c137212021-04-19 16:48:48 +02004103 --ectx->ec_stack.ga_len;
Bram Moolenaar20431c92020-03-20 18:39:46 +01004104 tv = STACK_TV_BOT(0);
4105 vim_setenv_ext(iptr->isn_arg.string, tv_get_string(tv));
4106 clear_tv(tv);
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01004107 break;
4108
4109 // store @r
4110 case ISN_STOREREG:
4111 {
4112 int reg = iptr->isn_arg.number;
4113
Bram Moolenaar4c137212021-04-19 16:48:48 +02004114 --ectx->ec_stack.ga_len;
Bram Moolenaar401d9ff2020-02-19 18:14:44 +01004115 tv = STACK_TV_BOT(0);
Bram Moolenaar74f4a962021-06-17 21:03:07 +02004116 write_reg_contents(reg, tv_get_string(tv), -1, FALSE);
Bram Moolenaar401d9ff2020-02-19 18:14:44 +01004117 clear_tv(tv);
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01004118 }
4119 break;
4120
4121 // store v: variable
4122 case ISN_STOREV:
Bram Moolenaar4c137212021-04-19 16:48:48 +02004123 --ectx->ec_stack.ga_len;
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01004124 if (set_vim_var_tv(iptr->isn_arg.number, STACK_TV_BOT(0))
4125 == FAIL)
Bram Moolenaare8593122020-07-18 15:17:02 +02004126 // should not happen, type is checked when compiling
4127 goto on_error;
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01004128 break;
4129
Bram Moolenaard3aac292020-04-19 14:32:17 +02004130 // store g:/b:/w:/t: variable
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004131 case ISN_STOREG:
Bram Moolenaard3aac292020-04-19 14:32:17 +02004132 case ISN_STOREB:
4133 case ISN_STOREW:
4134 case ISN_STORET:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004135 {
Bram Moolenaar3bdc90b2020-12-22 20:35:40 +01004136 dictitem_T *di;
4137 hashtab_T *ht;
4138 char_u *name = iptr->isn_arg.string + 2;
4139
Bram Moolenaard3aac292020-04-19 14:32:17 +02004140 switch (iptr->isn_type)
4141 {
4142 case ISN_STOREG:
4143 ht = get_globvar_ht();
4144 break;
4145 case ISN_STOREB:
4146 ht = &curbuf->b_vars->dv_hashtab;
4147 break;
4148 case ISN_STOREW:
4149 ht = &curwin->w_vars->dv_hashtab;
4150 break;
4151 case ISN_STORET:
4152 ht = &curtab->tp_vars->dv_hashtab;
4153 break;
4154 default: // Cannot reach here
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004155 goto theend;
Bram Moolenaard3aac292020-04-19 14:32:17 +02004156 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004157
Bram Moolenaar4c137212021-04-19 16:48:48 +02004158 --ectx->ec_stack.ga_len;
Bram Moolenaar3bdc90b2020-12-22 20:35:40 +01004159 di = find_var_in_ht(ht, 0, name, TRUE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004160 if (di == NULL)
Bram Moolenaar0bbf7222020-02-19 22:31:48 +01004161 store_var(iptr->isn_arg.string, STACK_TV_BOT(0));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004162 else
4163 {
Bram Moolenaar3bdc90b2020-12-22 20:35:40 +01004164 SOURCING_LNUM = iptr->isn_lnum;
4165 if (var_check_permission(di, name) == FAIL)
4166 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004167 clear_tv(&di->di_tv);
4168 di->di_tv = *STACK_TV_BOT(0);
4169 }
4170 }
4171 break;
4172
Bram Moolenaar03290b82020-12-19 16:30:44 +01004173 // store an autoload variable
4174 case ISN_STOREAUTO:
4175 SOURCING_LNUM = iptr->isn_lnum;
4176 set_var(iptr->isn_arg.string, STACK_TV_BOT(-1), TRUE);
4177 clear_tv(STACK_TV_BOT(-1));
Bram Moolenaar4c137212021-04-19 16:48:48 +02004178 --ectx->ec_stack.ga_len;
Bram Moolenaar03290b82020-12-19 16:30:44 +01004179 break;
4180
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004181 // store number in local variable
4182 case ISN_STORENR:
Bram Moolenaara471eea2020-03-04 22:20:26 +01004183 tv = STACK_TV_VAR(iptr->isn_arg.storenr.stnr_idx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004184 clear_tv(tv);
4185 tv->v_type = VAR_NUMBER;
Bram Moolenaara471eea2020-03-04 22:20:26 +01004186 tv->vval.v_number = iptr->isn_arg.storenr.stnr_val;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004187 break;
4188
Bram Moolenaar590162c2022-12-24 21:24:06 +00004189 // Store a value in a list, dict, blob or object variable.
Bram Moolenaar4f5e3972020-12-21 17:30:50 +01004190 case ISN_STOREINDEX:
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02004191 {
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00004192 int res = execute_storeindex(iptr, ectx);
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02004193
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00004194 if (res == FAIL)
Bram Moolenaar8e4c8c82020-08-01 15:38:38 +02004195 goto on_error;
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00004196 if (res == NOTDONE)
4197 goto theend;
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02004198 }
4199 break;
4200
Bram Moolenaarea5c8982022-02-17 14:42:02 +00004201 // store value in list or blob range
Bram Moolenaar68452172021-04-12 21:21:02 +02004202 case ISN_STORERANGE:
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00004203 if (execute_storerange(iptr, ectx) == FAIL)
4204 goto on_error;
Bram Moolenaar68452172021-04-12 21:21:02 +02004205 break;
4206
Bram Moolenaard505d172022-12-18 21:42:55 +00004207 case ISN_LOAD_CLASSMEMBER:
4208 {
4209 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
4210 goto theend;
4211 classmember_T *cm = &iptr->isn_arg.classmember;
Bram Moolenaar4e2406c2023-06-24 19:22:21 +01004212 copy_tv(cm->cm_class->class_members_tv + cm->cm_idx,
4213 STACK_TV_BOT(0));
Bram Moolenaard505d172022-12-18 21:42:55 +00004214 ++ectx->ec_stack.ga_len;
4215 }
4216 break;
4217
4218 case ISN_STORE_CLASSMEMBER:
4219 {
4220 classmember_T *cm = &iptr->isn_arg.classmember;
4221 tv = &cm->cm_class->class_members_tv[cm->cm_idx];
4222 clear_tv(tv);
4223 *tv = *STACK_TV_BOT(-1);
4224 --ectx->ec_stack.ga_len;
4225 }
4226 break;
4227
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01004228 // Load or store variable or argument from outer scope.
Bram Moolenaar0186e582021-01-10 18:33:11 +01004229 case ISN_LOADOUTER:
4230 case ISN_STOREOUTER:
4231 {
4232 int depth = iptr->isn_arg.outer.outer_depth;
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02004233 outer_T *outer = ectx->ec_outer_ref == NULL ? NULL
4234 : ectx->ec_outer_ref->or_outer;
Bram Moolenaar0186e582021-01-10 18:33:11 +01004235
4236 while (depth > 1 && outer != NULL)
4237 {
4238 outer = outer->out_up;
4239 --depth;
4240 }
4241 if (outer == NULL)
4242 {
4243 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar69c76172021-12-02 16:38:52 +00004244 if (ectx->ec_frame_idx == ectx->ec_initial_frame_idx
4245 || ectx->ec_outer_ref == NULL)
4246 // Possibly :def function called from legacy
4247 // context.
4248 emsg(_(e_closure_called_from_invalid_context));
4249 else
4250 iemsg("LOADOUTER depth more than scope levels");
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004251 goto theend;
Bram Moolenaar0186e582021-01-10 18:33:11 +01004252 }
Bram Moolenaarcc341812022-09-19 15:54:34 +01004253 if (depth < 0)
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01004254 // Variable declared in loop. May be copied if the
4255 // loop block has already ended.
Bram Moolenaarcc341812022-09-19 15:54:34 +01004256 tv = ((typval_T *)outer->out_loop[-depth - 1]
4257 .stack->ga_data)
4258 + outer->out_loop[-depth - 1].var_idx
4259 + iptr->isn_arg.outer.outer_idx;
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01004260 else
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01004261 // Variable declared in a function. May be copied if
4262 // the function has already returned.
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01004263 tv = ((typval_T *)outer->out_stack->ga_data)
4264 + outer->out_frame_idx + STACK_FRAME_SIZE
4265 + iptr->isn_arg.outer.outer_idx;
Bram Moolenaar0186e582021-01-10 18:33:11 +01004266 if (iptr->isn_type == ISN_LOADOUTER)
4267 {
Christian Brabandt5dd41d42023-12-04 22:52:23 +01004268 typval_T *copy;
Bram Moolenaar35578162021-08-02 19:10:38 +02004269 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004270 goto theend;
Christian Brabandt5dd41d42023-12-04 22:52:23 +01004271 // careful: ga_grow_inner may re-alloc the stack
4272 if (depth < 0)
4273 copy = ((typval_T *)outer->out_loop[-depth - 1]
4274 .stack->ga_data)
4275 + outer->out_loop[-depth - 1].var_idx
4276 + iptr->isn_arg.outer.outer_idx;
4277 else
4278 copy = ((typval_T *)outer->out_stack->ga_data)
4279 + outer->out_frame_idx + STACK_FRAME_SIZE
4280 + iptr->isn_arg.outer.outer_idx;
4281 // memory was freed, get tv again
4282 if (copy != tv)
4283 tv = copy;
Bram Moolenaar0186e582021-01-10 18:33:11 +01004284 copy_tv(tv, STACK_TV_BOT(0));
Bram Moolenaar4c137212021-04-19 16:48:48 +02004285 ++ectx->ec_stack.ga_len;
Bram Moolenaar0186e582021-01-10 18:33:11 +01004286 }
4287 else
4288 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02004289 --ectx->ec_stack.ga_len;
Bram Moolenaar0186e582021-01-10 18:33:11 +01004290 clear_tv(tv);
4291 *tv = *STACK_TV_BOT(0);
4292 }
4293 }
4294 break;
4295
Bram Moolenaar752fc692021-01-04 21:57:11 +01004296 // unlet item in list or dict variable
4297 case ISN_UNLETINDEX:
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00004298 if (execute_unletindex(iptr, ectx) == FAIL)
4299 goto on_error;
Bram Moolenaar752fc692021-01-04 21:57:11 +01004300 break;
4301
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01004302 // unlet range of items in list variable
4303 case ISN_UNLETRANGE:
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00004304 if (execute_unletrange(iptr, ectx) == FAIL)
4305 goto on_error;
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01004306 break;
4307
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004308 // push constant
4309 case ISN_PUSHNR:
4310 case ISN_PUSHBOOL:
4311 case ISN_PUSHSPEC:
4312 case ISN_PUSHF:
4313 case ISN_PUSHS:
4314 case ISN_PUSHBLOB:
Bram Moolenaar42a480b2020-02-29 23:23:47 +01004315 case ISN_PUSHFUNC:
Bram Moolenaar42a480b2020-02-29 23:23:47 +01004316 case ISN_PUSHCHANNEL:
4317 case ISN_PUSHJOB:
Bram Moolenaarc4e1b862023-02-26 18:58:23 +00004318 case ISN_PUSHOBJ:
4319 case ISN_PUSHCLASS:
Bram Moolenaar35578162021-08-02 19:10:38 +02004320 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004321 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004322 tv = STACK_TV_BOT(0);
Bram Moolenaar2f8ce0a2020-07-19 19:47:35 +02004323 tv->v_lock = 0;
Bram Moolenaar4c137212021-04-19 16:48:48 +02004324 ++ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004325 switch (iptr->isn_type)
4326 {
4327 case ISN_PUSHNR:
4328 tv->v_type = VAR_NUMBER;
4329 tv->vval.v_number = iptr->isn_arg.number;
4330 break;
4331 case ISN_PUSHBOOL:
4332 tv->v_type = VAR_BOOL;
4333 tv->vval.v_number = iptr->isn_arg.number;
4334 break;
4335 case ISN_PUSHSPEC:
4336 tv->v_type = VAR_SPECIAL;
4337 tv->vval.v_number = iptr->isn_arg.number;
4338 break;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004339 case ISN_PUSHF:
4340 tv->v_type = VAR_FLOAT;
4341 tv->vval.v_float = iptr->isn_arg.fnumber;
4342 break;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004343 case ISN_PUSHBLOB:
4344 blob_copy(iptr->isn_arg.blob, tv);
4345 break;
Bram Moolenaar42a480b2020-02-29 23:23:47 +01004346 case ISN_PUSHFUNC:
4347 tv->v_type = VAR_FUNC;
Bram Moolenaar087d2e12020-03-01 15:36:42 +01004348 if (iptr->isn_arg.string == NULL)
4349 tv->vval.v_string = NULL;
4350 else
4351 tv->vval.v_string =
4352 vim_strsave(iptr->isn_arg.string);
Bram Moolenaar42a480b2020-02-29 23:23:47 +01004353 break;
Bram Moolenaar42a480b2020-02-29 23:23:47 +01004354 case ISN_PUSHCHANNEL:
4355#ifdef FEAT_JOB_CHANNEL
4356 tv->v_type = VAR_CHANNEL;
Bram Moolenaar397a87a2022-03-20 21:14:15 +00004357 tv->vval.v_channel = NULL;
Bram Moolenaar42a480b2020-02-29 23:23:47 +01004358#endif
4359 break;
4360 case ISN_PUSHJOB:
4361#ifdef FEAT_JOB_CHANNEL
4362 tv->v_type = VAR_JOB;
Bram Moolenaar397a87a2022-03-20 21:14:15 +00004363 tv->vval.v_job = NULL;
Bram Moolenaar42a480b2020-02-29 23:23:47 +01004364#endif
4365 break;
Bram Moolenaarc4e1b862023-02-26 18:58:23 +00004366 case ISN_PUSHOBJ:
4367 tv->v_type = VAR_OBJECT;
4368 tv->vval.v_object = NULL;
4369 break;
4370 case ISN_PUSHCLASS:
4371 tv->v_type = VAR_CLASS;
Bram Moolenaar30a84472023-02-27 08:07:14 +00004372 tv->vval.v_class = iptr->isn_arg.classarg;
Bram Moolenaarc4e1b862023-02-26 18:58:23 +00004373 break;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004374 default:
4375 tv->v_type = VAR_STRING;
Bram Moolenaarf8691002022-03-10 12:20:53 +00004376 tv->vval.v_string = iptr->isn_arg.string == NULL
4377 ? NULL : vim_strsave(iptr->isn_arg.string);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004378 }
4379 break;
4380
Bram Moolenaar06b77222022-01-25 15:51:56 +00004381 case ISN_AUTOLOAD:
4382 {
4383 char_u *name = iptr->isn_arg.string;
4384
4385 (void)script_autoload(name, FALSE);
4386 if (find_func(name, TRUE))
4387 {
4388 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
4389 goto theend;
4390 tv = STACK_TV_BOT(0);
4391 tv->v_lock = 0;
4392 ++ectx->ec_stack.ga_len;
4393 tv->v_type = VAR_FUNC;
4394 tv->vval.v_string = vim_strsave(name);
4395 }
4396 else
4397 {
4398 int res = load_namespace_var(ectx, ISN_LOADG, iptr);
4399
4400 if (res == NOTDONE)
4401 goto theend;
4402 if (res == FAIL)
4403 goto on_error;
4404 }
4405 }
4406 break;
4407
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02004408 case ISN_UNLET:
4409 if (do_unlet(iptr->isn_arg.unlet.ul_name,
4410 iptr->isn_arg.unlet.ul_forceit) == FAIL)
Bram Moolenaare8593122020-07-18 15:17:02 +02004411 goto on_error;
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02004412 break;
Bram Moolenaar7bdaea62020-04-19 18:27:26 +02004413 case ISN_UNLETENV:
LemonBoy77142312022-04-15 20:50:46 +01004414 vim_unsetenv_ext(iptr->isn_arg.unlet.ul_name);
Bram Moolenaar7bdaea62020-04-19 18:27:26 +02004415 break;
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02004416
Bram Moolenaaraacc9662021-08-13 19:40:51 +02004417 case ISN_LOCKUNLOCK:
4418 {
Ernie Raelee865f32023-09-29 19:53:55 +02004419#ifdef LOG_LOCKVAR
4420 ch_log(NULL, "LKVAR: execute INS_LOCKUNLOCK isn_arg %s",
4421 iptr->isn_arg.string);
4422#endif
Ernie Rael4c8da022023-10-11 21:35:11 +02004423 lval_root_T *lval_root_save = lval_root;
Bram Moolenaaraacc9662021-08-13 19:40:51 +02004424
4425 // Stack has the local variable, argument the whole :lock
4426 // or :unlock command, like ISN_EXEC.
4427 --ectx->ec_stack.ga_len;
Zoltan Arpadffy7b12ac32024-12-29 09:50:20 +01004428 lval_root_T root;
4429 root.lr_tv = STACK_TV_BOT(0);
4430 root.lr_cl_exec = iptr->isn_arg.lockunlock.lu_cl_exec;
4431 root.lr_is_arg = iptr->isn_arg.lockunlock.lu_is_arg;
Ernie Rael64885642023-10-04 20:16:22 +02004432 lval_root = &root;
Ernie Rael4c8da022023-10-11 21:35:11 +02004433 int res = exec_command(iptr,
Ernie Rael64885642023-10-04 20:16:22 +02004434 iptr->isn_arg.lockunlock.lu_string);
4435 clear_tv(root.lr_tv);
Bram Moolenaaraacc9662021-08-13 19:40:51 +02004436 lval_root = lval_root_save;
4437 if (res == FAIL)
4438 goto on_error;
4439 }
4440 break;
4441
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +02004442 case ISN_LOCKCONST:
4443 item_lock(STACK_TV_BOT(-1), 100, TRUE, TRUE);
4444 break;
4445
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004446 // create a list from items on the stack; uses a single allocation
4447 // for the list header and the items
4448 case ISN_NEWLIST:
Bram Moolenaar4c137212021-04-19 16:48:48 +02004449 if (exe_newlist(iptr->isn_arg.number, ectx) == FAIL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004450 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004451 break;
4452
4453 // create a dict from items on the stack
4454 case ISN_NEWDICT:
4455 {
Bram Moolenaarec15b1c2022-03-27 16:29:53 +01004456 int res;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004457
Bram Moolenaarec15b1c2022-03-27 16:29:53 +01004458 SOURCING_LNUM = iptr->isn_lnum;
4459 res = exe_newdict(iptr->isn_arg.number, ectx);
4460 if (res == FAIL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004461 goto theend;
Bram Moolenaarec15b1c2022-03-27 16:29:53 +01004462 if (res == MAYBE)
4463 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004464 }
4465 break;
4466
LemonBoy372bcce2022-04-25 12:43:20 +01004467 case ISN_CONCAT:
4468 if (exe_concat(iptr->isn_arg.number, ectx) == FAIL)
4469 goto theend;
4470 break;
4471
Bram Moolenaar8acb9cc2022-03-08 13:18:55 +00004472 // create a partial with NULL value
4473 case ISN_NEWPARTIAL:
4474 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
4475 goto theend;
4476 ++ectx->ec_stack.ga_len;
4477 tv = STACK_TV_BOT(-1);
4478 tv->v_type = VAR_PARTIAL;
4479 tv->v_lock = 0;
4480 tv->vval.v_partial = NULL;
4481 break;
4482
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004483 // call a :def function
4484 case ISN_DCALL:
Bram Moolenaardfa3d552020-09-10 22:05:08 +02004485 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar2fecb532021-03-24 22:00:56 +01004486 if (call_dfunc(iptr->isn_arg.dfunc.cdf_idx,
4487 NULL,
4488 iptr->isn_arg.dfunc.cdf_argcount,
Bram Moolenaar4c137212021-04-19 16:48:48 +02004489 ectx) == FAIL)
Bram Moolenaare8593122020-07-18 15:17:02 +02004490 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004491 break;
4492
Bram Moolenaard0200c82023-01-28 15:19:40 +00004493 // call a method on an interface
4494 case ISN_METHODCALL:
4495 {
Bram Moolenaar094cf9f2023-02-10 15:52:25 +00004496 cmfunc_T *mfunc = iptr->isn_arg.mfunc;
4497
Bram Moolenaard0200c82023-01-28 15:19:40 +00004498 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar094cf9f2023-02-10 15:52:25 +00004499 tv = STACK_TV_BOT(-1 - mfunc->cmf_argcount);
Bram Moolenaard0200c82023-01-28 15:19:40 +00004500 if (tv->v_type != VAR_OBJECT)
4501 {
4502 object_required_error(tv);
4503 goto on_error;
4504 }
Ernie Raelbe828252024-07-26 18:37:02 +02004505
Bram Moolenaard0200c82023-01-28 15:19:40 +00004506 object_T *obj = tv->vval.v_object;
Ernie Raelbe828252024-07-26 18:37:02 +02004507 if (obj == NULL)
4508 {
4509 emsg(_(e_using_null_object));
4510 goto on_error;
4511 }
4512
Ernie Rael58c95792024-08-13 23:27:22 +02004513 ufunc_T *ufunc;
4514 if (mfunc->cmf_is_super)
4515 // Doing "super.Func", use the specific ufunc.
4516 ufunc = mfunc->cmf_itf->class_obj_methods[
4517 mfunc->cmf_idx];
4518 else
4519 {
4520 class_T *cl = obj->obj_class;
Bram Moolenaard0200c82023-01-28 15:19:40 +00004521
Ernie Rael58c95792024-08-13 23:27:22 +02004522 // convert the interface index to the object index
4523 int idx = object_index_from_itf_index(mfunc->cmf_itf,
4524 TRUE, mfunc->cmf_idx, cl);
4525 ufunc = cl->class_obj_methods[idx];
4526 }
Bram Moolenaard0200c82023-01-28 15:19:40 +00004527
Ernie Rael58c95792024-08-13 23:27:22 +02004528 if (call_ufunc(ufunc, NULL, mfunc->cmf_argcount, ectx,
4529 NULL, NULL) == FAIL)
Bram Moolenaard0200c82023-01-28 15:19:40 +00004530 goto on_error;
4531 }
4532 break;
4533
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004534 // call a builtin function
4535 case ISN_BCALL:
4536 SOURCING_LNUM = iptr->isn_lnum;
4537 if (call_bfunc(iptr->isn_arg.bfunc.cbf_idx,
4538 iptr->isn_arg.bfunc.cbf_argcount,
Bram Moolenaar4c137212021-04-19 16:48:48 +02004539 ectx) == FAIL)
Bram Moolenaard032f342020-07-18 18:13:02 +02004540 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004541 break;
4542
4543 // call a funcref or partial
4544 case ISN_PCALL:
4545 {
4546 cpfunc_T *pfunc = &iptr->isn_arg.pfunc;
4547 int r;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02004548 typval_T partial_tv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004549
4550 SOURCING_LNUM = iptr->isn_lnum;
4551 if (pfunc->cpf_top)
4552 {
4553 // funcref is above the arguments
4554 tv = STACK_TV_BOT(-pfunc->cpf_argcount - 1);
4555 }
4556 else
4557 {
4558 // Get the funcref from the stack.
Bram Moolenaar4c137212021-04-19 16:48:48 +02004559 --ectx->ec_stack.ga_len;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02004560 partial_tv = *STACK_TV_BOT(0);
4561 tv = &partial_tv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004562 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02004563 r = call_partial(tv, pfunc->cpf_argcount, ectx);
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02004564 if (tv == &partial_tv)
4565 clear_tv(&partial_tv);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004566 if (r == FAIL)
Bram Moolenaard032f342020-07-18 18:13:02 +02004567 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004568 }
4569 break;
4570
Bram Moolenaarbd5da372020-03-31 23:13:10 +02004571 case ISN_PCALL_END:
4572 // PCALL finished, arguments have been consumed and replaced by
4573 // the return value. Now clear the funcref from the stack,
4574 // and move the return value in its place.
Bram Moolenaar4c137212021-04-19 16:48:48 +02004575 --ectx->ec_stack.ga_len;
Bram Moolenaarbd5da372020-03-31 23:13:10 +02004576 clear_tv(STACK_TV_BOT(-1));
4577 *STACK_TV_BOT(-1) = *STACK_TV_BOT(0);
4578 break;
4579
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004580 // call a user defined function or funcref/partial
4581 case ISN_UCALL:
4582 {
4583 cufunc_T *cufunc = &iptr->isn_arg.ufunc;
4584
4585 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar2fecb532021-03-24 22:00:56 +01004586 if (call_eval_func(cufunc->cuf_name, cufunc->cuf_argcount,
Bram Moolenaar4c137212021-04-19 16:48:48 +02004587 ectx, iptr) == FAIL)
Bram Moolenaard032f342020-07-18 18:13:02 +02004588 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004589 }
4590 break;
4591
Bram Moolenaar1d84f762022-09-03 21:35:53 +01004592 // :defer func(arg)
4593 case ISN_DEFER:
Bram Moolenaar806a2732022-09-04 15:40:36 +01004594 if (defer_command(iptr->isn_arg.defer.defer_var_idx,
Bram Moolenaar1d84f762022-09-03 21:35:53 +01004595 iptr->isn_arg.defer.defer_argcount, ectx) == FAIL)
4596 goto on_error;
4597 break;
4598
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004599 // Return from a :def function call without a value.
4600 // Return from a constructor.
Bram Moolenaarf57b43c2021-06-15 22:13:27 +02004601 case ISN_RETURN_VOID:
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004602 case ISN_RETURN_OBJECT:
Bram Moolenaar35578162021-08-02 19:10:38 +02004603 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004604 goto theend;
Bram Moolenaar299f3032021-01-08 20:53:09 +01004605 tv = STACK_TV_BOT(0);
Bram Moolenaar4c137212021-04-19 16:48:48 +02004606 ++ectx->ec_stack.ga_len;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004607 if (iptr->isn_type == ISN_RETURN_VOID)
4608 {
4609 tv->v_type = VAR_VOID;
4610 tv->vval.v_number = 0;
4611 tv->v_lock = 0;
4612 }
4613 else
4614 {
4615 *tv = *STACK_TV_VAR(0);
Yegappan Lakshmanane5437c52023-12-16 14:11:19 +01004616 object_T *obj = tv->vval.v_object;
4617 ++obj->obj_refcount;
4618
4619 // Lock all the constant object variables
4620 obj_lock_const_vars(obj);
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004621 }
Bram Moolenaar299f3032021-01-08 20:53:09 +01004622 // FALLTHROUGH
4623
Bram Moolenaarf57b43c2021-06-15 22:13:27 +02004624 // return from a :def function call with what is on the stack
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004625 case ISN_RETURN:
4626 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02004627 garray_T *trystack = &ectx->ec_trystack;
Bram Moolenaar20431c92020-03-20 18:39:46 +01004628 trycmd_T *trycmd = NULL;
Bram Moolenaar8cbd6df2020-01-28 22:59:45 +01004629
Ernie Raelb077b582023-12-14 20:11:44 +01004630 ///////////////////////////////////////////////////
4631 // TODO: If FAIL, line number in output not correct
4632 ///////////////////////////////////////////////////
4633 if (check_typval_is_value(STACK_TV_BOT(-1)) == FAIL)
4634 goto theend;
4635
Bram Moolenaar8cbd6df2020-01-28 22:59:45 +01004636 if (trystack->ga_len > 0)
4637 trycmd = ((trycmd_T *)trystack->ga_data)
4638 + trystack->ga_len - 1;
Bram Moolenaarbf67ea12020-05-02 17:52:42 +02004639 if (trycmd != NULL
Bram Moolenaar4c137212021-04-19 16:48:48 +02004640 && trycmd->tcd_frame_idx == ectx->ec_frame_idx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004641 {
Bram Moolenaar9cb577a2021-02-22 22:45:10 +01004642 // jump to ":finally" or ":endtry"
4643 if (trycmd->tcd_finally_idx != 0)
Bram Moolenaar4c137212021-04-19 16:48:48 +02004644 ectx->ec_iidx = trycmd->tcd_finally_idx;
Bram Moolenaar9cb577a2021-02-22 22:45:10 +01004645 else
Bram Moolenaar4c137212021-04-19 16:48:48 +02004646 ectx->ec_iidx = trycmd->tcd_endtry_idx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004647 trycmd->tcd_return = TRUE;
4648 }
4649 else
Bram Moolenaard032f342020-07-18 18:13:02 +02004650 goto func_return;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004651 }
4652 break;
4653
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02004654 // push a partial, a reference to a compiled function
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004655 case ISN_FUNCREF:
4656 {
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01004657 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
4658 ufunc_T *ufunc;
4659 funcref_T *funcref = &iptr->isn_arg.funcref;
4660 funcref_extra_T *extra = funcref->fr_extra;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004661
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004662 if (pt == NULL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004663 goto theend;
Bram Moolenaar35578162021-08-02 19:10:38 +02004664 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +02004665 {
Bram Moolenaarbf67ea12020-05-02 17:52:42 +02004666 vim_free(pt);
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004667 goto theend;
Bram Moolenaarbf67ea12020-05-02 17:52:42 +02004668 }
Bram Moolenaar313e4722023-02-08 20:55:27 +00004669 if (extra != NULL && extra->fre_class != NULL)
4670 {
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02004671 class_T *cl;
4672 if (extra->fre_object_method)
Bram Moolenaar313e4722023-02-08 20:55:27 +00004673 {
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02004674 tv = STACK_TV_BOT(-1);
4675 if (tv->v_type != VAR_OBJECT)
4676 {
Ernie Raelbe828252024-07-26 18:37:02 +02004677 SOURCING_LNUM = iptr->isn_lnum;
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02004678 object_required_error(tv);
4679 vim_free(pt);
4680 goto on_error;
4681 }
Bram Moolenaar313e4722023-02-08 20:55:27 +00004682
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02004683 object_T *obj = tv->vval.v_object;
Ernie Raelbe828252024-07-26 18:37:02 +02004684 if (obj == NULL)
4685 {
4686 SOURCING_LNUM = iptr->isn_lnum;
4687 emsg(_(e_using_null_object));
4688 vim_free(pt);
4689 goto on_error;
4690 }
4691
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02004692 cl = obj->obj_class;
4693 // drop the value from the stack
4694 clear_tv(tv);
4695 --ectx->ec_stack.ga_len;
4696
4697 pt->pt_obj = obj;
4698 ++obj->obj_refcount;
4699 }
4700 else
4701 cl = extra->fre_class;
4702
4703 if (extra->fre_object_method)
4704 {
4705 // object method
4706 // convert the interface index to the object index
4707 int idx =
4708 object_index_from_itf_index(extra->fre_class,
4709 TRUE, extra->fre_method_idx, cl);
4710 ufunc = cl->class_obj_methods[idx];
4711 }
4712 else
4713 {
4714 // class method
4715 ufunc =
4716 cl->class_class_functions[extra->fre_method_idx];
4717 }
Bram Moolenaar313e4722023-02-08 20:55:27 +00004718 }
4719 else if (extra == NULL || extra->fre_func_name == NULL)
Bram Moolenaar38453522021-11-28 22:00:12 +00004720 {
4721 dfunc_T *pt_dfunc = ((dfunc_T *)def_functions.ga_data)
4722 + funcref->fr_dfunc_idx;
4723
4724 ufunc = pt_dfunc->df_ufunc;
4725 }
4726 else
Bram Moolenaar313e4722023-02-08 20:55:27 +00004727 {
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01004728 ufunc = find_func(extra->fre_func_name, FALSE);
Bram Moolenaar313e4722023-02-08 20:55:27 +00004729 }
Bram Moolenaar56acd1f2022-02-18 13:24:52 +00004730 if (ufunc == NULL)
4731 {
4732 SOURCING_LNUM = iptr->isn_lnum;
4733 iemsg("ufunc unexpectedly NULL for FUNCREF");
Christian Brabandt915f3bf2024-04-05 20:12:19 +02004734 vim_free(pt);
Bram Moolenaar56acd1f2022-02-18 13:24:52 +00004735 goto theend;
4736 }
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01004737 if (fill_partial_and_closure(pt, ufunc,
Bram Moolenaarcc341812022-09-19 15:54:34 +01004738 extra == NULL ? NULL : &extra->fre_loopvar_info,
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01004739 ectx) == FAIL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004740 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004741 tv = STACK_TV_BOT(0);
Bram Moolenaar4c137212021-04-19 16:48:48 +02004742 ++ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004743 tv->vval.v_partial = pt;
4744 tv->v_type = VAR_PARTIAL;
Bram Moolenaar2f8ce0a2020-07-19 19:47:35 +02004745 tv->v_lock = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004746 }
4747 break;
4748
Bram Moolenaar38ddf332020-07-31 22:05:04 +02004749 // Create a global function from a lambda.
4750 case ISN_NEWFUNC:
4751 {
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01004752 newfuncarg_T *arg = iptr->isn_arg.newfunc.nf_arg;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02004753
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01004754 if (copy_lambda_to_global_func(arg->nfa_lambda,
Bram Moolenaarcc341812022-09-19 15:54:34 +01004755 arg->nfa_global, &arg->nfa_loopvar_info,
4756 ectx) == FAIL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004757 goto theend;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02004758 }
4759 break;
4760
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01004761 // List functions
4762 case ISN_DEF:
4763 if (iptr->isn_arg.string == NULL)
4764 list_functions(NULL);
4765 else
4766 {
Bram Moolenaar14336722022-01-08 16:02:59 +00004767 exarg_T ea;
4768 garray_T lines_to_free;
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01004769
4770 CLEAR_FIELD(ea);
4771 ea.cmd = ea.arg = iptr->isn_arg.string;
Bram Moolenaar14336722022-01-08 16:02:59 +00004772 ga_init2(&lines_to_free, sizeof(char_u *), 50);
Bram Moolenaard4a9b7f2023-05-23 14:48:42 +01004773 SOURCING_LNUM = iptr->isn_lnum;
h-eastb895b0f2023-09-24 15:46:31 +02004774 define_function(&ea, NULL, &lines_to_free, 0, NULL, 0);
Bram Moolenaar14336722022-01-08 16:02:59 +00004775 ga_clear_strings(&lines_to_free);
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01004776 }
4777 break;
4778
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004779 // jump if a condition is met
4780 case ISN_JUMP:
4781 {
4782 jumpwhen_T when = iptr->isn_arg.jump.jump_when;
Bram Moolenaar2bb26582020-10-03 22:52:39 +02004783 int error = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004784 int jump = TRUE;
4785
4786 if (when != JUMP_ALWAYS)
4787 {
4788 tv = STACK_TV_BOT(-1);
Bram Moolenaar2bb26582020-10-03 22:52:39 +02004789 if (when == JUMP_IF_COND_FALSE
Bram Moolenaar13106602020-10-04 16:06:05 +02004790 || when == JUMP_IF_FALSE
Bram Moolenaar2bb26582020-10-03 22:52:39 +02004791 || when == JUMP_IF_COND_TRUE)
4792 {
4793 SOURCING_LNUM = iptr->isn_lnum;
4794 jump = tv_get_bool_chk(tv, &error);
4795 if (error)
4796 goto on_error;
4797 }
4798 else
4799 jump = tv2bool(tv);
Bram Moolenaarf6ced982022-04-28 12:00:49 +01004800 if (when == JUMP_IF_FALSE || when == JUMP_IF_COND_FALSE)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004801 jump = !jump;
Bram Moolenaar777770f2020-02-06 21:27:08 +01004802 if (when == JUMP_IF_FALSE || !jump)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004803 {
4804 // drop the value from the stack
4805 clear_tv(tv);
Bram Moolenaar4c137212021-04-19 16:48:48 +02004806 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004807 }
4808 }
4809 if (jump)
Bram Moolenaar4c137212021-04-19 16:48:48 +02004810 ectx->ec_iidx = iptr->isn_arg.jump.jump_where;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004811 }
4812 break;
4813
Bram Moolenaarb46c0832022-09-15 17:19:37 +01004814 // "while": jump to end if a condition is false
4815 case ISN_WHILE:
4816 {
4817 int error = FALSE;
4818 int jump = TRUE;
4819
4820 tv = STACK_TV_BOT(-1);
4821 SOURCING_LNUM = iptr->isn_lnum;
4822 jump = !tv_get_bool_chk(tv, &error);
4823 if (error)
4824 goto on_error;
4825 // drop the value from the stack
4826 clear_tv(tv);
4827 --ectx->ec_stack.ga_len;
4828 if (jump)
4829 ectx->ec_iidx = iptr->isn_arg.whileloop.while_end;
4830
Bram Moolenaar87b4e5c2022-10-01 15:32:46 +01004831 // Store the current funcref count, may be used by
Bram Moolenaarcc341812022-09-19 15:54:34 +01004832 // ISN_ENDLOOP later
Bram Moolenaarb46c0832022-09-15 17:19:37 +01004833 tv = STACK_TV_VAR(
4834 iptr->isn_arg.whileloop.while_funcref_idx);
4835 tv->vval.v_number = ectx->ec_funcrefs.ga_len;
4836 }
4837 break;
4838
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +02004839 // Jump if an argument with a default value was already set and not
4840 // v:none.
4841 case ISN_JUMP_IF_ARG_SET:
Bram Moolenaar65b0d162022-12-13 18:43:22 +00004842 case ISN_JUMP_IF_ARG_NOT_SET:
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +02004843 tv = STACK_TV_VAR(iptr->isn_arg.jumparg.jump_arg_off);
Bram Moolenaar65b0d162022-12-13 18:43:22 +00004844 int arg_set = tv->v_type != VAR_UNKNOWN
4845 && !(tv->v_type == VAR_SPECIAL
4846 && tv->vval.v_number == VVAL_NONE);
4847 if (iptr->isn_type == ISN_JUMP_IF_ARG_SET ? arg_set : !arg_set)
Bram Moolenaar4c137212021-04-19 16:48:48 +02004848 ectx->ec_iidx = iptr->isn_arg.jumparg.jump_where;
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +02004849 break;
4850
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004851 // top of a for loop
4852 case ISN_FOR:
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00004853 if (execute_for(iptr, ectx) == FAIL)
4854 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004855 break;
4856
Bram Moolenaarb46c0832022-09-15 17:19:37 +01004857 // end of a for or while loop
4858 case ISN_ENDLOOP:
4859 if (execute_endloop(iptr, ectx) == FAIL)
4860 goto theend;
4861 break;
4862
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004863 // start of ":try" block
4864 case ISN_TRY:
4865 {
Bram Moolenaar20431c92020-03-20 18:39:46 +01004866 trycmd_T *trycmd = NULL;
4867
Bram Moolenaar35578162021-08-02 19:10:38 +02004868 if (GA_GROW_FAILS(&ectx->ec_trystack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004869 goto theend;
Bram Moolenaar4c137212021-04-19 16:48:48 +02004870 trycmd = ((trycmd_T *)ectx->ec_trystack.ga_data)
4871 + ectx->ec_trystack.ga_len;
4872 ++ectx->ec_trystack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004873 ++trylevel;
Bram Moolenaar8d4be892021-02-13 18:33:02 +01004874 CLEAR_POINTER(trycmd);
Bram Moolenaar4c137212021-04-19 16:48:48 +02004875 trycmd->tcd_frame_idx = ectx->ec_frame_idx;
4876 trycmd->tcd_stack_len = ectx->ec_stack.ga_len;
Bram Moolenaara91a7132021-03-25 21:12:15 +01004877 trycmd->tcd_catch_idx =
Bram Moolenaar0d807102021-12-21 09:42:09 +00004878 iptr->isn_arg.tryref.try_ref->try_catch;
Bram Moolenaara91a7132021-03-25 21:12:15 +01004879 trycmd->tcd_finally_idx =
Bram Moolenaar0d807102021-12-21 09:42:09 +00004880 iptr->isn_arg.tryref.try_ref->try_finally;
Bram Moolenaara91a7132021-03-25 21:12:15 +01004881 trycmd->tcd_endtry_idx =
Bram Moolenaar0d807102021-12-21 09:42:09 +00004882 iptr->isn_arg.tryref.try_ref->try_endtry;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004883 }
4884 break;
4885
4886 case ISN_PUSHEXC:
4887 if (current_exception == NULL)
4888 {
Bram Moolenaar7517ffd2020-08-14 18:35:07 +02004889 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004890 iemsg("Evaluating catch while current_exception is NULL");
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004891 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004892 }
Bram Moolenaar35578162021-08-02 19:10:38 +02004893 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004894 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004895 tv = STACK_TV_BOT(0);
Bram Moolenaar4c137212021-04-19 16:48:48 +02004896 ++ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004897 tv->v_type = VAR_STRING;
Bram Moolenaar2f8ce0a2020-07-19 19:47:35 +02004898 tv->v_lock = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004899 tv->vval.v_string = vim_strsave(
4900 (char_u *)current_exception->value);
4901 break;
4902
4903 case ISN_CATCH:
4904 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02004905 garray_T *trystack = &ectx->ec_trystack;
Bram Moolenaar06651632022-04-27 17:54:25 +01004906 trycmd_T *trycmd;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004907
Bram Moolenaar4c137212021-04-19 16:48:48 +02004908 may_restore_cmdmod(&ectx->ec_funclocal);
Bram Moolenaar06651632022-04-27 17:54:25 +01004909 trycmd = ((trycmd_T *)trystack->ga_data)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004910 + trystack->ga_len - 1;
Bram Moolenaar06651632022-04-27 17:54:25 +01004911 trycmd->tcd_caught = TRUE;
4912 trycmd->tcd_did_throw = FALSE;
4913
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004914 did_emsg = got_int = did_throw = FALSE;
Bram Moolenaar1430cee2021-01-17 19:20:32 +01004915 force_abort = need_rethrow = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004916 catch_exception(current_exception);
4917 }
4918 break;
4919
Bram Moolenaarc150c092021-02-13 15:02:46 +01004920 case ISN_TRYCONT:
4921 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02004922 garray_T *trystack = &ectx->ec_trystack;
Bram Moolenaarc150c092021-02-13 15:02:46 +01004923 trycont_T *trycont = &iptr->isn_arg.trycont;
4924 int i;
4925 trycmd_T *trycmd;
4926 int iidx = trycont->tct_where;
4927
4928 if (trystack->ga_len < trycont->tct_levels)
4929 {
4930 siemsg("TRYCONT: expected %d levels, found %d",
4931 trycont->tct_levels, trystack->ga_len);
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004932 goto theend;
Bram Moolenaarc150c092021-02-13 15:02:46 +01004933 }
4934 // Make :endtry jump to any outer try block and the last
4935 // :endtry inside the loop to the loop start.
4936 for (i = trycont->tct_levels; i > 0; --i)
4937 {
4938 trycmd = ((trycmd_T *)trystack->ga_data)
4939 + trystack->ga_len - i;
Bram Moolenaar2e34c342021-03-14 12:13:33 +01004940 // Add one to tcd_cont to be able to jump to
4941 // instruction with index zero.
4942 trycmd->tcd_cont = iidx + 1;
Bram Moolenaar7e82c5f2021-02-21 21:32:45 +01004943 iidx = trycmd->tcd_finally_idx == 0
4944 ? trycmd->tcd_endtry_idx : trycmd->tcd_finally_idx;
Bram Moolenaarc150c092021-02-13 15:02:46 +01004945 }
4946 // jump to :finally or :endtry of current try statement
Bram Moolenaar4c137212021-04-19 16:48:48 +02004947 ectx->ec_iidx = iidx;
Bram Moolenaarc150c092021-02-13 15:02:46 +01004948 }
4949 break;
4950
Bram Moolenaar7e82c5f2021-02-21 21:32:45 +01004951 case ISN_FINALLY:
4952 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02004953 garray_T *trystack = &ectx->ec_trystack;
Bram Moolenaar7e82c5f2021-02-21 21:32:45 +01004954 trycmd_T *trycmd = ((trycmd_T *)trystack->ga_data)
4955 + trystack->ga_len - 1;
4956
4957 // Reset the index to avoid a return statement jumps here
4958 // again.
4959 trycmd->tcd_finally_idx = 0;
4960 break;
4961 }
4962
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004963 // end of ":try" block
4964 case ISN_ENDTRY:
4965 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02004966 garray_T *trystack = &ectx->ec_trystack;
Bram Moolenaar06651632022-04-27 17:54:25 +01004967 trycmd_T *trycmd;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004968
Bram Moolenaar06651632022-04-27 17:54:25 +01004969 --trystack->ga_len;
4970 --trylevel;
4971 trycmd = ((trycmd_T *)trystack->ga_data) + trystack->ga_len;
4972 if (trycmd->tcd_did_throw)
4973 did_throw = TRUE;
4974 if (trycmd->tcd_caught && current_exception != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004975 {
Bram Moolenaar06651632022-04-27 17:54:25 +01004976 // discard the exception
4977 if (caught_stack == current_exception)
4978 caught_stack = caught_stack->caught;
4979 discard_current_exception();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004980 }
Bram Moolenaar06651632022-04-27 17:54:25 +01004981
4982 if (trycmd->tcd_return)
4983 goto func_return;
4984
4985 while (ectx->ec_stack.ga_len > trycmd->tcd_stack_len)
4986 {
4987 --ectx->ec_stack.ga_len;
4988 clear_tv(STACK_TV_BOT(0));
4989 }
4990 if (trycmd->tcd_cont != 0)
4991 // handling :continue: jump to outer try block or
4992 // start of the loop
4993 ectx->ec_iidx = trycmd->tcd_cont - 1;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004994 }
4995 break;
4996
4997 case ISN_THROW:
Bram Moolenaar8f81b222021-01-14 21:47:06 +01004998 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02004999 garray_T *trystack = &ectx->ec_trystack;
Bram Moolenaar1e021e62020-10-16 20:25:23 +02005000
Bram Moolenaar107e9ce2021-01-24 20:52:00 +01005001 if (trystack->ga_len == 0 && trylevel == 0 && emsg_silent)
5002 {
Bram Moolenaar3ef2e412023-04-30 18:50:48 +01005003 // Throwing an exception while using "silent!" causes
Bram Moolenaar107e9ce2021-01-24 20:52:00 +01005004 // the function to abort but not display an error.
5005 tv = STACK_TV_BOT(-1);
5006 clear_tv(tv);
5007 tv->v_type = VAR_NUMBER;
5008 tv->vval.v_number = 0;
5009 goto done;
5010 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02005011 --ectx->ec_stack.ga_len;
Bram Moolenaar107e9ce2021-01-24 20:52:00 +01005012 tv = STACK_TV_BOT(0);
5013 if (tv->vval.v_string == NULL
5014 || *skipwhite(tv->vval.v_string) == NUL)
5015 {
5016 vim_free(tv->vval.v_string);
5017 SOURCING_LNUM = iptr->isn_lnum;
5018 emsg(_(e_throw_with_empty_string));
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02005019 goto theend;
Bram Moolenaar107e9ce2021-01-24 20:52:00 +01005020 }
5021
5022 // Inside a "catch" we need to first discard the caught
5023 // exception.
5024 if (trystack->ga_len > 0)
5025 {
5026 trycmd_T *trycmd = ((trycmd_T *)trystack->ga_data)
5027 + trystack->ga_len - 1;
5028 if (trycmd->tcd_caught && current_exception != NULL)
5029 {
5030 // discard the exception
5031 if (caught_stack == current_exception)
5032 caught_stack = caught_stack->caught;
5033 discard_current_exception();
5034 trycmd->tcd_caught = FALSE;
5035 }
5036 }
5037
Bram Moolenaar90a57162022-02-12 14:23:17 +00005038 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar107e9ce2021-01-24 20:52:00 +01005039 if (throw_exception(tv->vval.v_string, ET_USER, NULL)
5040 == FAIL)
5041 {
5042 vim_free(tv->vval.v_string);
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02005043 goto theend;
Bram Moolenaar107e9ce2021-01-24 20:52:00 +01005044 }
5045 did_throw = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005046 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005047 break;
5048
5049 // compare with special values
5050 case ISN_COMPAREBOOL:
5051 case ISN_COMPARESPECIAL:
5052 {
5053 typval_T *tv1 = STACK_TV_BOT(-2);
5054 typval_T *tv2 = STACK_TV_BOT(-1);
5055 varnumber_T arg1 = tv1->vval.v_number;
5056 varnumber_T arg2 = tv2->vval.v_number;
5057 int res;
5058
Bram Moolenaar06651632022-04-27 17:54:25 +01005059 if (iptr->isn_arg.op.op_type == EXPR_EQUAL)
5060 res = arg1 == arg2;
5061 else
5062 res = arg1 != arg2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005063
Bram Moolenaar4c137212021-04-19 16:48:48 +02005064 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005065 tv1->v_type = VAR_BOOL;
5066 tv1->vval.v_number = res ? VVAL_TRUE : VVAL_FALSE;
5067 }
5068 break;
5069
Bram Moolenaar7a222242022-03-01 19:23:24 +00005070 case ISN_COMPARENULL:
5071 {
5072 typval_T *tv1 = STACK_TV_BOT(-2);
5073 typval_T *tv2 = STACK_TV_BOT(-1);
5074 int res;
5075
5076 res = typval_compare_null(tv1, tv2);
5077 if (res == MAYBE)
5078 goto on_error;
5079 if (iptr->isn_arg.op.op_type == EXPR_NEQUAL)
5080 res = !res;
5081 clear_tv(tv1);
5082 clear_tv(tv2);
5083 --ectx->ec_stack.ga_len;
5084 tv1->v_type = VAR_BOOL;
5085 tv1->vval.v_number = res ? VVAL_TRUE : VVAL_FALSE;
5086 }
5087 break;
5088
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005089 // Operation with two number arguments
5090 case ISN_OPNR:
5091 case ISN_COMPARENR:
5092 {
5093 typval_T *tv1 = STACK_TV_BOT(-2);
5094 typval_T *tv2 = STACK_TV_BOT(-1);
5095 varnumber_T arg1 = tv1->vval.v_number;
5096 varnumber_T arg2 = tv2->vval.v_number;
Bram Moolenaarfbeefb12021-08-07 15:50:23 +02005097 varnumber_T res = 0;
5098 int div_zero = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005099
Yegappan Lakshmanana061f342022-05-22 19:13:49 +01005100 if (iptr->isn_arg.op.op_type == EXPR_LSHIFT
5101 || iptr->isn_arg.op.op_type == EXPR_RSHIFT)
5102 {
5103 if (arg2 < 0)
5104 {
5105 SOURCING_LNUM = iptr->isn_lnum;
dundargocc57b5bc2022-11-02 13:30:51 +00005106 emsg(_(e_bitshift_ops_must_be_positive));
Yegappan Lakshmanana061f342022-05-22 19:13:49 +01005107 goto on_error;
5108 }
5109 }
5110
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005111 switch (iptr->isn_arg.op.op_type)
5112 {
5113 case EXPR_MULT: res = arg1 * arg2; break;
Bram Moolenaarfbeefb12021-08-07 15:50:23 +02005114 case EXPR_DIV: if (arg2 == 0)
5115 div_zero = TRUE;
5116 else
5117 res = arg1 / arg2;
5118 break;
5119 case EXPR_REM: if (arg2 == 0)
5120 div_zero = TRUE;
5121 else
5122 res = arg1 % arg2;
5123 break;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005124 case EXPR_SUB: res = arg1 - arg2; break;
5125 case EXPR_ADD: res = arg1 + arg2; break;
5126
5127 case EXPR_EQUAL: res = arg1 == arg2; break;
5128 case EXPR_NEQUAL: res = arg1 != arg2; break;
5129 case EXPR_GREATER: res = arg1 > arg2; break;
5130 case EXPR_GEQUAL: res = arg1 >= arg2; break;
5131 case EXPR_SMALLER: res = arg1 < arg2; break;
5132 case EXPR_SEQUAL: res = arg1 <= arg2; break;
Yegappan Lakshmanana061f342022-05-22 19:13:49 +01005133 case EXPR_LSHIFT: if (arg2 > MAX_LSHIFT_BITS)
5134 res = 0;
5135 else
Bram Moolenaar68e64d22022-05-22 22:07:52 +01005136 res = (uvarnumber_T)arg1 << arg2;
Yegappan Lakshmanana061f342022-05-22 19:13:49 +01005137 break;
5138 case EXPR_RSHIFT: if (arg2 > MAX_LSHIFT_BITS)
5139 res = 0;
5140 else
Bram Moolenaar338bf582022-05-22 20:16:32 +01005141 res = (uvarnumber_T)arg1 >> arg2;
Yegappan Lakshmanana061f342022-05-22 19:13:49 +01005142 break;
Bram Moolenaarfbeefb12021-08-07 15:50:23 +02005143 default: break;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005144 }
5145
Bram Moolenaar4c137212021-04-19 16:48:48 +02005146 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005147 if (iptr->isn_type == ISN_COMPARENR)
5148 {
5149 tv1->v_type = VAR_BOOL;
5150 tv1->vval.v_number = res ? VVAL_TRUE : VVAL_FALSE;
5151 }
5152 else
5153 tv1->vval.v_number = res;
Bram Moolenaarfbeefb12021-08-07 15:50:23 +02005154 if (div_zero)
5155 {
5156 SOURCING_LNUM = iptr->isn_lnum;
5157 emsg(_(e_divide_by_zero));
5158 goto on_error;
5159 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005160 }
5161 break;
5162
5163 // Computation with two float arguments
5164 case ISN_OPFLOAT:
5165 case ISN_COMPAREFLOAT:
5166 {
5167 typval_T *tv1 = STACK_TV_BOT(-2);
5168 typval_T *tv2 = STACK_TV_BOT(-1);
5169 float_T arg1 = tv1->vval.v_float;
5170 float_T arg2 = tv2->vval.v_float;
5171 float_T res = 0;
5172 int cmp = FALSE;
5173
5174 switch (iptr->isn_arg.op.op_type)
5175 {
5176 case EXPR_MULT: res = arg1 * arg2; break;
5177 case EXPR_DIV: res = arg1 / arg2; break;
5178 case EXPR_SUB: res = arg1 - arg2; break;
5179 case EXPR_ADD: res = arg1 + arg2; break;
5180
5181 case EXPR_EQUAL: cmp = arg1 == arg2; break;
5182 case EXPR_NEQUAL: cmp = arg1 != arg2; break;
5183 case EXPR_GREATER: cmp = arg1 > arg2; break;
5184 case EXPR_GEQUAL: cmp = arg1 >= arg2; break;
5185 case EXPR_SMALLER: cmp = arg1 < arg2; break;
5186 case EXPR_SEQUAL: cmp = arg1 <= arg2; break;
5187 default: cmp = 0; break;
5188 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02005189 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005190 if (iptr->isn_type == ISN_COMPAREFLOAT)
5191 {
5192 tv1->v_type = VAR_BOOL;
5193 tv1->vval.v_number = cmp ? VVAL_TRUE : VVAL_FALSE;
5194 }
5195 else
5196 tv1->vval.v_float = res;
5197 }
5198 break;
5199
5200 case ISN_COMPARELIST:
Bram Moolenaar265f8112021-12-19 12:33:05 +00005201 case ISN_COMPAREDICT:
5202 case ISN_COMPAREFUNC:
5203 case ISN_COMPARESTRING:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005204 case ISN_COMPAREBLOB:
Bram Moolenaarbcf31ec2023-01-02 20:32:24 +00005205 case ISN_COMPAREOBJECT:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005206 {
5207 typval_T *tv1 = STACK_TV_BOT(-2);
5208 typval_T *tv2 = STACK_TV_BOT(-1);
Bram Moolenaar265f8112021-12-19 12:33:05 +00005209 exprtype_T exprtype = iptr->isn_arg.op.op_type;
5210 int ic = iptr->isn_arg.op.op_ic;
5211 int res = FALSE;
5212 int status = OK;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005213
Bram Moolenaar265f8112021-12-19 12:33:05 +00005214 SOURCING_LNUM = iptr->isn_lnum;
5215 if (iptr->isn_type == ISN_COMPARELIST)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005216 {
Bram Moolenaar265f8112021-12-19 12:33:05 +00005217 status = typval_compare_list(tv1, tv2,
5218 exprtype, ic, &res);
5219 }
5220 else if (iptr->isn_type == ISN_COMPAREDICT)
5221 {
5222 status = typval_compare_dict(tv1, tv2,
5223 exprtype, ic, &res);
5224 }
5225 else if (iptr->isn_type == ISN_COMPAREFUNC)
5226 {
5227 status = typval_compare_func(tv1, tv2,
5228 exprtype, ic, &res);
5229 }
5230 else if (iptr->isn_type == ISN_COMPARESTRING)
5231 {
5232 status = typval_compare_string(tv1, tv2,
5233 exprtype, ic, &res);
5234 }
Bram Moolenaarbcf31ec2023-01-02 20:32:24 +00005235 else if (iptr->isn_type == ISN_COMPAREBLOB)
Bram Moolenaar265f8112021-12-19 12:33:05 +00005236 {
5237 status = typval_compare_blob(tv1, tv2, exprtype, &res);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005238 }
Bram Moolenaarbcf31ec2023-01-02 20:32:24 +00005239 else // ISN_COMPAREOBJECT
5240 {
5241 status = typval_compare_object(tv1, tv2,
Bram Moolenaar03ff0c62023-01-02 20:38:01 +00005242 exprtype, FALSE, &res);
Bram Moolenaarbcf31ec2023-01-02 20:32:24 +00005243 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02005244 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005245 clear_tv(tv1);
5246 clear_tv(tv2);
5247 tv1->v_type = VAR_BOOL;
Bram Moolenaar265f8112021-12-19 12:33:05 +00005248 tv1->vval.v_number = res ? VVAL_TRUE : VVAL_FALSE;
5249 if (status == FAIL)
5250 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005251 }
5252 break;
5253
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005254 case ISN_COMPAREANY:
5255 {
5256 typval_T *tv1 = STACK_TV_BOT(-2);
5257 typval_T *tv2 = STACK_TV_BOT(-1);
Bram Moolenaar657137c2021-01-09 15:45:23 +01005258 exprtype_T exprtype = iptr->isn_arg.op.op_type;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005259 int ic = iptr->isn_arg.op.op_ic;
Bram Moolenaar265f8112021-12-19 12:33:05 +00005260 int status;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005261
Bram Moolenaareb26f432020-09-14 16:50:05 +02005262 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar265f8112021-12-19 12:33:05 +00005263 status = typval_compare(tv1, tv2, exprtype, ic);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005264 clear_tv(tv2);
Bram Moolenaar4c137212021-04-19 16:48:48 +02005265 --ectx->ec_stack.ga_len;
Bram Moolenaar265f8112021-12-19 12:33:05 +00005266 if (status == FAIL)
5267 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005268 }
5269 break;
5270
5271 case ISN_ADDLIST:
5272 case ISN_ADDBLOB:
5273 {
5274 typval_T *tv1 = STACK_TV_BOT(-2);
5275 typval_T *tv2 = STACK_TV_BOT(-1);
5276
Bram Moolenaar1dcae592020-10-19 19:02:42 +02005277 // add two lists or blobs
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005278 if (iptr->isn_type == ISN_ADDLIST)
Bram Moolenaar07802042021-09-09 23:01:14 +02005279 {
5280 if (iptr->isn_arg.op.op_type == EXPR_APPEND
5281 && tv1->vval.v_list != NULL)
5282 list_extend(tv1->vval.v_list, tv2->vval.v_list,
5283 NULL);
5284 else
5285 eval_addlist(tv1, tv2);
5286 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005287 else
5288 eval_addblob(tv1, tv2);
5289 clear_tv(tv2);
Bram Moolenaar4c137212021-04-19 16:48:48 +02005290 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005291 }
5292 break;
5293
Bram Moolenaar1dcae592020-10-19 19:02:42 +02005294 case ISN_LISTAPPEND:
5295 {
5296 typval_T *tv1 = STACK_TV_BOT(-2);
5297 typval_T *tv2 = STACK_TV_BOT(-1);
5298 list_T *l = tv1->vval.v_list;
5299
5300 // add an item to a list
Bram Moolenaar1f4a3452022-01-01 18:29:21 +00005301 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar1dcae592020-10-19 19:02:42 +02005302 if (l == NULL)
5303 {
Bram Moolenaar1dcae592020-10-19 19:02:42 +02005304 emsg(_(e_cannot_add_to_null_list));
5305 goto on_error;
5306 }
Bram Moolenaar1f4a3452022-01-01 18:29:21 +00005307 if (value_check_lock(l->lv_lock, NULL, FALSE))
5308 goto on_error;
Bram Moolenaar1dcae592020-10-19 19:02:42 +02005309 if (list_append_tv(l, tv2) == FAIL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02005310 goto theend;
Bram Moolenaar955347c2020-10-19 23:01:46 +02005311 clear_tv(tv2);
Bram Moolenaar4c137212021-04-19 16:48:48 +02005312 --ectx->ec_stack.ga_len;
Bram Moolenaar1dcae592020-10-19 19:02:42 +02005313 }
5314 break;
5315
Bram Moolenaar80b0e5e2020-10-19 20:45:36 +02005316 case ISN_BLOBAPPEND:
5317 {
5318 typval_T *tv1 = STACK_TV_BOT(-2);
5319 typval_T *tv2 = STACK_TV_BOT(-1);
5320 blob_T *b = tv1->vval.v_blob;
5321 int error = FALSE;
5322 varnumber_T n;
5323
5324 // add a number to a blob
5325 if (b == NULL)
5326 {
5327 SOURCING_LNUM = iptr->isn_lnum;
5328 emsg(_(e_cannot_add_to_null_blob));
5329 goto on_error;
5330 }
5331 n = tv_get_number_chk(tv2, &error);
5332 if (error)
5333 goto on_error;
5334 ga_append(&b->bv_ga, (int)n);
Bram Moolenaar4c137212021-04-19 16:48:48 +02005335 --ectx->ec_stack.ga_len;
Bram Moolenaar80b0e5e2020-10-19 20:45:36 +02005336 }
5337 break;
5338
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005339 // Computation with two arguments of unknown type
5340 case ISN_OPANY:
5341 {
5342 typval_T *tv1 = STACK_TV_BOT(-2);
5343 typval_T *tv2 = STACK_TV_BOT(-1);
5344 varnumber_T n1, n2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005345 float_T f1 = 0, f2 = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005346 int error = FALSE;
5347
5348 if (iptr->isn_arg.op.op_type == EXPR_ADD)
5349 {
5350 if (tv1->v_type == VAR_LIST && tv2->v_type == VAR_LIST)
5351 {
5352 eval_addlist(tv1, tv2);
5353 clear_tv(tv2);
Bram Moolenaar4c137212021-04-19 16:48:48 +02005354 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005355 break;
5356 }
5357 else if (tv1->v_type == VAR_BLOB
5358 && tv2->v_type == VAR_BLOB)
5359 {
5360 eval_addblob(tv1, tv2);
5361 clear_tv(tv2);
Bram Moolenaar4c137212021-04-19 16:48:48 +02005362 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005363 break;
5364 }
5365 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005366 if (tv1->v_type == VAR_FLOAT)
5367 {
5368 f1 = tv1->vval.v_float;
5369 n1 = 0;
5370 }
5371 else
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005372 {
Bram Moolenaarf665e972020-12-05 19:17:16 +01005373 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005374 n1 = tv_get_number_chk(tv1, &error);
5375 if (error)
Bram Moolenaard032f342020-07-18 18:13:02 +02005376 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005377 if (tv2->v_type == VAR_FLOAT)
5378 f1 = n1;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005379 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005380 if (tv2->v_type == VAR_FLOAT)
5381 {
5382 f2 = tv2->vval.v_float;
5383 n2 = 0;
5384 }
5385 else
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005386 {
5387 n2 = tv_get_number_chk(tv2, &error);
5388 if (error)
Bram Moolenaard032f342020-07-18 18:13:02 +02005389 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005390 if (tv1->v_type == VAR_FLOAT)
5391 f2 = n2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005392 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005393 // if there is a float on either side the result is a float
5394 if (tv1->v_type == VAR_FLOAT || tv2->v_type == VAR_FLOAT)
5395 {
5396 switch (iptr->isn_arg.op.op_type)
5397 {
5398 case EXPR_MULT: f1 = f1 * f2; break;
5399 case EXPR_DIV: f1 = f1 / f2; break;
5400 case EXPR_SUB: f1 = f1 - f2; break;
5401 case EXPR_ADD: f1 = f1 + f2; break;
Bram Moolenaar7517ffd2020-08-14 18:35:07 +02005402 default: SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005403 emsg(_(e_cannot_use_percent_with_float));
Bram Moolenaarf0b9f432020-07-17 23:03:17 +02005404 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005405 }
5406 clear_tv(tv1);
5407 clear_tv(tv2);
5408 tv1->v_type = VAR_FLOAT;
5409 tv1->vval.v_float = f1;
Bram Moolenaar4c137212021-04-19 16:48:48 +02005410 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005411 }
5412 else
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005413 {
Bram Moolenaarb1f28572021-01-21 13:03:20 +01005414 int failed = FALSE;
5415
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005416 switch (iptr->isn_arg.op.op_type)
5417 {
5418 case EXPR_MULT: n1 = n1 * n2; break;
Bram Moolenaarb1f28572021-01-21 13:03:20 +01005419 case EXPR_DIV: n1 = num_divide(n1, n2, &failed);
5420 if (failed)
Bram Moolenaar99880f92021-01-20 21:23:14 +01005421 goto on_error;
5422 break;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005423 case EXPR_SUB: n1 = n1 - n2; break;
5424 case EXPR_ADD: n1 = n1 + n2; break;
Bram Moolenaarb1f28572021-01-21 13:03:20 +01005425 default: n1 = num_modulus(n1, n2, &failed);
5426 if (failed)
Bram Moolenaar99880f92021-01-20 21:23:14 +01005427 goto on_error;
5428 break;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005429 }
5430 clear_tv(tv1);
5431 clear_tv(tv2);
5432 tv1->v_type = VAR_NUMBER;
5433 tv1->vval.v_number = n1;
Bram Moolenaar4c137212021-04-19 16:48:48 +02005434 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005435 }
5436 }
5437 break;
5438
Bram Moolenaarbf9d8c32020-07-19 17:55:44 +02005439 case ISN_STRINDEX:
Bram Moolenaar11107ba2020-08-15 21:10:16 +02005440 case ISN_STRSLICE:
Bram Moolenaarbf9d8c32020-07-19 17:55:44 +02005441 {
Bram Moolenaar11107ba2020-08-15 21:10:16 +02005442 int is_slice = iptr->isn_type == ISN_STRSLICE;
5443 varnumber_T n1 = 0, n2;
Bram Moolenaarbf9d8c32020-07-19 17:55:44 +02005444 char_u *res;
5445
5446 // string index: string is at stack-2, index at stack-1
Bram Moolenaar11107ba2020-08-15 21:10:16 +02005447 // string slice: string is at stack-3, first index at
5448 // stack-2, second index at stack-1
Bram Moolenaar11107ba2020-08-15 21:10:16 +02005449 if (is_slice)
5450 {
5451 tv = STACK_TV_BOT(-2);
Bram Moolenaar11107ba2020-08-15 21:10:16 +02005452 n1 = tv->vval.v_number;
5453 }
5454
Bram Moolenaarbf9d8c32020-07-19 17:55:44 +02005455 tv = STACK_TV_BOT(-1);
Bram Moolenaar11107ba2020-08-15 21:10:16 +02005456 n2 = tv->vval.v_number;
Bram Moolenaarbf9d8c32020-07-19 17:55:44 +02005457
Bram Moolenaar4c137212021-04-19 16:48:48 +02005458 ectx->ec_stack.ga_len -= is_slice ? 2 : 1;
Bram Moolenaarbf9d8c32020-07-19 17:55:44 +02005459 tv = STACK_TV_BOT(-1);
Bram Moolenaar11107ba2020-08-15 21:10:16 +02005460 if (is_slice)
5461 // Slice: Select the characters from the string
Bram Moolenaar6601b622021-01-13 21:47:15 +01005462 res = string_slice(tv->vval.v_string, n1, n2, FALSE);
Bram Moolenaar11107ba2020-08-15 21:10:16 +02005463 else
5464 // Index: The resulting variable is a string of a
Bram Moolenaar0289a092021-03-14 18:40:19 +01005465 // single character (including composing characters).
5466 // If the index is too big or negative the result is
5467 // empty.
Bram Moolenaar11107ba2020-08-15 21:10:16 +02005468 res = char_from_string(tv->vval.v_string, n2);
Bram Moolenaarbf9d8c32020-07-19 17:55:44 +02005469 vim_free(tv->vval.v_string);
5470 tv->vval.v_string = res;
5471 }
5472 break;
5473
5474 case ISN_LISTINDEX:
Bram Moolenaared591872020-08-15 22:14:53 +02005475 case ISN_LISTSLICE:
Bram Moolenaarcfc30232021-04-11 20:26:34 +02005476 case ISN_BLOBINDEX:
5477 case ISN_BLOBSLICE:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005478 {
Bram Moolenaarcfc30232021-04-11 20:26:34 +02005479 int is_slice = iptr->isn_type == ISN_LISTSLICE
5480 || iptr->isn_type == ISN_BLOBSLICE;
5481 int is_blob = iptr->isn_type == ISN_BLOBINDEX
5482 || iptr->isn_type == ISN_BLOBSLICE;
Bram Moolenaared591872020-08-15 22:14:53 +02005483 varnumber_T n1, n2;
Bram Moolenaarcfc30232021-04-11 20:26:34 +02005484 typval_T *val_tv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005485
5486 // list index: list is at stack-2, index at stack-1
Bram Moolenaared591872020-08-15 22:14:53 +02005487 // list slice: list is at stack-3, indexes at stack-2 and
5488 // stack-1
Bram Moolenaarcfc30232021-04-11 20:26:34 +02005489 // Same for blob.
5490 val_tv = is_slice ? STACK_TV_BOT(-3) : STACK_TV_BOT(-2);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005491
5492 tv = STACK_TV_BOT(-1);
Bram Moolenaared591872020-08-15 22:14:53 +02005493 n1 = n2 = tv->vval.v_number;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005494 clear_tv(tv);
Bram Moolenaared591872020-08-15 22:14:53 +02005495
5496 if (is_slice)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005497 {
Bram Moolenaared591872020-08-15 22:14:53 +02005498 tv = STACK_TV_BOT(-2);
Bram Moolenaared591872020-08-15 22:14:53 +02005499 n1 = tv->vval.v_number;
5500 clear_tv(tv);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005501 }
Bram Moolenaared591872020-08-15 22:14:53 +02005502
Bram Moolenaar4c137212021-04-19 16:48:48 +02005503 ectx->ec_stack.ga_len -= is_slice ? 2 : 1;
Bram Moolenaar435d8972020-07-05 16:42:13 +02005504 tv = STACK_TV_BOT(-1);
Bram Moolenaar1d634542020-08-18 13:41:50 +02005505 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaarcfc30232021-04-11 20:26:34 +02005506 if (is_blob)
5507 {
5508 if (blob_slice_or_index(val_tv->vval.v_blob, is_slice,
5509 n1, n2, FALSE, tv) == FAIL)
5510 goto on_error;
5511 }
5512 else
5513 {
5514 if (list_slice_or_index(val_tv->vval.v_list, is_slice,
5515 n1, n2, FALSE, tv, TRUE) == FAIL)
5516 goto on_error;
5517 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005518 }
5519 break;
5520
Bram Moolenaarcc673e72020-08-16 17:33:35 +02005521 case ISN_ANYINDEX:
5522 case ISN_ANYSLICE:
5523 {
5524 int is_slice = iptr->isn_type == ISN_ANYSLICE;
5525 typval_T *var1, *var2;
5526 int res;
5527
5528 // index: composite is at stack-2, index at stack-1
5529 // slice: composite is at stack-3, indexes at stack-2 and
5530 // stack-1
5531 tv = is_slice ? STACK_TV_BOT(-3) : STACK_TV_BOT(-2);
Bram Moolenaar3affe7a2020-08-18 20:34:13 +02005532 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaarcc673e72020-08-16 17:33:35 +02005533 if (check_can_index(tv, TRUE, TRUE) == FAIL)
5534 goto on_error;
5535 var1 = is_slice ? STACK_TV_BOT(-2) : STACK_TV_BOT(-1);
5536 var2 = is_slice ? STACK_TV_BOT(-1) : NULL;
Bram Moolenaar6601b622021-01-13 21:47:15 +01005537 res = eval_index_inner(tv, is_slice, var1, var2,
5538 FALSE, NULL, -1, TRUE);
Bram Moolenaarcc673e72020-08-16 17:33:35 +02005539 clear_tv(var1);
5540 if (is_slice)
5541 clear_tv(var2);
Bram Moolenaar4c137212021-04-19 16:48:48 +02005542 ectx->ec_stack.ga_len -= is_slice ? 2 : 1;
Bram Moolenaarcc673e72020-08-16 17:33:35 +02005543 if (res == FAIL)
5544 goto on_error;
5545 }
5546 break;
5547
Bram Moolenaar9af78762020-06-16 11:34:42 +02005548 case ISN_SLICE:
5549 {
5550 list_T *list;
5551 int count = iptr->isn_arg.number;
5552
Bram Moolenaarc5b1c202020-06-18 22:43:27 +02005553 // type will have been checked to be a list
Bram Moolenaar9af78762020-06-16 11:34:42 +02005554 tv = STACK_TV_BOT(-1);
Bram Moolenaar9af78762020-06-16 11:34:42 +02005555 list = tv->vval.v_list;
5556
5557 // no error for short list, expect it to be checked earlier
5558 if (list != NULL && list->lv_len >= count)
5559 {
5560 list_T *newlist = list_slice(list,
5561 count, list->lv_len - 1);
5562
5563 if (newlist != NULL)
5564 {
5565 list_unref(list);
5566 tv->vval.v_list = newlist;
5567 ++newlist->lv_refcount;
5568 }
5569 }
5570 }
5571 break;
5572
Bram Moolenaar47a519a2020-06-14 23:05:10 +02005573 case ISN_GETITEM:
5574 {
5575 listitem_T *li;
Bram Moolenaar035bd1c2021-06-21 19:44:11 +02005576 getitem_T *gi = &iptr->isn_arg.getitem;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02005577
Bram Moolenaarc785b9a2020-06-19 18:34:15 +02005578 // Get list item: list is at stack-1, push item.
5579 // List type and length is checked for when compiling.
Bram Moolenaar035bd1c2021-06-21 19:44:11 +02005580 tv = STACK_TV_BOT(-1 - gi->gi_with_op);
5581 li = list_find(tv->vval.v_list, gi->gi_index);
Bram Moolenaar47a519a2020-06-14 23:05:10 +02005582
Bram Moolenaar35578162021-08-02 19:10:38 +02005583 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02005584 goto theend;
Bram Moolenaar4c137212021-04-19 16:48:48 +02005585 ++ectx->ec_stack.ga_len;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02005586 copy_tv(&li->li_tv, STACK_TV_BOT(-1));
Bram Moolenaarf785aa12021-02-11 21:19:34 +01005587
5588 // Useful when used in unpack assignment. Reset at
5589 // ISN_DROP.
Bram Moolenaar035bd1c2021-06-21 19:44:11 +02005590 ectx->ec_where.wt_index = gi->gi_index + 1;
LemonBoyc5d27442023-08-19 13:02:35 +02005591 ectx->ec_where.wt_kind = WT_VARIABLE;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02005592 }
5593 break;
5594
Yegappan Lakshmanan56d45f12024-11-11 19:58:55 +01005595 // dict member with string key (dict['member'])
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005596 case ISN_MEMBER:
5597 {
5598 dict_T *dict;
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02005599 char_u *key;
5600 dictitem_T *di;
5601
5602 // dict member: dict is at stack-2, key at stack-1
5603 tv = STACK_TV_BOT(-2);
Bram Moolenaar4dac32c2020-05-15 21:44:19 +02005604 // no need to check for VAR_DICT, CHECKTYPE will check.
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02005605 dict = tv->vval.v_dict;
5606
5607 tv = STACK_TV_BOT(-1);
Bram Moolenaar4dac32c2020-05-15 21:44:19 +02005608 // no need to check for VAR_STRING, 2STRING will check.
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02005609 key = tv->vval.v_string;
Bram Moolenaar086fc9a2020-10-30 18:33:02 +01005610 if (key == NULL)
5611 key = (char_u *)"";
Bram Moolenaar4dac32c2020-05-15 21:44:19 +02005612
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02005613 if ((di = dict_find(dict, key, -1)) == NULL)
5614 {
Bram Moolenaar7517ffd2020-08-14 18:35:07 +02005615 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00005616 semsg(_(e_key_not_present_in_dictionary_str), key);
Bram Moolenaar4029cab2020-12-05 18:13:27 +01005617
5618 // If :silent! is used we will continue, make sure the
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02005619 // stack contents makes sense and the dict stack is
5620 // updated.
Bram Moolenaar4029cab2020-12-05 18:13:27 +01005621 clear_tv(tv);
Bram Moolenaar4c137212021-04-19 16:48:48 +02005622 --ectx->ec_stack.ga_len;
Bram Moolenaar4029cab2020-12-05 18:13:27 +01005623 tv = STACK_TV_BOT(-1);
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02005624 (void) dict_stack_save(tv);
Bram Moolenaar4029cab2020-12-05 18:13:27 +01005625 tv->v_type = VAR_NUMBER;
5626 tv->vval.v_number = 0;
Bram Moolenaaraf0df472020-12-02 20:51:22 +01005627 goto on_fatal_error;
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02005628 }
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02005629 clear_tv(tv);
Bram Moolenaar4c137212021-04-19 16:48:48 +02005630 --ectx->ec_stack.ga_len;
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02005631 // Put the dict used on the dict stack, it might be used by
5632 // a dict function later.
Bram Moolenaar50788ef2020-07-05 16:51:26 +02005633 tv = STACK_TV_BOT(-1);
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02005634 if (dict_stack_save(tv) == FAIL)
5635 goto on_fatal_error;
Bram Moolenaar50788ef2020-07-05 16:51:26 +02005636 copy_tv(&di->di_tv, tv);
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02005637 }
5638 break;
5639
Yegappan Lakshmanan56d45f12024-11-11 19:58:55 +01005640 // dict member with string key (dict.member)
5641 // or can be an object
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02005642 case ISN_STRINGMEMBER:
5643 {
5644 dict_T *dict;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005645 dictitem_T *di;
5646
5647 tv = STACK_TV_BOT(-1);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005648
Yegappan Lakshmanan56d45f12024-11-11 19:58:55 +01005649 if (tv->v_type == VAR_OBJECT)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005650 {
Yegappan Lakshmanan56d45f12024-11-11 19:58:55 +01005651 if (dict_stack_save(tv) == FAIL)
5652 goto on_fatal_error;
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02005653
Yegappan Lakshmanan56d45f12024-11-11 19:58:55 +01005654 ufunc_T *ufunc = (((dfunc_T *)def_functions.ga_data)
5655 + ectx->ec_dfunc_idx)->df_ufunc;
5656 // Class object (not a Dict)
5657 if (any_var_get_obj_member(ufunc->uf_class, iptr, tv) == FAIL)
5658 goto on_error;
5659 }
5660 else
5661 {
5662 if (tv->v_type != VAR_DICT || tv->vval.v_dict == NULL)
5663 {
5664 SOURCING_LNUM = iptr->isn_lnum;
5665 emsg(_(e_dictionary_required));
5666 goto on_error;
5667 }
5668 dict = tv->vval.v_dict;
5669
5670 if ((di = dict_find(dict, iptr->isn_arg.string, -1))
5671 == NULL)
5672 {
5673 SOURCING_LNUM = iptr->isn_lnum;
5674 semsg(_(e_key_not_present_in_dictionary_str),
5675 iptr->isn_arg.string);
5676 goto on_error;
5677 }
5678 // Put the dict used on the dict stack, it might be
5679 // used by a dict function later.
5680 if (dict_stack_save(tv) == FAIL)
5681 goto on_fatal_error;
5682
5683 copy_tv(&di->di_tv, tv);
5684 }
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02005685 }
5686 break;
5687
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00005688 case ISN_GET_OBJ_MEMBER:
Bram Moolenaar29ac5df2023-01-16 19:43:47 +00005689 case ISN_GET_ITF_MEMBER:
Bram Moolenaarffdaca92022-12-09 21:41:48 +00005690 {
5691 tv = STACK_TV_BOT(-1);
5692 if (tv->v_type != VAR_OBJECT)
5693 {
5694 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaard0200c82023-01-28 15:19:40 +00005695 object_required_error(tv);
Bram Moolenaarffdaca92022-12-09 21:41:48 +00005696 goto on_error;
5697 }
Bram Moolenaar29ac5df2023-01-16 19:43:47 +00005698
Bram Moolenaarffdaca92022-12-09 21:41:48 +00005699 object_T *obj = tv->vval.v_object;
Bram Moolenaarc3f971f2023-03-02 17:38:33 +00005700 if (obj == NULL)
5701 {
5702 SOURCING_LNUM = iptr->isn_lnum;
5703 emsg(_(e_using_null_object));
5704 goto on_error;
5705 }
5706
Bram Moolenaar29ac5df2023-01-16 19:43:47 +00005707 int idx;
5708 if (iptr->isn_type == ISN_GET_OBJ_MEMBER)
Ernie Rael18143d32023-09-04 22:30:41 +02005709 idx = iptr->isn_arg.classmember.cm_idx;
Bram Moolenaar29ac5df2023-01-16 19:43:47 +00005710 else
5711 {
5712 idx = iptr->isn_arg.classmember.cm_idx;
5713 // convert the interface index to the object index
5714 idx = object_index_from_itf_index(
Ernie Rael18143d32023-09-04 22:30:41 +02005715 iptr->isn_arg.classmember.cm_class,
Yegappan Lakshmanan5a05d372023-09-29 19:43:11 +02005716 FALSE, idx, obj->obj_class);
Bram Moolenaar29ac5df2023-01-16 19:43:47 +00005717 }
5718
Ernie Rael18143d32023-09-04 22:30:41 +02005719 // The members are located right after the object struct.
Yegappan Lakshmanan5a05d372023-09-29 19:43:11 +02005720 typval_T *mtv = ((typval_T *)(obj + 1)) + idx;
Bram Moolenaar590162c2022-12-24 21:24:06 +00005721 copy_tv(mtv, tv);
Bram Moolenaarffdaca92022-12-09 21:41:48 +00005722
5723 // Unreference the object after getting the member, it may
5724 // be freed.
5725 object_unref(obj);
5726 }
5727 break;
5728
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00005729 case ISN_STORE_THIS:
5730 {
5731 int idx = iptr->isn_arg.number;
5732 object_T *obj = STACK_TV_VAR(0)->vval.v_object;
5733 // the members are located right after the object struct
5734 typval_T *mtv = ((typval_T *)(obj + 1)) + idx;
5735 clear_tv(mtv);
5736 *mtv = *STACK_TV_BOT(-1);
5737 --ectx->ec_stack.ga_len;
5738 }
5739 break;
5740
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02005741 case ISN_CLEARDICT:
5742 dict_stack_drop();
5743 break;
5744
5745 case ISN_USEDICT:
5746 {
5747 typval_T *dict_tv = dict_stack_get_tv();
5748
5749 // Turn "dict.Func" into a partial for "Func" bound to
5750 // "dict". Don't do this when "Func" is already a partial
5751 // that was bound explicitly (pt_auto is FALSE).
5752 tv = STACK_TV_BOT(-1);
5753 if (dict_tv != NULL
5754 && dict_tv->v_type == VAR_DICT
5755 && dict_tv->vval.v_dict != NULL
5756 && (tv->v_type == VAR_FUNC
5757 || (tv->v_type == VAR_PARTIAL
5758 && (tv->vval.v_partial->pt_auto
5759 || tv->vval.v_partial->pt_dict == NULL))))
5760 dict_tv->vval.v_dict =
5761 make_partial(dict_tv->vval.v_dict, tv);
5762 dict_stack_drop();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005763 }
5764 break;
5765
5766 case ISN_NEGATENR:
5767 tv = STACK_TV_BOT(-1);
Bram Moolenaar0c7f2612022-02-17 19:44:07 +00005768 // CHECKTYPE should have checked the variable type
Bram Moolenaarc58164c2020-03-29 18:40:30 +02005769 if (tv->v_type == VAR_FLOAT)
5770 tv->vval.v_float = -tv->vval.v_float;
5771 else
Bram Moolenaarc58164c2020-03-29 18:40:30 +02005772 tv->vval.v_number = -tv->vval.v_number;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005773 break;
5774
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005775 case ISN_CHECKTYPE:
5776 {
5777 checktype_T *ct = &iptr->isn_arg.type;
Bram Moolenaarb1040dc2022-05-18 11:00:48 +01005778 int r;
LemonBoyc5d27442023-08-19 13:02:35 +02005779 where_T where = WHERE_INIT;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005780
Bram Moolenaarb3005ce2021-01-22 17:51:06 +01005781 tv = STACK_TV_BOT((int)ct->ct_off);
Bram Moolenaar5e654232020-09-16 15:22:00 +02005782 SOURCING_LNUM = iptr->isn_lnum;
LemonBoyc5d27442023-08-19 13:02:35 +02005783 if (ct->ct_arg_idx > 0)
5784 {
5785 where.wt_index = ct->ct_arg_idx;
5786 where.wt_kind = ct->ct_is_var ? WT_VARIABLE : WT_ARGUMENT;
LemonBoyc5d27442023-08-19 13:02:35 +02005787 }
LemonBoyf244b2f2023-08-19 16:02:04 +02005788 where.wt_func_name = ectx->ec_where.wt_func_name;
LemonBoyc5d27442023-08-19 13:02:35 +02005789 r = check_typval_type(ct->ct_type, tv, where);
Bram Moolenaarb1040dc2022-05-18 11:00:48 +01005790 if (r == FAIL)
5791 goto on_error;
Bram Moolenaar5e654232020-09-16 15:22:00 +02005792
5793 // number 0 is FALSE, number 1 is TRUE
5794 if (tv->v_type == VAR_NUMBER
5795 && ct->ct_type->tt_type == VAR_BOOL
5796 && (tv->vval.v_number == 0
5797 || tv->vval.v_number == 1))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005798 {
Bram Moolenaar5e654232020-09-16 15:22:00 +02005799 tv->v_type = VAR_BOOL;
5800 tv->vval.v_number = tv->vval.v_number
Bram Moolenaardadaddd2020-09-12 19:11:23 +02005801 ? VVAL_TRUE : VVAL_FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005802 }
5803 }
5804 break;
5805
Bram Moolenaar9af78762020-06-16 11:34:42 +02005806 case ISN_CHECKLEN:
5807 {
5808 int min_len = iptr->isn_arg.checklen.cl_min_len;
5809 list_T *list = NULL;
5810
5811 tv = STACK_TV_BOT(-1);
5812 if (tv->v_type == VAR_LIST)
5813 list = tv->vval.v_list;
5814 if (list == NULL || list->lv_len < min_len
5815 || (list->lv_len > min_len
5816 && !iptr->isn_arg.checklen.cl_more_OK))
5817 {
Bram Moolenaar7517ffd2020-08-14 18:35:07 +02005818 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar451c2e32020-08-15 16:33:28 +02005819 semsg(_(e_expected_nr_items_but_got_nr),
Bram Moolenaar9af78762020-06-16 11:34:42 +02005820 min_len, list == NULL ? 0 : list->lv_len);
Bram Moolenaarf0b9f432020-07-17 23:03:17 +02005821 goto on_error;
Bram Moolenaar9af78762020-06-16 11:34:42 +02005822 }
5823 }
5824 break;
5825
Bram Moolenaaraa210a32021-01-02 15:41:03 +01005826 case ISN_SETTYPE:
Bram Moolenaar381692b2022-02-02 20:01:27 +00005827 set_tv_type(STACK_TV_BOT(-1), iptr->isn_arg.type.ct_type);
Bram Moolenaaraa210a32021-01-02 15:41:03 +01005828 break;
5829
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005830 case ISN_2BOOL:
Bram Moolenaar2bb26582020-10-03 22:52:39 +02005831 case ISN_COND2BOOL:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005832 {
5833 int n;
Bram Moolenaar2bb26582020-10-03 22:52:39 +02005834 int error = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005835
Bram Moolenaar2bb26582020-10-03 22:52:39 +02005836 if (iptr->isn_type == ISN_2BOOL)
5837 {
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02005838 tv = STACK_TV_BOT(iptr->isn_arg.tobool.offset);
Bram Moolenaar2bb26582020-10-03 22:52:39 +02005839 n = tv2bool(tv);
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02005840 if (iptr->isn_arg.tobool.invert)
Bram Moolenaar2bb26582020-10-03 22:52:39 +02005841 n = !n;
5842 }
5843 else
5844 {
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02005845 tv = STACK_TV_BOT(-1);
Bram Moolenaar2bb26582020-10-03 22:52:39 +02005846 SOURCING_LNUM = iptr->isn_lnum;
5847 n = tv_get_bool_chk(tv, &error);
5848 if (error)
5849 goto on_error;
5850 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005851 clear_tv(tv);
5852 tv->v_type = VAR_BOOL;
5853 tv->vval.v_number = n ? VVAL_TRUE : VVAL_FALSE;
5854 }
5855 break;
5856
5857 case ISN_2STRING:
Bram Moolenaar418f1df2020-08-12 21:34:49 +02005858 case ISN_2STRING_ANY:
Bram Moolenaar0acbf5a2021-01-05 20:58:25 +01005859 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02005860 if (do_2string(STACK_TV_BOT(iptr->isn_arg.tostring.offset),
5861 iptr->isn_type == ISN_2STRING_ANY,
Yegappan Lakshmananbce51d92024-04-15 19:19:52 +02005862 iptr->isn_arg.tostring.flags) == FAIL)
Bram Moolenaar4f5e3972020-12-21 17:30:50 +01005863 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005864 break;
5865
Bram Moolenaar08597872020-12-10 19:43:40 +01005866 case ISN_RANGE:
5867 {
5868 exarg_T ea;
5869 char *errormsg;
5870
Bram Moolenaarece0b872021-01-08 20:40:45 +01005871 ea.line2 = 0;
Bram Moolenaard1510ee2021-01-04 16:15:58 +01005872 ea.addr_count = 0;
Bram Moolenaar08597872020-12-10 19:43:40 +01005873 ea.addr_type = ADDR_LINES;
5874 ea.cmd = iptr->isn_arg.string;
Bram Moolenaarece0b872021-01-08 20:40:45 +01005875 ea.skip = FALSE;
Bram Moolenaar08597872020-12-10 19:43:40 +01005876 if (parse_cmd_address(&ea, &errormsg, FALSE) == FAIL)
Bram Moolenaarece0b872021-01-08 20:40:45 +01005877 goto on_error;
Bram Moolenaara28639e2021-01-19 22:48:09 +01005878
Bram Moolenaar35578162021-08-02 19:10:38 +02005879 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02005880 goto theend;
Bram Moolenaar4c137212021-04-19 16:48:48 +02005881 ++ectx->ec_stack.ga_len;
Bram Moolenaara28639e2021-01-19 22:48:09 +01005882 tv = STACK_TV_BOT(-1);
5883 tv->v_type = VAR_NUMBER;
5884 tv->v_lock = 0;
Bram Moolenaar06651632022-04-27 17:54:25 +01005885 tv->vval.v_number = ea.line2;
Bram Moolenaar08597872020-12-10 19:43:40 +01005886 }
5887 break;
5888
Bram Moolenaarc3516f72020-09-08 22:45:35 +02005889 case ISN_PUT:
5890 {
5891 int regname = iptr->isn_arg.put.put_regname;
5892 linenr_T lnum = iptr->isn_arg.put.put_lnum;
5893 char_u *expr = NULL;
5894 int dir = FORWARD;
5895
Bram Moolenaar08597872020-12-10 19:43:40 +01005896 if (lnum < -2)
5897 {
5898 // line number was put on the stack by ISN_RANGE
5899 tv = STACK_TV_BOT(-1);
5900 curwin->w_cursor.lnum = tv->vval.v_number;
5901 if (lnum == LNUM_VARIABLE_RANGE_ABOVE)
5902 dir = BACKWARD;
Bram Moolenaar4c137212021-04-19 16:48:48 +02005903 --ectx->ec_stack.ga_len;
Bram Moolenaar08597872020-12-10 19:43:40 +01005904 }
5905 else if (lnum == -2)
Bram Moolenaarc3516f72020-09-08 22:45:35 +02005906 // :put! above cursor
5907 dir = BACKWARD;
5908 else if (lnum >= 0)
Bram Moolenaar4e713ba2022-02-07 15:31:37 +00005909 {
5910 curwin->w_cursor.lnum = lnum;
5911 if (lnum == 0)
5912 // check_cursor() below will move to line 1
5913 dir = BACKWARD;
5914 }
Bram Moolenaara28639e2021-01-19 22:48:09 +01005915
5916 if (regname == '=')
5917 {
5918 tv = STACK_TV_BOT(-1);
5919 if (tv->v_type == VAR_STRING)
5920 expr = tv->vval.v_string;
5921 else
5922 {
5923 expr = typval2string(tv, TRUE); // allocates value
5924 clear_tv(tv);
5925 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02005926 --ectx->ec_stack.ga_len;
Bram Moolenaara28639e2021-01-19 22:48:09 +01005927 }
Bram Moolenaarc3516f72020-09-08 22:45:35 +02005928 check_cursor();
5929 do_put(regname, expr, dir, 1L, PUT_LINE|PUT_CURSLINE);
5930 vim_free(expr);
5931 }
5932 break;
5933
Bram Moolenaar02194d22020-10-24 23:08:38 +02005934 case ISN_CMDMOD:
Bram Moolenaar4c137212021-04-19 16:48:48 +02005935 ectx->ec_funclocal.floc_save_cmdmod = cmdmod;
5936 ectx->ec_funclocal.floc_restore_cmdmod = TRUE;
5937 ectx->ec_funclocal.floc_restore_cmdmod_stacklen =
5938 ectx->ec_stack.ga_len;
Bram Moolenaar02194d22020-10-24 23:08:38 +02005939 cmdmod = *iptr->isn_arg.cmdmod.cf_cmdmod;
5940 apply_cmdmod(&cmdmod);
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +02005941 break;
5942
Bram Moolenaar02194d22020-10-24 23:08:38 +02005943 case ISN_CMDMOD_REV:
5944 // filter regprog is owned by the instruction, don't free it
5945 cmdmod.cmod_filter_regmatch.regprog = NULL;
5946 undo_cmdmod(&cmdmod);
Bram Moolenaar4c137212021-04-19 16:48:48 +02005947 cmdmod = ectx->ec_funclocal.floc_save_cmdmod;
5948 ectx->ec_funclocal.floc_restore_cmdmod = FALSE;
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +02005949 break;
5950
Bram Moolenaar792f7862020-11-23 08:31:18 +01005951 case ISN_UNPACK:
5952 {
5953 int count = iptr->isn_arg.unpack.unp_count;
5954 int semicolon = iptr->isn_arg.unpack.unp_semicolon;
5955 list_T *l;
5956 listitem_T *li;
5957 int i;
5958
5959 // Check there is a valid list to unpack.
5960 tv = STACK_TV_BOT(-1);
5961 if (tv->v_type != VAR_LIST)
5962 {
5963 SOURCING_LNUM = iptr->isn_lnum;
5964 emsg(_(e_for_argument_must_be_sequence_of_lists));
5965 goto on_error;
5966 }
5967 l = tv->vval.v_list;
5968 if (l == NULL
5969 || l->lv_len < (semicolon ? count - 1 : count))
5970 {
5971 SOURCING_LNUM = iptr->isn_lnum;
5972 emsg(_(e_list_value_does_not_have_enough_items));
5973 goto on_error;
5974 }
5975 else if (!semicolon && l->lv_len > count)
5976 {
5977 SOURCING_LNUM = iptr->isn_lnum;
5978 emsg(_(e_list_value_has_more_items_than_targets));
5979 goto on_error;
5980 }
5981
5982 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar35578162021-08-02 19:10:38 +02005983 if (GA_GROW_FAILS(&ectx->ec_stack, count - 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02005984 goto theend;
Bram Moolenaar4c137212021-04-19 16:48:48 +02005985 ectx->ec_stack.ga_len += count - 1;
Bram Moolenaar792f7862020-11-23 08:31:18 +01005986
5987 // Variable after semicolon gets a list with the remaining
5988 // items.
5989 if (semicolon)
5990 {
5991 list_T *rem_list =
5992 list_alloc_with_items(l->lv_len - count + 1);
5993
5994 if (rem_list == NULL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02005995 goto theend;
Bram Moolenaar792f7862020-11-23 08:31:18 +01005996 tv = STACK_TV_BOT(-count);
5997 tv->vval.v_list = rem_list;
5998 ++rem_list->lv_refcount;
5999 tv->v_lock = 0;
6000 li = l->lv_first;
6001 for (i = 0; i < count - 1; ++i)
6002 li = li->li_next;
6003 for (i = 0; li != NULL; ++i)
6004 {
Bram Moolenaar61efa162022-03-18 13:10:48 +00006005 typval_T tvcopy;
6006
6007 copy_tv(&li->li_tv, &tvcopy);
6008 list_set_item(rem_list, i, &tvcopy);
Bram Moolenaar792f7862020-11-23 08:31:18 +01006009 li = li->li_next;
6010 }
6011 --count;
6012 }
6013
6014 // Produce the values in reverse order, first item last.
6015 li = l->lv_first;
6016 for (i = 0; i < count; ++i)
6017 {
6018 tv = STACK_TV_BOT(-i - 1);
6019 copy_tv(&li->li_tv, tv);
6020 li = li->li_next;
6021 }
6022
6023 list_unref(l);
6024 }
6025 break;
6026
Bram Moolenaarb2049902021-01-24 12:53:53 +01006027 case ISN_PROF_START:
6028 case ISN_PROF_END:
6029 {
Bram Moolenaarf002a412021-01-24 13:34:18 +01006030#ifdef FEAT_PROFILE
Bram Moolenaarca16c602022-09-06 18:57:08 +01006031 funccall_T cookie;
6032 ufunc_T *cur_ufunc =
Bram Moolenaarb2049902021-01-24 12:53:53 +01006033 (((dfunc_T *)def_functions.ga_data)
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02006034 + ectx->ec_dfunc_idx)->df_ufunc;
Bram Moolenaarb2049902021-01-24 12:53:53 +01006035
Bram Moolenaarca16c602022-09-06 18:57:08 +01006036 cookie.fc_func = cur_ufunc;
Bram Moolenaarb2049902021-01-24 12:53:53 +01006037 if (iptr->isn_type == ISN_PROF_START)
6038 {
6039 func_line_start(&cookie, iptr->isn_lnum);
6040 // if we get here the instruction is executed
6041 func_line_exec(&cookie);
6042 }
6043 else
6044 func_line_end(&cookie);
Bram Moolenaarf002a412021-01-24 13:34:18 +01006045#endif
Bram Moolenaarb2049902021-01-24 12:53:53 +01006046 }
6047 break;
6048
Bram Moolenaare99d4222021-06-13 14:01:26 +02006049 case ISN_DEBUG:
Bram Moolenaar4f8f5422021-06-20 19:28:14 +02006050 handle_debug(iptr, ectx);
Bram Moolenaare99d4222021-06-13 14:01:26 +02006051 break;
6052
Bram Moolenaar389df252020-07-09 21:20:47 +02006053 case ISN_SHUFFLE:
6054 {
Bram Moolenaar792f7862020-11-23 08:31:18 +01006055 typval_T tmp_tv;
6056 int item = iptr->isn_arg.shuffle.shfl_item;
6057 int up = iptr->isn_arg.shuffle.shfl_up;
Bram Moolenaar389df252020-07-09 21:20:47 +02006058
6059 tmp_tv = *STACK_TV_BOT(-item);
6060 for ( ; up > 0 && item > 1; --up)
6061 {
6062 *STACK_TV_BOT(-item) = *STACK_TV_BOT(-item + 1);
6063 --item;
6064 }
6065 *STACK_TV_BOT(-item) = tmp_tv;
6066 }
6067 break;
6068
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006069 case ISN_DROP:
Bram Moolenaar4c137212021-04-19 16:48:48 +02006070 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006071 clear_tv(STACK_TV_BOT(0));
LemonBoyc5d27442023-08-19 13:02:35 +02006072 ectx->ec_where = (where_T)WHERE_INIT;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006073 break;
6074 }
Bram Moolenaarf0b9f432020-07-17 23:03:17 +02006075 continue;
6076
Bram Moolenaard032f342020-07-18 18:13:02 +02006077func_return:
Bram Moolenaar7cbfaa52020-09-18 21:25:32 +02006078 // Restore previous function. If the frame pointer is where we started
6079 // then there is none and we are done.
Bram Moolenaar4c137212021-04-19 16:48:48 +02006080 if (ectx->ec_frame_idx == ectx->ec_initial_frame_idx)
Bram Moolenaard032f342020-07-18 18:13:02 +02006081 goto done;
Bram Moolenaar7cbfaa52020-09-18 21:25:32 +02006082
Bram Moolenaar4c137212021-04-19 16:48:48 +02006083 if (func_return(ectx) == FAIL)
Bram Moolenaard032f342020-07-18 18:13:02 +02006084 // only fails when out of memory
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02006085 goto theend;
Bram Moolenaarc7db5772020-07-21 20:55:50 +02006086 continue;
Bram Moolenaard032f342020-07-18 18:13:02 +02006087
Bram Moolenaarf0b9f432020-07-17 23:03:17 +02006088on_error:
Bram Moolenaaraf0df472020-12-02 20:51:22 +01006089 // Jump here for an error that does not require aborting execution.
Bram Moolenaar56602ba2020-12-05 21:22:08 +01006090 // If "emsg_silent" is set then ignore the error, unless it was set
6091 // when calling the function.
Bram Moolenaar4c137212021-04-19 16:48:48 +02006092 if (did_emsg_cumul + did_emsg == ectx->ec_did_emsg_before
Bram Moolenaar56602ba2020-12-05 21:22:08 +01006093 && emsg_silent && did_emsg_def == 0)
Bram Moolenaarf9041332021-01-21 19:41:16 +01006094 {
6095 // If a sequence of instructions causes an error while ":silent!"
6096 // was used, restore the stack length and jump ahead to restoring
6097 // the cmdmod.
Bram Moolenaar4c137212021-04-19 16:48:48 +02006098 if (ectx->ec_funclocal.floc_restore_cmdmod)
Bram Moolenaarf9041332021-01-21 19:41:16 +01006099 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02006100 while (ectx->ec_stack.ga_len
6101 > ectx->ec_funclocal.floc_restore_cmdmod_stacklen)
Bram Moolenaarf9041332021-01-21 19:41:16 +01006102 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02006103 --ectx->ec_stack.ga_len;
Bram Moolenaarf9041332021-01-21 19:41:16 +01006104 clear_tv(STACK_TV_BOT(0));
6105 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02006106 while (ectx->ec_instr[ectx->ec_iidx].isn_type != ISN_CMDMOD_REV)
6107 ++ectx->ec_iidx;
Bram Moolenaarf9041332021-01-21 19:41:16 +01006108 }
Bram Moolenaarcd030c42020-10-30 21:49:40 +01006109 continue;
Bram Moolenaarf9041332021-01-21 19:41:16 +01006110 }
Bram Moolenaaraf0df472020-12-02 20:51:22 +01006111on_fatal_error:
6112 // Jump here for an error that messes up the stack.
Bram Moolenaar171fb922020-10-28 16:54:47 +01006113 // If we are not inside a try-catch started here, abort execution.
Bram Moolenaar4c137212021-04-19 16:48:48 +02006114 if (trylevel <= ectx->ec_trylevel_at_start)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02006115 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006116 }
6117
6118done:
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02006119 ret = OK;
6120theend:
Bram Moolenaar58779852022-09-06 18:31:14 +01006121 may_invoke_defer_funcs(ectx);
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006122
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02006123 dict_stack_clear(dict_stack_len_at_start);
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02006124 ectx->ec_trylevel_at_start = save_trylevel_at_start;
6125 return ret;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006126}
6127
6128/*
Bram Moolenaar806a2732022-09-04 15:40:36 +01006129 * Execute the instructions from a VAR_INSTR typval and put the result in
Bram Moolenaarf18332f2021-05-07 17:55:55 +02006130 * "rettv".
6131 * Return OK or FAIL.
6132 */
6133 int
6134exe_typval_instr(typval_T *tv, typval_T *rettv)
6135{
6136 ectx_T *ectx = tv->vval.v_instr->instr_ectx;
6137 isn_T *save_instr = ectx->ec_instr;
6138 int save_iidx = ectx->ec_iidx;
6139 int res;
6140
LemonBoyf3b48952022-05-05 13:53:03 +01006141 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
6142 // even when the compilation fails.
6143 rettv->v_type = VAR_UNKNOWN;
6144
Bram Moolenaarf18332f2021-05-07 17:55:55 +02006145 ectx->ec_instr = tv->vval.v_instr->instr_instr;
6146 res = exec_instructions(ectx);
6147 if (res == OK)
6148 {
6149 *rettv = *STACK_TV_BOT(-1);
6150 --ectx->ec_stack.ga_len;
6151 }
6152
6153 ectx->ec_instr = save_instr;
6154 ectx->ec_iidx = save_iidx;
6155
6156 return res;
6157}
6158
6159/*
Bram Moolenaar4c137212021-04-19 16:48:48 +02006160 * Execute the instructions from an ISN_SUBSTITUTE command, which are in
6161 * "substitute_instr".
6162 */
6163 char_u *
6164exe_substitute_instr(void)
6165{
6166 ectx_T *ectx = substitute_instr->subs_ectx;
6167 isn_T *save_instr = ectx->ec_instr;
6168 int save_iidx = ectx->ec_iidx;
6169 char_u *res;
6170
6171 ectx->ec_instr = substitute_instr->subs_instr;
6172 if (exec_instructions(ectx) == OK)
Bram Moolenaar90193e62021-04-04 20:49:50 +02006173 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02006174 typval_T *tv = STACK_TV_BOT(-1);
6175
Bram Moolenaar27523602021-06-05 21:36:19 +02006176 res = typval2string(tv, TRUE);
Bram Moolenaar4c137212021-04-19 16:48:48 +02006177 --ectx->ec_stack.ga_len;
6178 clear_tv(tv);
Bram Moolenaar90193e62021-04-04 20:49:50 +02006179 }
6180 else
6181 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02006182 substitute_instr->subs_status = FAIL;
6183 res = vim_strsave((char_u *)"");
Bram Moolenaar90193e62021-04-04 20:49:50 +02006184 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006185
Bram Moolenaar4c137212021-04-19 16:48:48 +02006186 ectx->ec_instr = save_instr;
6187 ectx->ec_iidx = save_iidx;
6188
6189 return res;
6190}
6191
6192/*
6193 * Call a "def" function from old Vim script.
6194 * Return OK or FAIL.
6195 */
6196 int
6197call_def_function(
6198 ufunc_T *ufunc,
6199 int argc_arg, // nr of arguments
6200 typval_T *argv, // arguments
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01006201 int flags, // DEF_ flags
Bram Moolenaar4c137212021-04-19 16:48:48 +02006202 partial_T *partial, // optional partial for context
Bram Moolenaarffdaca92022-12-09 21:41:48 +00006203 object_T *object, // object, e.g. for this.Func()
Bram Moolenaar58779852022-09-06 18:31:14 +01006204 funccall_T *funccal,
Bram Moolenaar4c137212021-04-19 16:48:48 +02006205 typval_T *rettv) // return value
6206{
6207 ectx_T ectx; // execution context
6208 int argc = argc_arg;
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01006209 int partial_argc = partial == NULL
6210 || (flags & DEF_USE_PT_ARGV) == 0
6211 ? 0 : partial->pt_argc;
6212 int total_argc = argc + partial_argc;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006213 typval_T *tv;
6214 int idx;
6215 int ret = FAIL;
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01006216 int defcount = ufunc->uf_args.ga_len - total_argc;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006217 sctx_T save_current_sctx = current_sctx;
6218 int did_emsg_before = did_emsg_cumul + did_emsg;
6219 int save_suppress_errthrow = suppress_errthrow;
6220 msglist_T **saved_msg_list = NULL;
6221 msglist_T *private_msg_list = NULL;
6222 int save_emsg_silent_def = emsg_silent_def;
6223 int save_did_emsg_def = did_emsg_def;
6224 int orig_funcdepth;
Bram Moolenaare99d4222021-06-13 14:01:26 +02006225 int orig_nesting_level = ex_nesting_level;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006226
6227// Get pointer to item in the stack.
6228#undef STACK_TV
6229#define STACK_TV(idx) (((typval_T *)ectx.ec_stack.ga_data) + idx)
6230
6231// Get pointer to item at the bottom of the stack, -1 is the bottom.
6232#undef STACK_TV_BOT
6233#define STACK_TV_BOT(idx) (((typval_T *)ectx.ec_stack.ga_data) + ectx.ec_stack.ga_len + idx)
6234
6235// Get pointer to a local variable on the stack. Negative for arguments.
6236#undef STACK_TV_VAR
6237#define STACK_TV_VAR(idx) (((typval_T *)ectx.ec_stack.ga_data) + ectx.ec_frame_idx + STACK_FRAME_SIZE + idx)
6238
6239 if (ufunc->uf_def_status == UF_NOT_COMPILED
6240 || ufunc->uf_def_status == UF_COMPILE_ERROR
Bram Moolenaar139575d2022-03-15 19:29:30 +00006241 || (func_needs_compiling(ufunc, get_compile_type(ufunc))
6242 && compile_def_function(ufunc, FALSE,
6243 get_compile_type(ufunc), NULL) == FAIL))
Bram Moolenaar4c137212021-04-19 16:48:48 +02006244 {
6245 if (did_emsg_cumul + did_emsg == did_emsg_before)
6246 semsg(_(e_function_is_not_compiled_str),
6247 printable_func_name(ufunc));
6248 return FAIL;
6249 }
6250
6251 {
6252 // Check the function was really compiled.
6253 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
6254 + ufunc->uf_dfunc_idx;
Bram Moolenaarcc341812022-09-19 15:54:34 +01006255 if (dfunc->df_ufunc == NULL)
6256 {
6257 semsg(_(e_function_was_deleted_str), printable_func_name(ufunc));
6258 return FAIL;
6259 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02006260 if (INSTRUCTIONS(dfunc) == NULL)
6261 {
6262 iemsg("using call_def_function() on not compiled function");
6263 return FAIL;
6264 }
6265 }
6266
6267 // If depth of calling is getting too high, don't execute the function.
6268 orig_funcdepth = funcdepth_get();
6269 if (funcdepth_increment() == FAIL)
6270 return FAIL;
6271
6272 CLEAR_FIELD(ectx);
6273 ectx.ec_dfunc_idx = ufunc->uf_dfunc_idx;
6274 ga_init2(&ectx.ec_stack, sizeof(typval_T), 500);
Bram Moolenaar35578162021-08-02 19:10:38 +02006275 if (GA_GROW_FAILS(&ectx.ec_stack, 20))
Bram Moolenaar4c137212021-04-19 16:48:48 +02006276 {
6277 funcdepth_decrement();
6278 return FAIL;
6279 }
6280 ga_init2(&ectx.ec_trystack, sizeof(trycmd_T), 10);
6281 ga_init2(&ectx.ec_funcrefs, sizeof(partial_T *), 10);
6282 ectx.ec_did_emsg_before = did_emsg_before;
Bram Moolenaare99d4222021-06-13 14:01:26 +02006283 ++ex_nesting_level;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006284
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01006285 idx = total_argc - ufunc->uf_args.ga_len;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006286 if (idx > 0 && ufunc->uf_va_name == NULL)
6287 {
Matvey Tarasovd14bb1a2022-06-29 13:18:27 +01006288 semsg(NGETTEXT(e_one_argument_too_many, e_nr_arguments_too_many,
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01006289 idx), idx);
Bram Moolenaar4c137212021-04-19 16:48:48 +02006290 goto failed_early;
6291 }
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01006292 idx = total_argc - ufunc->uf_args.ga_len + ufunc->uf_def_args.ga_len;
Bram Moolenaarc6d71532021-06-05 18:49:38 +02006293 if (idx < 0)
Bram Moolenaar8da6d6d2021-06-05 18:15:09 +02006294 {
Matvey Tarasovd14bb1a2022-06-29 13:18:27 +01006295 semsg(NGETTEXT(e_one_argument_too_few, e_nr_arguments_too_few,
Bram Moolenaar98aff652022-09-06 21:02:35 +01006296 -idx), -idx);
Bram Moolenaar8da6d6d2021-06-05 18:15:09 +02006297 goto failed_early;
6298 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02006299
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01006300 // Put values from the partial and arguments on the stack, but no more than
6301 // what the function expects. A lambda can be called with more arguments
6302 // than it uses.
6303 for (idx = 0; idx < total_argc
Bram Moolenaar4c137212021-04-19 16:48:48 +02006304 && (ufunc->uf_va_name != NULL || idx < ufunc->uf_args.ga_len);
6305 ++idx)
6306 {
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01006307 int argv_idx = idx - partial_argc;
6308
6309 tv = idx < partial_argc ? partial->pt_argv + idx : argv + argv_idx;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006310 if (idx >= ufunc->uf_args.ga_len - ufunc->uf_def_args.ga_len
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01006311 && tv->v_type == VAR_SPECIAL
6312 && tv->vval.v_number == VVAL_NONE)
Bram Moolenaar4c137212021-04-19 16:48:48 +02006313 {
6314 // Use the default value.
6315 STACK_TV_BOT(0)->v_type = VAR_UNKNOWN;
6316 }
6317 else
6318 {
Bram Moolenaar47bba532023-01-20 18:49:46 +00006319 int done = FALSE;
6320 if (ufunc->uf_arg_types != NULL && idx < ufunc->uf_args.ga_len)
6321 {
6322 type_T *expected = ufunc->uf_arg_types[idx];
6323 if (expected->tt_type == VAR_FLOAT && tv->v_type == VAR_NUMBER)
6324 {
6325 // When a float is expected and a number was given, convert
6326 // the value.
6327 STACK_TV_BOT(0)->v_type = VAR_FLOAT;
6328 STACK_TV_BOT(0)->v_lock = 0;
6329 STACK_TV_BOT(0)->vval.v_float = tv->vval.v_number;
6330 done = TRUE;
6331 }
6332 else if (check_typval_arg_type(expected, tv,
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01006333 NULL, argv_idx + 1) == FAIL)
Bram Moolenaar47bba532023-01-20 18:49:46 +00006334 goto failed_early;
Yegappan Lakshmanan92195ae2024-12-22 14:44:35 +01006335 }
Bram Moolenaar47bba532023-01-20 18:49:46 +00006336 if (!done)
6337 copy_tv(tv, STACK_TV_BOT(0));
Bram Moolenaar4c137212021-04-19 16:48:48 +02006338 }
6339 ++ectx.ec_stack.ga_len;
6340 }
6341
6342 // Turn varargs into a list. Empty list if no args.
6343 if (ufunc->uf_va_name != NULL)
6344 {
6345 int vararg_count = argc - ufunc->uf_args.ga_len;
6346
6347 if (vararg_count < 0)
6348 vararg_count = 0;
6349 else
6350 argc -= vararg_count;
6351 if (exe_newlist(vararg_count, &ectx) == FAIL)
6352 goto failed_early;
6353
6354 // Check the type of the list items.
6355 tv = STACK_TV_BOT(-1);
6356 if (ufunc->uf_va_type != NULL
6357 && ufunc->uf_va_type != &t_list_any
6358 && ufunc->uf_va_type->tt_member != &t_any
6359 && tv->vval.v_list != NULL)
6360 {
6361 type_T *expected = ufunc->uf_va_type->tt_member;
6362 listitem_T *li = tv->vval.v_list->lv_first;
6363
6364 for (idx = 0; idx < vararg_count; ++idx)
6365 {
6366 if (check_typval_arg_type(expected, &li->li_tv,
Bram Moolenaar7a3fe3e2021-07-22 14:58:47 +02006367 NULL, argc + idx + 1) == FAIL)
Bram Moolenaar4c137212021-04-19 16:48:48 +02006368 goto failed_early;
6369 li = li->li_next;
6370 }
6371 }
6372
6373 if (defcount > 0)
6374 // Move varargs list to below missing default arguments.
6375 *STACK_TV_BOT(defcount - 1) = *STACK_TV_BOT(-1);
6376 --ectx.ec_stack.ga_len;
6377 }
6378
6379 // Make space for omitted arguments, will store default value below.
6380 // Any varargs list goes after them.
6381 if (defcount > 0)
6382 for (idx = 0; idx < defcount; ++idx)
6383 {
6384 STACK_TV_BOT(0)->v_type = VAR_UNKNOWN;
6385 ++ectx.ec_stack.ga_len;
6386 }
6387 if (ufunc->uf_va_name != NULL)
6388 ++ectx.ec_stack.ga_len;
6389
6390 // Frame pointer points to just after arguments.
6391 ectx.ec_frame_idx = ectx.ec_stack.ga_len;
6392 ectx.ec_initial_frame_idx = ectx.ec_frame_idx;
6393
6394 {
6395 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
6396 + ufunc->uf_dfunc_idx;
6397 ufunc_T *base_ufunc = dfunc->df_ufunc;
6398
6399 // "uf_partial" is on the ufunc that "df_ufunc" points to, as is done
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01006400 // by copy_lambda_to_global_func().
Bram Moolenaar4c137212021-04-19 16:48:48 +02006401 if (partial != NULL || base_ufunc->uf_partial != NULL)
6402 {
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02006403 ectx.ec_outer_ref = ALLOC_CLEAR_ONE(outer_ref_T);
6404 if (ectx.ec_outer_ref == NULL)
Bram Moolenaar4c137212021-04-19 16:48:48 +02006405 goto failed_early;
6406 if (partial != NULL)
6407 {
Bram Moolenaar7aca5ca2022-02-07 19:56:43 +00006408 outer_T *outer = get_pt_outer(partial);
6409
Bram Moolenaar6d313be2022-09-22 16:36:25 +01006410 if (outer->out_stack == NULL && outer->out_loop_size == 0)
Bram Moolenaar4c137212021-04-19 16:48:48 +02006411 {
Bram Moolenaar6d313be2022-09-22 16:36:25 +01006412 // no stack was set
Bram Moolenaarfe1bfc92022-02-06 13:55:03 +00006413 if (current_ectx != NULL)
6414 {
6415 if (current_ectx->ec_outer_ref != NULL
6416 && current_ectx->ec_outer_ref->or_outer != NULL)
6417 ectx.ec_outer_ref->or_outer =
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02006418 current_ectx->ec_outer_ref->or_outer;
Bram Moolenaarfe1bfc92022-02-06 13:55:03 +00006419 }
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01006420 // else: should there be an error here?
Bram Moolenaar4c137212021-04-19 16:48:48 +02006421 }
6422 else
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02006423 {
Bram Moolenaar7aca5ca2022-02-07 19:56:43 +00006424 ectx.ec_outer_ref->or_outer = outer;
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02006425 ++partial->pt_refcount;
6426 ectx.ec_outer_ref->or_partial = partial;
6427 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02006428 }
6429 else
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02006430 {
6431 ectx.ec_outer_ref->or_outer = &base_ufunc->uf_partial->pt_outer;
6432 ++base_ufunc->uf_partial->pt_refcount;
6433 ectx.ec_outer_ref->or_partial = base_ufunc->uf_partial;
6434 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02006435 }
6436 }
6437
6438 // dummy frame entries
6439 for (idx = 0; idx < STACK_FRAME_SIZE; ++idx)
6440 {
6441 STACK_TV(ectx.ec_stack.ga_len)->v_type = VAR_UNKNOWN;
6442 ++ectx.ec_stack.ga_len;
6443 }
6444
6445 {
6446 // Reserve space for local variables and any closure reference count.
6447 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
6448 + ufunc->uf_dfunc_idx;
6449
Bram Moolenaar5cd64792021-12-25 18:23:24 +00006450 // Initialize variables to zero. That avoids having to generate
6451 // initializing instructions for "var nr: number", "var x: any", etc.
Bram Moolenaar4c137212021-04-19 16:48:48 +02006452 for (idx = 0; idx < dfunc->df_varcount; ++idx)
Bram Moolenaar5cd64792021-12-25 18:23:24 +00006453 {
6454 STACK_TV_VAR(idx)->v_type = VAR_NUMBER;
6455 STACK_TV_VAR(idx)->vval.v_number = 0;
6456 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02006457 ectx.ec_stack.ga_len += dfunc->df_varcount;
Bram Moolenaarffdaca92022-12-09 21:41:48 +00006458
6459 if (object != NULL)
6460 {
6461 // the object is always the variable at index zero
6462 tv = STACK_TV_VAR(0);
6463 tv->v_type = VAR_OBJECT;
6464 tv->vval.v_object = object;
6465 }
6466
Bram Moolenaar4c137212021-04-19 16:48:48 +02006467 if (dfunc->df_has_closure)
6468 {
Bram Moolenaarcc341812022-09-19 15:54:34 +01006469 // Initialize the variable that counts how many closures were
6470 // created. This is used in handle_closure_in_use().
Bram Moolenaar4c137212021-04-19 16:48:48 +02006471 STACK_TV_VAR(idx)->v_type = VAR_NUMBER;
6472 STACK_TV_VAR(idx)->vval.v_number = 0;
6473 ++ectx.ec_stack.ga_len;
6474 }
6475
6476 ectx.ec_instr = INSTRUCTIONS(dfunc);
6477 }
6478
Bram Moolenaar58779852022-09-06 18:31:14 +01006479 // Store the execution context in funccal, used by invoke_all_defer().
6480 if (funccal != NULL)
6481 funccal->fc_ectx = &ectx;
6482
Bram Moolenaar4c137212021-04-19 16:48:48 +02006483 // Following errors are in the function, not the caller.
6484 // Commands behave like vim9script.
6485 estack_push_ufunc(ufunc, 1);
6486 current_sctx = ufunc->uf_script_ctx;
6487 current_sctx.sc_version = SCRIPT_VERSION_VIM9;
6488
6489 // Use a specific location for storing error messages to be converted to an
6490 // exception.
6491 saved_msg_list = msg_list;
6492 msg_list = &private_msg_list;
6493
6494 // Do turn errors into exceptions.
6495 suppress_errthrow = FALSE;
6496
6497 // Do not delete the function while executing it.
6498 ++ufunc->uf_calls;
6499
6500 // When ":silent!" was used before calling then we still abort the
6501 // function. If ":silent!" is used in the function then we don't.
6502 emsg_silent_def = emsg_silent;
6503 did_emsg_def = 0;
6504
LemonBoyc5d27442023-08-19 13:02:35 +02006505 ectx.ec_where = (where_T)WHERE_INIT;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006506
Bram Moolenaar5800c792022-09-22 17:34:01 +01006507 /*
6508 * Execute the instructions until done.
6509 */
Bram Moolenaar4c137212021-04-19 16:48:48 +02006510 ret = exec_instructions(&ectx);
6511 if (ret == OK)
6512 {
6513 // function finished, get result from the stack.
6514 if (ufunc->uf_ret_type == &t_void)
6515 {
6516 rettv->v_type = VAR_VOID;
6517 }
6518 else
6519 {
6520 tv = STACK_TV_BOT(-1);
6521 *rettv = *tv;
6522 tv->v_type = VAR_UNKNOWN;
6523 }
6524 }
6525
Bram Moolenaar7eeefd42020-02-26 21:24:23 +01006526 // When failed need to unwind the call stack.
Bram Moolenaar58779852022-09-06 18:31:14 +01006527 unwind_def_callstack(&ectx);
Bram Moolenaarbf67ea12020-05-02 17:52:42 +02006528
Bram Moolenaarc70bdab2020-09-26 19:59:38 +02006529 // Deal with any remaining closures, they may be in use somewhere.
6530 if (ectx.ec_funcrefs.ga_len > 0)
Bram Moolenaarf112f302020-12-20 17:47:52 +01006531 {
Bram Moolenaarc70bdab2020-09-26 19:59:38 +02006532 handle_closure_in_use(&ectx, FALSE);
Bram Moolenaardc7c3662021-12-20 15:04:29 +00006533 ga_clear(&ectx.ec_funcrefs);
Bram Moolenaarf112f302020-12-20 17:47:52 +01006534 }
Bram Moolenaarc70bdab2020-09-26 19:59:38 +02006535
Bram Moolenaaree8580e2020-08-28 17:19:07 +02006536 estack_pop();
6537 current_sctx = save_current_sctx;
6538
Bram Moolenaar2336c372021-12-06 15:06:54 +00006539 if (--ufunc->uf_calls <= 0 && ufunc->uf_refcount <= 0)
6540 // Function was unreferenced while being used, free it now.
6541 func_clear_free(ufunc, FALSE);
Bram Moolenaarc970e422021-03-17 15:03:04 +01006542
Bram Moolenaar352134b2020-10-17 22:04:08 +02006543 if (*msg_list != NULL && saved_msg_list != NULL)
6544 {
6545 msglist_T **plist = saved_msg_list;
6546
6547 // Append entries from the current msg_list (uncaught exceptions) to
6548 // the saved msg_list.
6549 while (*plist != NULL)
6550 plist = &(*plist)->next;
6551
6552 *plist = *msg_list;
6553 }
6554 msg_list = saved_msg_list;
6555
Bram Moolenaar4c137212021-04-19 16:48:48 +02006556 if (ectx.ec_funclocal.floc_restore_cmdmod)
Bram Moolenaar02194d22020-10-24 23:08:38 +02006557 {
6558 cmdmod.cmod_filter_regmatch.regprog = NULL;
6559 undo_cmdmod(&cmdmod);
Bram Moolenaar4c137212021-04-19 16:48:48 +02006560 cmdmod = ectx.ec_funclocal.floc_save_cmdmod;
Bram Moolenaar02194d22020-10-24 23:08:38 +02006561 }
Bram Moolenaar56602ba2020-12-05 21:22:08 +01006562 emsg_silent_def = save_emsg_silent_def;
6563 did_emsg_def += save_did_emsg_def;
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +02006564
Bram Moolenaaree8580e2020-08-28 17:19:07 +02006565failed_early:
Bram Moolenaar0d1f55c2022-04-05 17:30:29 +01006566 // Free all arguments and local variables.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006567 for (idx = 0; idx < ectx.ec_stack.ga_len; ++idx)
Bram Moolenaar1936c762022-09-28 15:19:10 +01006568 {
6569 tv = STACK_TV(idx);
6570 if (tv->v_type != VAR_NUMBER && tv->v_type != VAR_UNKNOWN)
6571 clear_tv(tv);
6572 }
Bram Moolenaare99d4222021-06-13 14:01:26 +02006573 ex_nesting_level = orig_nesting_level;
Bram Moolenaarbf67ea12020-05-02 17:52:42 +02006574
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006575 vim_free(ectx.ec_stack.ga_data);
Bram Moolenaar20431c92020-03-20 18:39:46 +01006576 vim_free(ectx.ec_trystack.ga_data);
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02006577 if (ectx.ec_outer_ref != NULL)
Bram Moolenaar0186e582021-01-10 18:33:11 +01006578 {
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02006579 if (ectx.ec_outer_ref->or_outer_allocated)
6580 vim_free(ectx.ec_outer_ref->or_outer);
6581 partial_unref(ectx.ec_outer_ref->or_partial);
6582 vim_free(ectx.ec_outer_ref);
Bram Moolenaar0186e582021-01-10 18:33:11 +01006583 }
6584
Bram Moolenaar77e5dcc2020-09-17 21:29:03 +02006585 // Not sure if this is necessary.
6586 suppress_errthrow = save_suppress_errthrow;
6587
Bram Moolenaarb5841b92021-07-15 18:09:53 +02006588 if (ret != OK && did_emsg_cumul + did_emsg == did_emsg_before
6589 && !need_rethrow)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02006590 semsg(_(e_unknown_error_while_executing_str),
Bram Moolenaar682d0a12020-07-19 20:48:59 +02006591 printable_func_name(ufunc));
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01006592 funcdepth_restore(orig_funcdepth);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006593 return ret;
6594}
6595
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006596/*
Bram Moolenaar58779852022-09-06 18:31:14 +01006597 * Called when a def function has finished (possibly failed).
6598 * Invoke all the function returns to clean up and invoke deferred functions,
6599 * except the toplevel one.
6600 */
6601 void
6602unwind_def_callstack(ectx_T *ectx)
6603{
6604 while (ectx->ec_frame_idx != ectx->ec_initial_frame_idx)
6605 func_return(ectx);
6606}
6607
6608/*
dundargocc57b5bc2022-11-02 13:30:51 +00006609 * Invoke any deferred functions for the top function in "ectx".
Bram Moolenaar58779852022-09-06 18:31:14 +01006610 */
6611 void
6612may_invoke_defer_funcs(ectx_T *ectx)
6613{
6614 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data) + ectx->ec_dfunc_idx;
6615
6616 if (dfunc->df_defer_var_idx > 0)
6617 invoke_defer_funcs(ectx);
6618}
6619
6620/*
Bram Moolenaarcc341812022-09-19 15:54:34 +01006621 * Return loopvarinfo in a printable form in allocated memory.
6622 */
6623 static char_u *
6624printable_loopvarinfo(loopvarinfo_T *lvi)
6625{
6626 garray_T ga;
6627 int depth;
6628
6629 ga_init2(&ga, 1, 100);
6630 for (depth = 0; depth < lvi->lvi_depth; ++depth)
6631 {
6632 if (ga_grow(&ga, 50) == FAIL)
6633 break;
6634 if (lvi->lvi_loop[depth].var_idx == 0)
Bram Moolenaarc9e4a6f2022-09-19 16:08:04 +01006635 STRCPY((char *)ga.ga_data + ga.ga_len, " -");
Bram Moolenaarcc341812022-09-19 15:54:34 +01006636 else
Bram Moolenaarc9e4a6f2022-09-19 16:08:04 +01006637 vim_snprintf((char *)ga.ga_data + ga.ga_len, 50, " $%d-$%d",
Bram Moolenaarcc341812022-09-19 15:54:34 +01006638 lvi->lvi_loop[depth].var_idx,
6639 lvi->lvi_loop[depth].var_idx
6640 + lvi->lvi_loop[depth].var_count - 1);
Bram Moolenaarc9e4a6f2022-09-19 16:08:04 +01006641 ga.ga_len = (int)STRLEN(ga.ga_data);
Bram Moolenaarcc341812022-09-19 15:54:34 +01006642 }
6643 return ga.ga_data;
6644}
6645
6646/*
Bram Moolenaar4c137212021-04-19 16:48:48 +02006647 * List instructions "instr" up to "instr_count" or until ISN_FINISH.
6648 * "ufunc" has the source lines, NULL for the instructions of ISN_SUBSTITUTE.
6649 * "pfx" is prefixed to every line.
6650 */
6651 static void
6652list_instructions(char *pfx, isn_T *instr, int instr_count, ufunc_T *ufunc)
6653{
6654 int line_idx = 0;
6655 int prev_current = 0;
6656 int current;
Bram Moolenaar9ce47ec2021-04-20 22:16:39 +02006657 int def_arg_idx = 0;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006658
6659 for (current = 0; current < instr_count; ++current)
6660 {
6661 isn_T *iptr = &instr[current];
6662 char *line;
6663
6664 if (ufunc != NULL)
Bram Moolenaar9ce47ec2021-04-20 22:16:39 +02006665 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02006666 while (line_idx < iptr->isn_lnum
6667 && line_idx < ufunc->uf_lines.ga_len)
6668 {
6669 if (current > prev_current)
6670 {
6671 msg_puts("\n\n");
6672 prev_current = current;
6673 }
6674 line = ((char **)ufunc->uf_lines.ga_data)[line_idx++];
6675 if (line != NULL)
6676 msg(line);
6677 }
Bram Moolenaar9ce47ec2021-04-20 22:16:39 +02006678 if (iptr->isn_type == ISN_JUMP_IF_ARG_SET)
6679 {
6680 int first_def_arg = ufunc->uf_args.ga_len
6681 - ufunc->uf_def_args.ga_len;
6682
6683 if (def_arg_idx > 0)
6684 msg_puts("\n\n");
6685 msg_start();
6686 msg_puts(" ");
6687 msg_puts(((char **)(ufunc->uf_args.ga_data))[
6688 first_def_arg + def_arg_idx]);
6689 msg_puts(" = ");
6690 msg_puts(((char **)(ufunc->uf_def_args.ga_data))[def_arg_idx++]);
6691 msg_clr_eos();
6692 msg_end();
6693 }
6694 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02006695
6696 switch (iptr->isn_type)
6697 {
Bram Moolenaar00b28d62022-12-08 15:32:33 +00006698 case ISN_CONSTRUCT:
6699 smsg("%s%4d NEW %s size %d", pfx, current,
6700 iptr->isn_arg.construct.construct_class->class_name,
6701 (int)iptr->isn_arg.construct.construct_size);
6702 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006703 case ISN_EXEC:
6704 smsg("%s%4d EXEC %s", pfx, current, iptr->isn_arg.string);
6705 break;
Bram Moolenaar20677332021-06-06 17:02:53 +02006706 case ISN_EXEC_SPLIT:
6707 smsg("%s%4d EXEC_SPLIT %s", pfx, current, iptr->isn_arg.string);
6708 break;
Bram Moolenaare4eed8c2021-12-01 15:22:56 +00006709 case ISN_EXECRANGE:
6710 smsg("%s%4d EXECRANGE %s", pfx, current, iptr->isn_arg.string);
6711 break;
Bram Moolenaar3b1373b2021-05-17 00:01:42 +02006712 case ISN_LEGACY_EVAL:
6713 smsg("%s%4d EVAL legacy %s", pfx, current,
6714 iptr->isn_arg.string);
6715 break;
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02006716 case ISN_REDIRSTART:
6717 smsg("%s%4d REDIR", pfx, current);
6718 break;
6719 case ISN_REDIREND:
6720 smsg("%s%4d REDIR END%s", pfx, current,
6721 iptr->isn_arg.number ? " append" : "");
6722 break;
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02006723 case ISN_CEXPR_AUCMD:
Bram Moolenaarb7c97812021-05-05 22:51:39 +02006724#ifdef FEAT_QUICKFIX
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02006725 smsg("%s%4d CEXPR pre %s", pfx, current,
6726 cexpr_get_auname(iptr->isn_arg.number));
Bram Moolenaarb7c97812021-05-05 22:51:39 +02006727#endif
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02006728 break;
6729 case ISN_CEXPR_CORE:
Bram Moolenaarb7c97812021-05-05 22:51:39 +02006730#ifdef FEAT_QUICKFIX
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02006731 {
6732 cexprref_T *cer = iptr->isn_arg.cexpr.cexpr_ref;
6733
6734 smsg("%s%4d CEXPR core %s%s \"%s\"", pfx, current,
6735 cexpr_get_auname(cer->cer_cmdidx),
6736 cer->cer_forceit ? "!" : "",
6737 cer->cer_cmdline);
6738 }
Bram Moolenaarb7c97812021-05-05 22:51:39 +02006739#endif
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02006740 break;
Bram Moolenaarf18332f2021-05-07 17:55:55 +02006741 case ISN_INSTR:
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01006742 smsg("%s%4d INSTR", pfx, current);
6743 list_instructions(" ", iptr->isn_arg.instr, INT_MAX, NULL);
6744 msg(" -------------");
6745 break;
6746 case ISN_SOURCE:
Bram Moolenaarf18332f2021-05-07 17:55:55 +02006747 {
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01006748 scriptitem_T *si = SCRIPT_ITEM(iptr->isn_arg.number);
6749
6750 smsg("%s%4d SOURCE %s", pfx, current, si->sn_name);
Bram Moolenaarf18332f2021-05-07 17:55:55 +02006751 }
6752 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006753 case ISN_SUBSTITUTE:
6754 {
6755 subs_T *subs = &iptr->isn_arg.subs;
6756
6757 smsg("%s%4d SUBSTITUTE %s", pfx, current, subs->subs_cmd);
6758 list_instructions(" ", subs->subs_instr, INT_MAX, NULL);
6759 msg(" -------------");
6760 }
6761 break;
6762 case ISN_EXECCONCAT:
6763 smsg("%s%4d EXECCONCAT %lld", pfx, current,
6764 (varnumber_T)iptr->isn_arg.number);
6765 break;
6766 case ISN_ECHO:
6767 {
6768 echo_T *echo = &iptr->isn_arg.echo;
6769
6770 smsg("%s%4d %s %d", pfx, current,
6771 echo->echo_with_white ? "ECHO" : "ECHON",
6772 echo->echo_count);
6773 }
6774 break;
6775 case ISN_EXECUTE:
6776 smsg("%s%4d EXECUTE %lld", pfx, current,
Bram Moolenaar7de62622021-08-07 15:05:47 +02006777 (varnumber_T)(iptr->isn_arg.number));
Bram Moolenaar4c137212021-04-19 16:48:48 +02006778 break;
6779 case ISN_ECHOMSG:
6780 smsg("%s%4d ECHOMSG %lld", pfx, current,
Bram Moolenaar7de62622021-08-07 15:05:47 +02006781 (varnumber_T)(iptr->isn_arg.number));
6782 break;
Bram Moolenaar7d7ad7b2022-09-01 16:00:53 +01006783 case ISN_ECHOWINDOW:
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01006784 if (iptr->isn_arg.echowin.ewin_time > 0)
6785 smsg("%s%4d ECHOWINDOW %d (%ld sec)", pfx, current,
6786 iptr->isn_arg.echowin.ewin_count,
6787 iptr->isn_arg.echowin.ewin_time);
6788 else
6789 smsg("%s%4d ECHOWINDOW %d", pfx, current,
6790 iptr->isn_arg.echowin.ewin_count);
Bram Moolenaar7d7ad7b2022-09-01 16:00:53 +01006791 break;
Bram Moolenaar7de62622021-08-07 15:05:47 +02006792 case ISN_ECHOCONSOLE:
6793 smsg("%s%4d ECHOCONSOLE %lld", pfx, current,
6794 (varnumber_T)(iptr->isn_arg.number));
Bram Moolenaar4c137212021-04-19 16:48:48 +02006795 break;
6796 case ISN_ECHOERR:
6797 smsg("%s%4d ECHOERR %lld", pfx, current,
Bram Moolenaar7de62622021-08-07 15:05:47 +02006798 (varnumber_T)(iptr->isn_arg.number));
Bram Moolenaar4c137212021-04-19 16:48:48 +02006799 break;
6800 case ISN_LOAD:
6801 {
6802 if (iptr->isn_arg.number < 0)
6803 smsg("%s%4d LOAD arg[%lld]", pfx, current,
6804 (varnumber_T)(iptr->isn_arg.number
6805 + STACK_FRAME_SIZE));
6806 else
6807 smsg("%s%4d LOAD $%lld", pfx, current,
6808 (varnumber_T)(iptr->isn_arg.number));
6809 }
6810 break;
6811 case ISN_LOADOUTER:
6812 {
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01006813 isn_outer_T *outer = &iptr->isn_arg.outer;
6814
6815 if (outer->outer_idx < 0)
Bram Moolenaar4c137212021-04-19 16:48:48 +02006816 smsg("%s%4d LOADOUTER level %d arg[%d]", pfx, current,
Bram Moolenaarcc341812022-09-19 15:54:34 +01006817 outer->outer_depth,
6818 outer->outer_idx + STACK_FRAME_SIZE);
6819 else if (outer->outer_depth < 0)
6820 smsg("%s%4d LOADOUTER $%d in loop level %d",
6821 pfx, current,
6822 outer->outer_idx,
6823 -outer->outer_depth);
Bram Moolenaar4c137212021-04-19 16:48:48 +02006824 else
6825 smsg("%s%4d LOADOUTER level %d $%d", pfx, current,
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01006826 outer->outer_depth,
6827 outer->outer_idx);
Bram Moolenaar4c137212021-04-19 16:48:48 +02006828 }
6829 break;
6830 case ISN_LOADV:
6831 smsg("%s%4d LOADV v:%s", pfx, current,
6832 get_vim_var_name(iptr->isn_arg.number));
6833 break;
6834 case ISN_LOADSCRIPT:
6835 {
Bram Moolenaar6db660b2021-08-01 14:08:54 +02006836 scriptref_T *sref = iptr->isn_arg.script.scriptref;
6837 scriptitem_T *si = SCRIPT_ITEM(sref->sref_sid);
6838 svar_T *sv;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006839
Bram Moolenaar6db660b2021-08-01 14:08:54 +02006840 sv = get_script_svar(sref, -1);
6841 if (sv == NULL)
6842 smsg("%s%4d LOADSCRIPT [deleted] from %s",
6843 pfx, current, si->sn_name);
6844 else
6845 smsg("%s%4d LOADSCRIPT %s-%d from %s", pfx, current,
Bram Moolenaar4c137212021-04-19 16:48:48 +02006846 sv->sv_name,
6847 sref->sref_idx,
6848 si->sn_name);
6849 }
6850 break;
6851 case ISN_LOADS:
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01006852 case ISN_LOADEXPORT:
Bram Moolenaar4c137212021-04-19 16:48:48 +02006853 {
6854 scriptitem_T *si = SCRIPT_ITEM(
6855 iptr->isn_arg.loadstore.ls_sid);
6856
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01006857 smsg("%s%4d %s s:%s from %s", pfx, current,
6858 iptr->isn_type == ISN_LOADS ? "LOADS"
6859 : "LOADEXPORT",
6860 iptr->isn_arg.loadstore.ls_name, si->sn_name);
Bram Moolenaar4c137212021-04-19 16:48:48 +02006861 }
6862 break;
6863 case ISN_LOADAUTO:
6864 smsg("%s%4d LOADAUTO %s", pfx, current, iptr->isn_arg.string);
6865 break;
6866 case ISN_LOADG:
6867 smsg("%s%4d LOADG g:%s", pfx, current, iptr->isn_arg.string);
6868 break;
6869 case ISN_LOADB:
6870 smsg("%s%4d LOADB b:%s", pfx, current, iptr->isn_arg.string);
6871 break;
6872 case ISN_LOADW:
6873 smsg("%s%4d LOADW w:%s", pfx, current, iptr->isn_arg.string);
6874 break;
6875 case ISN_LOADT:
6876 smsg("%s%4d LOADT t:%s", pfx, current, iptr->isn_arg.string);
6877 break;
6878 case ISN_LOADGDICT:
6879 smsg("%s%4d LOAD g:", pfx, current);
6880 break;
6881 case ISN_LOADBDICT:
6882 smsg("%s%4d LOAD b:", pfx, current);
6883 break;
6884 case ISN_LOADWDICT:
6885 smsg("%s%4d LOAD w:", pfx, current);
6886 break;
6887 case ISN_LOADTDICT:
6888 smsg("%s%4d LOAD t:", pfx, current);
6889 break;
6890 case ISN_LOADOPT:
6891 smsg("%s%4d LOADOPT %s", pfx, current, iptr->isn_arg.string);
6892 break;
6893 case ISN_LOADENV:
6894 smsg("%s%4d LOADENV %s", pfx, current, iptr->isn_arg.string);
6895 break;
6896 case ISN_LOADREG:
Bram Moolenaar6db660b2021-08-01 14:08:54 +02006897 smsg("%s%4d LOADREG @%c", pfx, current,
6898 (int)(iptr->isn_arg.number));
Bram Moolenaar4c137212021-04-19 16:48:48 +02006899 break;
6900
6901 case ISN_STORE:
6902 if (iptr->isn_arg.number < 0)
6903 smsg("%s%4d STORE arg[%lld]", pfx, current,
6904 iptr->isn_arg.number + STACK_FRAME_SIZE);
6905 else
Bram Moolenaar6db660b2021-08-01 14:08:54 +02006906 smsg("%s%4d STORE $%lld", pfx, current,
6907 iptr->isn_arg.number);
Bram Moolenaar4c137212021-04-19 16:48:48 +02006908 break;
6909 case ISN_STOREOUTER:
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01006910 {
6911 isn_outer_T *outer = &iptr->isn_arg.outer;
6912
6913 if (outer->outer_depth == OUTER_LOOP_DEPTH)
6914 smsg("%s%4d STOREOUTER level 1 $%d in loop",
6915 pfx, current, outer->outer_idx);
6916 else
6917 smsg("%s%4d STOREOUTER level %d $%d", pfx, current,
6918 outer->outer_depth, outer->outer_idx);
6919 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02006920 break;
6921 case ISN_STOREV:
6922 smsg("%s%4d STOREV v:%s", pfx, current,
6923 get_vim_var_name(iptr->isn_arg.number));
6924 break;
6925 case ISN_STOREAUTO:
6926 smsg("%s%4d STOREAUTO %s", pfx, current, iptr->isn_arg.string);
6927 break;
6928 case ISN_STOREG:
6929 smsg("%s%4d STOREG %s", pfx, current, iptr->isn_arg.string);
6930 break;
6931 case ISN_STOREB:
6932 smsg("%s%4d STOREB %s", pfx, current, iptr->isn_arg.string);
6933 break;
6934 case ISN_STOREW:
6935 smsg("%s%4d STOREW %s", pfx, current, iptr->isn_arg.string);
6936 break;
6937 case ISN_STORET:
6938 smsg("%s%4d STORET %s", pfx, current, iptr->isn_arg.string);
6939 break;
6940 case ISN_STORES:
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01006941 case ISN_STOREEXPORT:
Bram Moolenaar4c137212021-04-19 16:48:48 +02006942 {
6943 scriptitem_T *si = SCRIPT_ITEM(
6944 iptr->isn_arg.loadstore.ls_sid);
6945
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01006946 smsg("%s%4d %s %s in %s", pfx, current,
6947 iptr->isn_type == ISN_STORES
6948 ? "STORES" : "STOREEXPORT",
Bram Moolenaar4c137212021-04-19 16:48:48 +02006949 iptr->isn_arg.loadstore.ls_name, si->sn_name);
6950 }
6951 break;
6952 case ISN_STORESCRIPT:
6953 {
Bram Moolenaar6db660b2021-08-01 14:08:54 +02006954 scriptref_T *sref = iptr->isn_arg.script.scriptref;
6955 scriptitem_T *si = SCRIPT_ITEM(sref->sref_sid);
6956 svar_T *sv;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006957
Bram Moolenaar6db660b2021-08-01 14:08:54 +02006958 sv = get_script_svar(sref, -1);
6959 if (sv == NULL)
6960 smsg("%s%4d STORESCRIPT [deleted] in %s",
6961 pfx, current, si->sn_name);
6962 else
6963 smsg("%s%4d STORESCRIPT %s-%d in %s", pfx, current,
Bram Moolenaar4c137212021-04-19 16:48:48 +02006964 sv->sv_name,
6965 sref->sref_idx,
6966 si->sn_name);
6967 }
6968 break;
6969 case ISN_STOREOPT:
Bram Moolenaardcb53be2021-12-09 14:23:43 +00006970 case ISN_STOREFUNCOPT:
6971 smsg("%s%4d %s &%s", pfx, current,
6972 iptr->isn_type == ISN_STOREOPT ? "STOREOPT" : "STOREFUNCOPT",
Bram Moolenaar4c137212021-04-19 16:48:48 +02006973 iptr->isn_arg.storeopt.so_name);
6974 break;
6975 case ISN_STOREENV:
6976 smsg("%s%4d STOREENV $%s", pfx, current, iptr->isn_arg.string);
6977 break;
6978 case ISN_STOREREG:
Bram Moolenaar6db660b2021-08-01 14:08:54 +02006979 smsg("%s%4d STOREREG @%c", pfx, current,
6980 (int)iptr->isn_arg.number);
Bram Moolenaar4c137212021-04-19 16:48:48 +02006981 break;
6982 case ISN_STORENR:
6983 smsg("%s%4d STORE %lld in $%d", pfx, current,
6984 iptr->isn_arg.storenr.stnr_val,
6985 iptr->isn_arg.storenr.stnr_idx);
6986 break;
6987
6988 case ISN_STOREINDEX:
6989 smsg("%s%4d STOREINDEX %s", pfx, current,
Bram Moolenaarf7d1c6e2023-01-16 20:47:57 +00006990 vartype_name(iptr->isn_arg.storeindex.si_vartype));
Bram Moolenaar4c137212021-04-19 16:48:48 +02006991 break;
6992
6993 case ISN_STORERANGE:
6994 smsg("%s%4d STORERANGE", pfx, current);
6995 break;
6996
Bram Moolenaard505d172022-12-18 21:42:55 +00006997 case ISN_LOAD_CLASSMEMBER:
6998 case ISN_STORE_CLASSMEMBER:
6999 {
7000 class_T *cl = iptr->isn_arg.classmember.cm_class;
7001 int idx = iptr->isn_arg.classmember.cm_idx;
7002 ocmember_T *ocm = &cl->class_class_members[idx];
7003 smsg("%s%4d %s CLASSMEMBER %s.%s", pfx, current,
7004 iptr->isn_type == ISN_LOAD_CLASSMEMBER
7005 ? "LOAD" : "STORE",
7006 cl->class_name, ocm->ocm_name);
7007 }
7008 break;
7009
Bram Moolenaar4c137212021-04-19 16:48:48 +02007010 // constants
7011 case ISN_PUSHNR:
7012 smsg("%s%4d PUSHNR %lld", pfx, current,
7013 (varnumber_T)(iptr->isn_arg.number));
7014 break;
7015 case ISN_PUSHBOOL:
7016 case ISN_PUSHSPEC:
7017 smsg("%s%4d PUSH %s", pfx, current,
7018 get_var_special_name(iptr->isn_arg.number));
7019 break;
7020 case ISN_PUSHF:
Bram Moolenaar4c137212021-04-19 16:48:48 +02007021 smsg("%s%4d PUSHF %g", pfx, current, iptr->isn_arg.fnumber);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007022 break;
7023 case ISN_PUSHS:
7024 smsg("%s%4d PUSHS \"%s\"", pfx, current, iptr->isn_arg.string);
7025 break;
7026 case ISN_PUSHBLOB:
7027 {
7028 char_u *r;
7029 char_u numbuf[NUMBUFLEN];
7030 char_u *tofree;
7031
7032 r = blob2string(iptr->isn_arg.blob, &tofree, numbuf);
7033 smsg("%s%4d PUSHBLOB %s", pfx, current, r);
7034 vim_free(tofree);
7035 }
7036 break;
7037 case ISN_PUSHFUNC:
7038 {
7039 char *name = (char *)iptr->isn_arg.string;
7040
7041 smsg("%s%4d PUSHFUNC \"%s\"", pfx, current,
7042 name == NULL ? "[none]" : name);
7043 }
7044 break;
7045 case ISN_PUSHCHANNEL:
7046#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar397a87a2022-03-20 21:14:15 +00007047 smsg("%s%4d PUSHCHANNEL 0", pfx, current);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007048#endif
7049 break;
7050 case ISN_PUSHJOB:
7051#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar397a87a2022-03-20 21:14:15 +00007052 smsg("%s%4d PUSHJOB \"no process\"", pfx, current);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007053#endif
7054 break;
Bram Moolenaarc4e1b862023-02-26 18:58:23 +00007055 case ISN_PUSHOBJ:
7056 smsg("%s%4d PUSHOBJ null", pfx, current);
7057 break;
7058 case ISN_PUSHCLASS:
7059 smsg("%s%4d PUSHCLASS %s", pfx, current,
Bram Moolenaar30a84472023-02-27 08:07:14 +00007060 iptr->isn_arg.classarg == NULL ? "null"
7061 : (char *)iptr->isn_arg.classarg->class_name);
Bram Moolenaarc4e1b862023-02-26 18:58:23 +00007062 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007063 case ISN_PUSHEXC:
7064 smsg("%s%4d PUSH v:exception", pfx, current);
7065 break;
Bram Moolenaar06b77222022-01-25 15:51:56 +00007066 case ISN_AUTOLOAD:
7067 smsg("%s%4d AUTOLOAD %s", pfx, current, iptr->isn_arg.string);
7068 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007069 case ISN_UNLET:
7070 smsg("%s%4d UNLET%s %s", pfx, current,
7071 iptr->isn_arg.unlet.ul_forceit ? "!" : "",
7072 iptr->isn_arg.unlet.ul_name);
7073 break;
7074 case ISN_UNLETENV:
7075 smsg("%s%4d UNLETENV%s $%s", pfx, current,
7076 iptr->isn_arg.unlet.ul_forceit ? "!" : "",
7077 iptr->isn_arg.unlet.ul_name);
7078 break;
7079 case ISN_UNLETINDEX:
7080 smsg("%s%4d UNLETINDEX", pfx, current);
7081 break;
7082 case ISN_UNLETRANGE:
7083 smsg("%s%4d UNLETRANGE", pfx, current);
7084 break;
Bram Moolenaaraacc9662021-08-13 19:40:51 +02007085 case ISN_LOCKUNLOCK:
7086 smsg("%s%4d LOCKUNLOCK %s", pfx, current, iptr->isn_arg.string);
7087 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007088 case ISN_LOCKCONST:
7089 smsg("%s%4d LOCKCONST", pfx, current);
7090 break;
7091 case ISN_NEWLIST:
7092 smsg("%s%4d NEWLIST size %lld", pfx, current,
Bram Moolenaar1936c762022-09-28 15:19:10 +01007093 (varnumber_T)(iptr->isn_arg.number));
Bram Moolenaar4c137212021-04-19 16:48:48 +02007094 break;
7095 case ISN_NEWDICT:
7096 smsg("%s%4d NEWDICT size %lld", pfx, current,
Bram Moolenaar1936c762022-09-28 15:19:10 +01007097 (varnumber_T)(iptr->isn_arg.number));
Bram Moolenaar4c137212021-04-19 16:48:48 +02007098 break;
Bram Moolenaar8acb9cc2022-03-08 13:18:55 +00007099 case ISN_NEWPARTIAL:
7100 smsg("%s%4d NEWPARTIAL", pfx, current);
7101 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007102
7103 // function call
7104 case ISN_BCALL:
7105 {
7106 cbfunc_T *cbfunc = &iptr->isn_arg.bfunc;
7107
7108 smsg("%s%4d BCALL %s(argc %d)", pfx, current,
7109 internal_func_name(cbfunc->cbf_idx),
7110 cbfunc->cbf_argcount);
7111 }
7112 break;
7113 case ISN_DCALL:
7114 {
7115 cdfunc_T *cdfunc = &iptr->isn_arg.dfunc;
7116 dfunc_T *df = ((dfunc_T *)def_functions.ga_data)
7117 + cdfunc->cdf_idx;
7118
7119 smsg("%s%4d DCALL %s(argc %d)", pfx, current,
Bram Moolenaar6db660b2021-08-01 14:08:54 +02007120 printable_func_name(df->df_ufunc),
7121 cdfunc->cdf_argcount);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007122 }
7123 break;
Bram Moolenaard0200c82023-01-28 15:19:40 +00007124 case ISN_METHODCALL:
7125 {
7126 cmfunc_T *mfunc = iptr->isn_arg.mfunc;
7127
7128 smsg("%s%4d METHODCALL %s.%s(argc %d)", pfx, current,
7129 mfunc->cmf_itf->class_name,
7130 mfunc->cmf_itf->class_obj_methods[
7131 mfunc->cmf_idx]->uf_name,
7132 mfunc->cmf_argcount);
7133 }
7134 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007135 case ISN_UCALL:
7136 {
7137 cufunc_T *cufunc = &iptr->isn_arg.ufunc;
7138
7139 smsg("%s%4d UCALL %s(argc %d)", pfx, current,
7140 cufunc->cuf_name, cufunc->cuf_argcount);
7141 }
7142 break;
7143 case ISN_PCALL:
7144 {
7145 cpfunc_T *cpfunc = &iptr->isn_arg.pfunc;
7146
7147 smsg("%s%4d PCALL%s (argc %d)", pfx, current,
7148 cpfunc->cpf_top ? " top" : "", cpfunc->cpf_argcount);
7149 }
7150 break;
7151 case ISN_PCALL_END:
7152 smsg("%s%4d PCALL end", pfx, current);
7153 break;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01007154 case ISN_DEFER:
Yegappan Lakshmananf3eac692023-10-17 11:00:45 +02007155 smsg("%s%4d DEFER %d args", pfx, current,
Bram Moolenaar1d84f762022-09-03 21:35:53 +01007156 (int)iptr->isn_arg.defer.defer_argcount);
7157 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007158 case ISN_RETURN:
7159 smsg("%s%4d RETURN", pfx, current);
7160 break;
Bram Moolenaarf57b43c2021-06-15 22:13:27 +02007161 case ISN_RETURN_VOID:
7162 smsg("%s%4d RETURN void", pfx, current);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007163 break;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00007164 case ISN_RETURN_OBJECT:
7165 smsg("%s%4d RETURN object", pfx, current);
7166 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007167 case ISN_FUNCREF:
7168 {
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01007169 funcref_T *funcref = &iptr->isn_arg.funcref;
7170 funcref_extra_T *extra = funcref->fr_extra;
7171 char_u *name;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007172
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01007173 if (extra == NULL || extra->fre_func_name == NULL)
Bram Moolenaar38453522021-11-28 22:00:12 +00007174 {
7175 dfunc_T *df = ((dfunc_T *)def_functions.ga_data)
7176 + funcref->fr_dfunc_idx;
7177 name = df->df_ufunc->uf_name;
7178 }
7179 else
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01007180 name = extra->fre_func_name;
Bram Moolenaar313e4722023-02-08 20:55:27 +00007181 if (extra != NULL && extra->fre_class != NULL)
7182 {
7183 smsg("%s%4d FUNCREF %s.%s", pfx, current,
7184 extra->fre_class->class_name, name);
7185 }
7186 else if (extra == NULL
7187 || extra->fre_loopvar_info.lvi_depth == 0)
7188 {
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01007189 smsg("%s%4d FUNCREF %s", pfx, current, name);
Bram Moolenaar313e4722023-02-08 20:55:27 +00007190 }
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01007191 else
Bram Moolenaarcc341812022-09-19 15:54:34 +01007192 {
7193 char_u *info = printable_loopvarinfo(
7194 &extra->fre_loopvar_info);
7195
7196 smsg("%s%4d FUNCREF %s vars %s", pfx, current,
7197 name, info);
7198 vim_free(info);
7199 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02007200 }
7201 break;
7202
7203 case ISN_NEWFUNC:
7204 {
Bram Moolenaarcc341812022-09-19 15:54:34 +01007205 newfuncarg_T *arg = iptr->isn_arg.newfunc.nf_arg;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007206
Bram Moolenaarcc341812022-09-19 15:54:34 +01007207 if (arg->nfa_loopvar_info.lvi_depth == 0)
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01007208 smsg("%s%4d NEWFUNC %s %s", pfx, current,
7209 arg->nfa_lambda, arg->nfa_global);
7210 else
Bram Moolenaarcc341812022-09-19 15:54:34 +01007211 {
7212 char_u *info = printable_loopvarinfo(
7213 &arg->nfa_loopvar_info);
7214
7215 smsg("%s%4d NEWFUNC %s %s vars %s", pfx, current,
7216 arg->nfa_lambda, arg->nfa_global, info);
7217 vim_free(info);
7218 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02007219 }
7220 break;
7221
7222 case ISN_DEF:
7223 {
7224 char_u *name = iptr->isn_arg.string;
7225
7226 smsg("%s%4d DEF %s", pfx, current,
7227 name == NULL ? (char_u *)"" : name);
7228 }
7229 break;
7230
7231 case ISN_JUMP:
7232 {
7233 char *when = "?";
7234
7235 switch (iptr->isn_arg.jump.jump_when)
7236 {
7237 case JUMP_ALWAYS:
7238 when = "JUMP";
7239 break;
Bram Moolenaar1a7ee4d2021-09-16 16:15:07 +02007240 case JUMP_NEVER:
7241 iemsg("JUMP_NEVER should not be used");
7242 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007243 case JUMP_AND_KEEP_IF_TRUE:
7244 when = "JUMP_AND_KEEP_IF_TRUE";
7245 break;
7246 case JUMP_IF_FALSE:
7247 when = "JUMP_IF_FALSE";
7248 break;
Bram Moolenaarb46c0832022-09-15 17:19:37 +01007249 case JUMP_WHILE_FALSE:
7250 when = "JUMP_WHILE_FALSE"; // unused
7251 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007252 case JUMP_IF_COND_FALSE:
7253 when = "JUMP_IF_COND_FALSE";
7254 break;
7255 case JUMP_IF_COND_TRUE:
7256 when = "JUMP_IF_COND_TRUE";
7257 break;
7258 }
7259 smsg("%s%4d %s -> %d", pfx, current, when,
7260 iptr->isn_arg.jump.jump_where);
7261 }
7262 break;
7263
7264 case ISN_JUMP_IF_ARG_SET:
7265 smsg("%s%4d JUMP_IF_ARG_SET arg[%d] -> %d", pfx, current,
7266 iptr->isn_arg.jumparg.jump_arg_off + STACK_FRAME_SIZE,
7267 iptr->isn_arg.jump.jump_where);
7268 break;
7269
Bram Moolenaar65b0d162022-12-13 18:43:22 +00007270 case ISN_JUMP_IF_ARG_NOT_SET:
7271 smsg("%s%4d JUMP_IF_ARG_NOT_SET arg[%d] -> %d", pfx, current,
7272 iptr->isn_arg.jumparg.jump_arg_off + STACK_FRAME_SIZE,
7273 iptr->isn_arg.jump.jump_where);
7274 break;
7275
Bram Moolenaar4c137212021-04-19 16:48:48 +02007276 case ISN_FOR:
7277 {
7278 forloop_T *forloop = &iptr->isn_arg.forloop;
7279
7280 smsg("%s%4d FOR $%d -> %d", pfx, current,
Bram Moolenaarcc341812022-09-19 15:54:34 +01007281 forloop->for_loop_idx, forloop->for_end);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007282 }
7283 break;
7284
Bram Moolenaarb46c0832022-09-15 17:19:37 +01007285 case ISN_ENDLOOP:
7286 {
7287 endloop_T *endloop = &iptr->isn_arg.endloop;
7288
Bram Moolenaarcc341812022-09-19 15:54:34 +01007289 smsg("%s%4d ENDLOOP ref $%d save $%d-$%d depth %d",
7290 pfx, current,
Bram Moolenaarb46c0832022-09-15 17:19:37 +01007291 endloop->end_funcref_idx,
7292 endloop->end_var_idx,
Bram Moolenaarcc341812022-09-19 15:54:34 +01007293 endloop->end_var_idx + endloop->end_var_count - 1,
7294 endloop->end_depth);
Bram Moolenaarb46c0832022-09-15 17:19:37 +01007295 }
7296 break;
7297
7298 case ISN_WHILE:
7299 {
7300 whileloop_T *whileloop = &iptr->isn_arg.whileloop;
7301
7302 smsg("%s%4d WHILE $%d -> %d", pfx, current,
7303 whileloop->while_funcref_idx,
7304 whileloop->while_end);
7305 }
7306 break;
7307
Bram Moolenaar4c137212021-04-19 16:48:48 +02007308 case ISN_TRY:
7309 {
Bram Moolenaar0d807102021-12-21 09:42:09 +00007310 try_T *try = &iptr->isn_arg.tryref;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007311
7312 if (try->try_ref->try_finally == 0)
7313 smsg("%s%4d TRY catch -> %d, endtry -> %d",
7314 pfx, current,
7315 try->try_ref->try_catch,
7316 try->try_ref->try_endtry);
7317 else
7318 smsg("%s%4d TRY catch -> %d, finally -> %d, endtry -> %d",
7319 pfx, current,
7320 try->try_ref->try_catch,
7321 try->try_ref->try_finally,
7322 try->try_ref->try_endtry);
7323 }
7324 break;
7325 case ISN_CATCH:
Bram Moolenaar4c137212021-04-19 16:48:48 +02007326 smsg("%s%4d CATCH", pfx, current);
7327 break;
7328 case ISN_TRYCONT:
7329 {
7330 trycont_T *trycont = &iptr->isn_arg.trycont;
7331
7332 smsg("%s%4d TRY-CONTINUE %d level%s -> %d", pfx, current,
7333 trycont->tct_levels,
7334 trycont->tct_levels == 1 ? "" : "s",
7335 trycont->tct_where);
7336 }
7337 break;
7338 case ISN_FINALLY:
7339 smsg("%s%4d FINALLY", pfx, current);
7340 break;
7341 case ISN_ENDTRY:
7342 smsg("%s%4d ENDTRY", pfx, current);
7343 break;
7344 case ISN_THROW:
7345 smsg("%s%4d THROW", pfx, current);
7346 break;
7347
7348 // expression operations on number
7349 case ISN_OPNR:
7350 case ISN_OPFLOAT:
7351 case ISN_OPANY:
7352 {
7353 char *what;
7354 char *ins;
7355
7356 switch (iptr->isn_arg.op.op_type)
7357 {
7358 case EXPR_MULT: what = "*"; break;
7359 case EXPR_DIV: what = "/"; break;
7360 case EXPR_REM: what = "%"; break;
7361 case EXPR_SUB: what = "-"; break;
7362 case EXPR_ADD: what = "+"; break;
Yegappan Lakshmanana061f342022-05-22 19:13:49 +01007363 case EXPR_LSHIFT: what = "<<"; break;
7364 case EXPR_RSHIFT: what = ">>"; break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007365 default: what = "???"; break;
7366 }
7367 switch (iptr->isn_type)
7368 {
7369 case ISN_OPNR: ins = "OPNR"; break;
7370 case ISN_OPFLOAT: ins = "OPFLOAT"; break;
7371 case ISN_OPANY: ins = "OPANY"; break;
7372 default: ins = "???"; break;
7373 }
7374 smsg("%s%4d %s %s", pfx, current, ins, what);
7375 }
7376 break;
7377
7378 case ISN_COMPAREBOOL:
7379 case ISN_COMPARESPECIAL:
Bram Moolenaar7a222242022-03-01 19:23:24 +00007380 case ISN_COMPARENULL:
Bram Moolenaar4c137212021-04-19 16:48:48 +02007381 case ISN_COMPARENR:
7382 case ISN_COMPAREFLOAT:
7383 case ISN_COMPARESTRING:
7384 case ISN_COMPAREBLOB:
7385 case ISN_COMPARELIST:
7386 case ISN_COMPAREDICT:
7387 case ISN_COMPAREFUNC:
Bram Moolenaarbcf31ec2023-01-02 20:32:24 +00007388 case ISN_COMPAREOBJECT:
Bram Moolenaar4c137212021-04-19 16:48:48 +02007389 case ISN_COMPAREANY:
7390 {
7391 char *p;
7392 char buf[10];
7393 char *type;
7394
7395 switch (iptr->isn_arg.op.op_type)
7396 {
7397 case EXPR_EQUAL: p = "=="; break;
7398 case EXPR_NEQUAL: p = "!="; break;
7399 case EXPR_GREATER: p = ">"; break;
7400 case EXPR_GEQUAL: p = ">="; break;
7401 case EXPR_SMALLER: p = "<"; break;
7402 case EXPR_SEQUAL: p = "<="; break;
7403 case EXPR_MATCH: p = "=~"; break;
7404 case EXPR_IS: p = "is"; break;
7405 case EXPR_ISNOT: p = "isnot"; break;
7406 case EXPR_NOMATCH: p = "!~"; break;
7407 default: p = "???"; break;
7408 }
7409 STRCPY(buf, p);
7410 if (iptr->isn_arg.op.op_ic == TRUE)
7411 strcat(buf, "?");
7412 switch(iptr->isn_type)
7413 {
7414 case ISN_COMPAREBOOL: type = "COMPAREBOOL"; break;
7415 case ISN_COMPARESPECIAL:
7416 type = "COMPARESPECIAL"; break;
Bram Moolenaar7a222242022-03-01 19:23:24 +00007417 case ISN_COMPARENULL: type = "COMPARENULL"; break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007418 case ISN_COMPARENR: type = "COMPARENR"; break;
7419 case ISN_COMPAREFLOAT: type = "COMPAREFLOAT"; break;
7420 case ISN_COMPARESTRING:
7421 type = "COMPARESTRING"; break;
7422 case ISN_COMPAREBLOB: type = "COMPAREBLOB"; break;
7423 case ISN_COMPARELIST: type = "COMPARELIST"; break;
7424 case ISN_COMPAREDICT: type = "COMPAREDICT"; break;
7425 case ISN_COMPAREFUNC: type = "COMPAREFUNC"; break;
Bram Moolenaarbcf31ec2023-01-02 20:32:24 +00007426 case ISN_COMPAREOBJECT:
7427 type = "COMPAREOBJECT"; break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007428 case ISN_COMPAREANY: type = "COMPAREANY"; break;
7429 default: type = "???"; break;
7430 }
7431
7432 smsg("%s%4d %s %s", pfx, current, type, buf);
7433 }
7434 break;
7435
7436 case ISN_ADDLIST: smsg("%s%4d ADDLIST", pfx, current); break;
7437 case ISN_ADDBLOB: smsg("%s%4d ADDBLOB", pfx, current); break;
7438
7439 // expression operations
LemonBoy372bcce2022-04-25 12:43:20 +01007440 case ISN_CONCAT:
7441 smsg("%s%4d CONCAT size %lld", pfx, current,
7442 (varnumber_T)(iptr->isn_arg.number));
7443 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007444 case ISN_STRINDEX: smsg("%s%4d STRINDEX", pfx, current); break;
7445 case ISN_STRSLICE: smsg("%s%4d STRSLICE", pfx, current); break;
7446 case ISN_BLOBINDEX: smsg("%s%4d BLOBINDEX", pfx, current); break;
7447 case ISN_BLOBSLICE: smsg("%s%4d BLOBSLICE", pfx, current); break;
7448 case ISN_LISTAPPEND: smsg("%s%4d LISTAPPEND", pfx, current); break;
7449 case ISN_BLOBAPPEND: smsg("%s%4d BLOBAPPEND", pfx, current); break;
7450 case ISN_LISTINDEX: smsg("%s%4d LISTINDEX", pfx, current); break;
7451 case ISN_LISTSLICE: smsg("%s%4d LISTSLICE", pfx, current); break;
7452 case ISN_ANYINDEX: smsg("%s%4d ANYINDEX", pfx, current); break;
7453 case ISN_ANYSLICE: smsg("%s%4d ANYSLICE", pfx, current); break;
7454 case ISN_SLICE: smsg("%s%4d SLICE %lld",
Bram Moolenaar4f0884d2021-08-11 21:49:23 +02007455 pfx, current, iptr->isn_arg.number); break;
Bram Moolenaar035bd1c2021-06-21 19:44:11 +02007456 case ISN_GETITEM: smsg("%s%4d ITEM %lld%s", pfx, current,
7457 iptr->isn_arg.getitem.gi_index,
7458 iptr->isn_arg.getitem.gi_with_op ?
7459 " with op" : ""); break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007460 case ISN_MEMBER: smsg("%s%4d MEMBER", pfx, current); break;
7461 case ISN_STRINGMEMBER: smsg("%s%4d MEMBER %s", pfx, current,
7462 iptr->isn_arg.string); break;
Yegappan Lakshmanan5a05d372023-09-29 19:43:11 +02007463 case ISN_GET_OBJ_MEMBER: smsg("%s%4d OBJ_MEMBER %d", pfx, current,
7464 (int)iptr->isn_arg.classmember.cm_idx);
Ernie Rael00df69e2023-09-05 07:38:09 +02007465 break;
Yegappan Lakshmanan5a05d372023-09-29 19:43:11 +02007466 case ISN_GET_ITF_MEMBER: smsg("%s%4d ITF_MEMBER %d on %s",
Bram Moolenaar29ac5df2023-01-16 19:43:47 +00007467 pfx, current,
7468 (int)iptr->isn_arg.classmember.cm_idx,
Yegappan Lakshmanan5a05d372023-09-29 19:43:11 +02007469 iptr->isn_arg.classmember.cm_class->class_name);
Bram Moolenaar29ac5df2023-01-16 19:43:47 +00007470 break;
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00007471 case ISN_STORE_THIS: smsg("%s%4d STORE_THIS %d", pfx, current,
Bram Moolenaarffdaca92022-12-09 21:41:48 +00007472 (int)iptr->isn_arg.number); break;
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02007473 case ISN_CLEARDICT: smsg("%s%4d CLEARDICT", pfx, current); break;
7474 case ISN_USEDICT: smsg("%s%4d USEDICT", pfx, current); break;
7475
Bram Moolenaar4c137212021-04-19 16:48:48 +02007476 case ISN_NEGATENR: smsg("%s%4d NEGATENR", pfx, current); break;
7477
Bram Moolenaar4c137212021-04-19 16:48:48 +02007478 case ISN_CHECKTYPE:
7479 {
Bram Moolenaarbd3a9d22022-05-17 16:12:39 +01007480 checktype_T *ct = &iptr->isn_arg.type;
Bram Moolenaarc6951a72022-12-29 20:56:24 +00007481 char *tofree = NULL;
7482 char *typename;
7483
7484 if (ct->ct_type->tt_type == VAR_FLOAT
7485 && (ct->ct_type->tt_flags & TTFLAG_NUMBER_OK))
7486 typename = "float|number";
7487 else
7488 typename = type_name(ct->ct_type, &tofree);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007489
7490 if (ct->ct_arg_idx == 0)
7491 smsg("%s%4d CHECKTYPE %s stack[%d]", pfx, current,
Bram Moolenaarc6951a72022-12-29 20:56:24 +00007492 typename,
Bram Moolenaar4c137212021-04-19 16:48:48 +02007493 (int)ct->ct_off);
7494 else
Bram Moolenaarbd3a9d22022-05-17 16:12:39 +01007495 smsg("%s%4d CHECKTYPE %s stack[%d] %s %d",
Bram Moolenaar4f0884d2021-08-11 21:49:23 +02007496 pfx, current,
Bram Moolenaarc6951a72022-12-29 20:56:24 +00007497 typename,
Bram Moolenaar4c137212021-04-19 16:48:48 +02007498 (int)ct->ct_off,
Bram Moolenaarbd3a9d22022-05-17 16:12:39 +01007499 ct->ct_is_var ? "var": "arg",
Bram Moolenaar4c137212021-04-19 16:48:48 +02007500 (int)ct->ct_arg_idx);
7501 vim_free(tofree);
7502 break;
7503 }
7504 case ISN_CHECKLEN: smsg("%s%4d CHECKLEN %s%d", pfx, current,
7505 iptr->isn_arg.checklen.cl_more_OK ? ">= " : "",
7506 iptr->isn_arg.checklen.cl_min_len);
7507 break;
7508 case ISN_SETTYPE:
7509 {
7510 char *tofree;
7511
7512 smsg("%s%4d SETTYPE %s", pfx, current,
7513 type_name(iptr->isn_arg.type.ct_type, &tofree));
7514 vim_free(tofree);
7515 break;
7516 }
7517 case ISN_COND2BOOL: smsg("%s%4d COND2BOOL", pfx, current); break;
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02007518 case ISN_2BOOL: if (iptr->isn_arg.tobool.invert)
7519 smsg("%s%4d INVERT %d (!val)", pfx, current,
7520 iptr->isn_arg.tobool.offset);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007521 else
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02007522 smsg("%s%4d 2BOOL %d (!!val)", pfx, current,
7523 iptr->isn_arg.tobool.offset);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007524 break;
7525 case ISN_2STRING: smsg("%s%4d 2STRING stack[%lld]", pfx, current,
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02007526 (varnumber_T)(iptr->isn_arg.tostring.offset));
Bram Moolenaar4c137212021-04-19 16:48:48 +02007527 break;
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02007528 case ISN_2STRING_ANY: smsg("%s%4d 2STRING_ANY stack[%lld]",
7529 pfx, current,
7530 (varnumber_T)(iptr->isn_arg.tostring.offset));
Bram Moolenaar4c137212021-04-19 16:48:48 +02007531 break;
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02007532 case ISN_RANGE: smsg("%s%4d RANGE %s", pfx, current,
7533 iptr->isn_arg.string);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007534 break;
7535 case ISN_PUT:
Bram Moolenaar6ed545e2022-05-09 20:09:23 +01007536 if (iptr->isn_arg.put.put_lnum == LNUM_VARIABLE_RANGE_ABOVE)
Bram Moolenaar4c137212021-04-19 16:48:48 +02007537 smsg("%s%4d PUT %c above range",
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02007538 pfx, current, iptr->isn_arg.put.put_regname);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007539 else if (iptr->isn_arg.put.put_lnum == LNUM_VARIABLE_RANGE)
7540 smsg("%s%4d PUT %c range",
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02007541 pfx, current, iptr->isn_arg.put.put_regname);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007542 else
7543 smsg("%s%4d PUT %c %ld", pfx, current,
7544 iptr->isn_arg.put.put_regname,
7545 (long)iptr->isn_arg.put.put_lnum);
7546 break;
7547
Bram Moolenaar4c137212021-04-19 16:48:48 +02007548 case ISN_CMDMOD:
7549 {
7550 char_u *buf;
7551 size_t len = produce_cmdmods(
7552 NULL, iptr->isn_arg.cmdmod.cf_cmdmod, FALSE);
7553
7554 buf = alloc(len + 1);
Dominique Pelle5a9e5842021-07-24 19:32:12 +02007555 if (likely(buf != NULL))
Bram Moolenaar4c137212021-04-19 16:48:48 +02007556 {
7557 (void)produce_cmdmods(
7558 buf, iptr->isn_arg.cmdmod.cf_cmdmod, FALSE);
7559 smsg("%s%4d CMDMOD %s", pfx, current, buf);
7560 vim_free(buf);
7561 }
7562 break;
7563 }
7564 case ISN_CMDMOD_REV: smsg("%s%4d CMDMOD_REV", pfx, current); break;
7565
7566 case ISN_PROF_START:
Bram Moolenaare99d4222021-06-13 14:01:26 +02007567 smsg("%s%4d PROFILE START line %d", pfx, current,
7568 iptr->isn_lnum);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007569 break;
7570
7571 case ISN_PROF_END:
7572 smsg("%s%4d PROFILE END", pfx, current);
7573 break;
7574
Bram Moolenaare99d4222021-06-13 14:01:26 +02007575 case ISN_DEBUG:
Bram Moolenaar8cec9272021-06-23 20:20:53 +02007576 smsg("%s%4d DEBUG line %d-%d varcount %lld", pfx, current,
7577 iptr->isn_arg.debug.dbg_break_lnum + 1,
7578 iptr->isn_lnum,
7579 iptr->isn_arg.debug.dbg_var_names_len);
Bram Moolenaare99d4222021-06-13 14:01:26 +02007580 break;
7581
Bram Moolenaar4c137212021-04-19 16:48:48 +02007582 case ISN_UNPACK: smsg("%s%4d UNPACK %d%s", pfx, current,
7583 iptr->isn_arg.unpack.unp_count,
7584 iptr->isn_arg.unpack.unp_semicolon ? " semicolon" : "");
7585 break;
7586 case ISN_SHUFFLE: smsg("%s%4d SHUFFLE %d up %d", pfx, current,
7587 iptr->isn_arg.shuffle.shfl_item,
7588 iptr->isn_arg.shuffle.shfl_up);
7589 break;
7590 case ISN_DROP: smsg("%s%4d DROP", pfx, current); break;
7591
7592 case ISN_FINISH: // End of list of instructions for ISN_SUBSTITUTE.
7593 return;
7594 }
7595
7596 out_flush(); // output one line at a time
7597 ui_breakcheck();
7598 if (got_int)
7599 break;
7600 }
7601}
7602
7603/*
Bram Moolenaar4ee9d8e2021-06-13 18:38:48 +02007604 * Handle command line completion for the :disassemble command.
7605 */
7606 void
7607set_context_in_disassemble_cmd(expand_T *xp, char_u *arg)
7608{
7609 char_u *p;
7610
7611 // Default: expand user functions, "debug" and "profile"
7612 xp->xp_context = EXPAND_DISASSEMBLE;
7613 xp->xp_pattern = arg;
7614
7615 // first argument already typed: only user function names
7616 if (*arg != NUL && *(p = skiptowhite(arg)) != NUL)
7617 {
7618 xp->xp_context = EXPAND_USER_FUNC;
7619 xp->xp_pattern = skipwhite(p);
7620 }
7621}
7622
7623/*
7624 * Function given to ExpandGeneric() to obtain the list of :disassemble
7625 * arguments.
7626 */
7627 char_u *
7628get_disassemble_argument(expand_T *xp, int idx)
7629{
7630 if (idx == 0)
7631 return (char_u *)"debug";
7632 if (idx == 1)
7633 return (char_u *)"profile";
7634 return get_user_func_name(xp, idx - 2);
7635}
7636
7637/*
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01007638 * ":disassemble".
Bram Moolenaar777770f2020-02-06 21:27:08 +01007639 * We don't really need this at runtime, but we do have tests that require it,
7640 * so always include this.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007641 */
7642 void
7643ex_disassemble(exarg_T *eap)
7644{
Bram Moolenaar21456cd2020-02-13 21:29:32 +01007645 char_u *arg = eap->arg;
Bram Moolenaar0f18b6d2020-02-02 17:22:27 +01007646 ufunc_T *ufunc;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007647 dfunc_T *dfunc;
Bram Moolenaardafef512022-05-21 21:55:55 +01007648 isn_T *instr = NULL; // init to shut up gcc warning
7649 int instr_count = 0; // init to shut up gcc warning
Bram Moolenaar5a01caa2022-05-21 18:56:58 +01007650 compiletype_T compile_type = CT_NONE;
Bram Moolenaare99d4222021-06-13 14:01:26 +02007651
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01007652 ufunc = find_func_by_name(arg, &compile_type);
Bram Moolenaara26b9702020-04-18 19:53:28 +02007653 if (ufunc == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007654 return;
Bram Moolenaare99d4222021-06-13 14:01:26 +02007655 if (func_needs_compiling(ufunc, compile_type)
7656 && compile_def_function(ufunc, FALSE, compile_type, NULL) == FAIL)
Bram Moolenaar822ba242020-05-24 23:00:18 +02007657 return;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02007658 if (ufunc->uf_def_status != UF_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007659 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02007660 semsg(_(e_function_is_not_compiled_str), eap->arg);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007661 return;
7662 }
Bram Moolenaar6db660b2021-08-01 14:08:54 +02007663 msg((char *)printable_func_name(ufunc));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007664
7665 dfunc = ((dfunc_T *)def_functions.ga_data) + ufunc->uf_dfunc_idx;
Bram Moolenaare99d4222021-06-13 14:01:26 +02007666 switch (compile_type)
7667 {
7668 case CT_PROFILE:
Bram Moolenaarf002a412021-01-24 13:34:18 +01007669#ifdef FEAT_PROFILE
Bram Moolenaare99d4222021-06-13 14:01:26 +02007670 instr = dfunc->df_instr_prof;
7671 instr_count = dfunc->df_instr_prof_count;
7672 break;
Bram Moolenaarf002a412021-01-24 13:34:18 +01007673#endif
Bram Moolenaare99d4222021-06-13 14:01:26 +02007674 // FALLTHROUGH
7675 case CT_NONE:
7676 instr = dfunc->df_instr;
7677 instr_count = dfunc->df_instr_count;
7678 break;
7679 case CT_DEBUG:
7680 instr = dfunc->df_instr_debug;
7681 instr_count = dfunc->df_instr_debug_count;
7682 break;
7683 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007684
Bram Moolenaar4c137212021-04-19 16:48:48 +02007685 list_instructions("", instr, instr_count, ufunc);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007686}
7687
7688/*
Bram Moolenaar13106602020-10-04 16:06:05 +02007689 * Return TRUE when "tv" is not falsy: non-zero, non-empty string, non-empty
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007690 * list, etc. Mostly like what JavaScript does, except that empty list and
7691 * empty dictionary are FALSE.
7692 */
7693 int
7694tv2bool(typval_T *tv)
7695{
7696 switch (tv->v_type)
7697 {
7698 case VAR_NUMBER:
7699 return tv->vval.v_number != 0;
7700 case VAR_FLOAT:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007701 return tv->vval.v_float != 0.0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007702 case VAR_PARTIAL:
7703 return tv->vval.v_partial != NULL;
7704 case VAR_FUNC:
7705 case VAR_STRING:
7706 return tv->vval.v_string != NULL && *tv->vval.v_string != NUL;
7707 case VAR_LIST:
7708 return tv->vval.v_list != NULL && tv->vval.v_list->lv_len > 0;
7709 case VAR_DICT:
7710 return tv->vval.v_dict != NULL
7711 && tv->vval.v_dict->dv_hashtab.ht_used > 0;
7712 case VAR_BOOL:
7713 case VAR_SPECIAL:
7714 return tv->vval.v_number == VVAL_TRUE ? TRUE : FALSE;
7715 case VAR_JOB:
7716#ifdef FEAT_JOB_CHANNEL
7717 return tv->vval.v_job != NULL;
7718#else
7719 break;
7720#endif
7721 case VAR_CHANNEL:
7722#ifdef FEAT_JOB_CHANNEL
7723 return tv->vval.v_channel != NULL;
7724#else
7725 break;
7726#endif
7727 case VAR_BLOB:
7728 return tv->vval.v_blob != NULL && tv->vval.v_blob->bv_ga.ga_len > 0;
7729 case VAR_UNKNOWN:
Bram Moolenaar4c683752020-04-05 21:38:23 +02007730 case VAR_ANY:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007731 case VAR_VOID:
Bram Moolenaarf18332f2021-05-07 17:55:55 +02007732 case VAR_INSTR:
Bram Moolenaar00b28d62022-12-08 15:32:33 +00007733 case VAR_CLASS:
7734 case VAR_OBJECT:
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02007735 case VAR_TYPEALIAS:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007736 break;
7737 }
7738 return FALSE;
7739}
7740
Bram Moolenaarea2d4072020-11-12 12:08:51 +01007741 void
7742emsg_using_string_as(typval_T *tv, int as_number)
7743{
7744 semsg(_(as_number ? e_using_string_as_number_str
7745 : e_using_string_as_bool_str),
7746 tv->vval.v_string == NULL
7747 ? (char_u *)"" : tv->vval.v_string);
7748}
7749
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007750/*
7751 * If "tv" is a string give an error and return FAIL.
7752 */
7753 int
7754check_not_string(typval_T *tv)
7755{
7756 if (tv->v_type == VAR_STRING)
7757 {
Bram Moolenaarea2d4072020-11-12 12:08:51 +01007758 emsg_using_string_as(tv, TRUE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007759 clear_tv(tv);
7760 return FAIL;
7761 }
7762 return OK;
7763}
7764
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007765
7766#endif // FEAT_EVAL