blob: 7ab6813a6955e08b82acc66716ae2b969bdce3d9 [file] [log] [blame]
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001/* vi:set ts=8 sts=4 sw=4 noet:
2 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
11 * vim9execute.c: execute Vim9 script instructions
12 */
13
14#define USING_FLOAT_STUFF
15#include "vim.h"
16
17#if defined(FEAT_EVAL) || defined(PROTO)
18
Bram Moolenaardc7c3662021-12-20 15:04:29 +000019// When not generating protos this is included in proto.h
20#ifdef PROTO
21# include "vim9.h"
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010022#endif
23
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010024
25// Structure put on ec_trystack when ISN_TRY is encountered.
26typedef struct {
Bram Moolenaard9d77892021-02-12 21:32:47 +010027 int tcd_frame_idx; // ec_frame_idx at ISN_TRY
28 int tcd_stack_len; // size of ectx.ec_stack at ISN_TRY
Bram Moolenaard3d8fee2021-06-30 19:54:43 +020029 int tcd_in_catch; // in catch or finally block
30 int tcd_did_throw; // set did_throw in :endtry
Bram Moolenaar7e82c5f2021-02-21 21:32:45 +010031 int tcd_catch_idx; // instruction of the first :catch or :finally
32 int tcd_finally_idx; // instruction of the :finally block or zero
33 int tcd_endtry_idx; // instruction of the :endtry
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010034 int tcd_caught; // catch block entered
Bram Moolenaar2e34c342021-03-14 12:13:33 +010035 int tcd_cont; // :continue encountered, jump here (minus one)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010036 int tcd_return; // when TRUE return from end of :finally
37} trycmd_T;
38
Bram Moolenaar4c137212021-04-19 16:48:48 +020039// Data local to a function.
40// On a function call, if not empty, is saved on the stack and restored when
41// returning.
42typedef struct {
43 int floc_restore_cmdmod;
44 cmdmod_T floc_save_cmdmod;
45 int floc_restore_cmdmod_stacklen;
46} funclocal_T;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010047
Bram Moolenaarc04f2a42021-06-09 19:30:03 +020048// Structure to hold a reference to an outer_T, with information of whether it
49// was allocated.
50typedef struct {
51 outer_T *or_outer;
52 partial_T *or_partial; // decrement "or_partial->pt_refcount" later
53 int or_outer_allocated; // free "or_outer" later
54} outer_ref_T;
55
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010056// A stack is used to store:
57// - arguments passed to a :def function
58// - info about the calling function, to use when returning
59// - local variables
60// - temporary values
61//
62// In detail (FP == Frame Pointer):
63// arg1 first argument from caller (if present)
64// arg2 second argument from caller (if present)
65// extra_arg1 any missing optional argument default value
66// FP -> cur_func calling function
Bram Moolenaar6ed545e2022-05-09 20:09:23 +010067// current previous instruction pointer
68// frame_ptr previous Frame Pointer
69// var1 space for local variable
70// var2 space for local variable
71// .... fixed space for max. number of local variables
72// temp temporary values
73// .... flexible space for temporary values (can grow big)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010074
75/*
76 * Execution context.
77 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +010078struct ectx_S {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010079 garray_T ec_stack; // stack of typval_T values
Bram Moolenaarbf67ea12020-05-02 17:52:42 +020080 int ec_frame_idx; // index in ec_stack: context of ec_dfunc_idx
Bram Moolenaar4c137212021-04-19 16:48:48 +020081 int ec_initial_frame_idx; // frame index when called
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010082
Bram Moolenaarc04f2a42021-06-09 19:30:03 +020083 outer_ref_T *ec_outer_ref; // outer scope used for closures, allocated
Bram Moolenaar4c137212021-04-19 16:48:48 +020084 funclocal_T ec_funclocal;
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +020085
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010086 garray_T ec_trystack; // stack of trycmd_T values
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010087
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010088 isn_T *ec_instr; // array with instructions
Dominique Pelle3276f582021-08-07 12:44:41 +020089 int ec_dfunc_idx; // current function index
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010090 int ec_iidx; // index in ec_instr: instruction to execute
Bram Moolenaar148ce7a2020-09-23 21:57:23 +020091
92 garray_T ec_funcrefs; // partials that might be a closure
Bram Moolenaar4c137212021-04-19 16:48:48 +020093
94 int ec_did_emsg_before;
95 int ec_trylevel_at_start;
96 where_T ec_where;
Bram Moolenaarcd45ed02020-12-22 17:35:54 +010097};
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010098
Bram Moolenaar12d26532021-02-19 19:13:21 +010099#ifdef FEAT_PROFILE
100// stack of profinfo_T used when profiling.
101static garray_T profile_info_ga = {0, 0, sizeof(profinfo_T), 20, NULL};
102#endif
103
Bram Moolenaar1d84f762022-09-03 21:35:53 +0100104// Get pointer to item in the stack.
105#define STACK_TV(idx) (((typval_T *)ectx->ec_stack.ga_data) + idx)
106
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100107// Get pointer to item relative to the bottom of the stack, -1 is the last one.
Bram Moolenaar11107ba2020-08-15 21:10:16 +0200108#define STACK_TV_BOT(idx) (((typval_T *)ectx->ec_stack.ga_data) + ectx->ec_stack.ga_len + (idx))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100109
Bram Moolenaar1d84f762022-09-03 21:35:53 +0100110// Get pointer to a local variable on the stack. Negative for arguments.
111#define STACK_TV_VAR(idx) (((typval_T *)ectx->ec_stack.ga_data) + ectx->ec_frame_idx + STACK_FRAME_SIZE + idx)
112
Bram Moolenaar418f1df2020-08-12 21:34:49 +0200113 void
114to_string_error(vartype_T vartype)
115{
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200116 semsg(_(e_cannot_convert_str_to_string), vartype_name(vartype));
Bram Moolenaar418f1df2020-08-12 21:34:49 +0200117}
118
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100119/*
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100120 * Return the number of arguments, including optional arguments and any vararg.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100121 */
122 static int
123ufunc_argcount(ufunc_T *ufunc)
124{
125 return ufunc->uf_args.ga_len + (ufunc->uf_va_name != NULL ? 1 : 0);
126}
127
128/*
LemonBoy372bcce2022-04-25 12:43:20 +0100129 * Create a new string from "count" items at the bottom of the stack.
130 * A trailing NUL is appended.
131 * When "count" is zero an empty string is added to the stack.
132 */
133 static int
134exe_concat(int count, ectx_T *ectx)
135{
136 int idx;
137 int len = 0;
138 typval_T *tv;
139 garray_T ga;
140
141 ga_init2(&ga, sizeof(char), 1);
142 // Preallocate enough space for the whole string to avoid having to grow
143 // and copy.
144 for (idx = 0; idx < count; ++idx)
145 {
146 tv = STACK_TV_BOT(idx - count);
147 if (tv->vval.v_string != NULL)
148 len += (int)STRLEN(tv->vval.v_string);
149 }
150
151 if (ga_grow(&ga, len + 1) == FAIL)
152 return FAIL;
153
154 for (idx = 0; idx < count; ++idx)
155 {
156 tv = STACK_TV_BOT(idx - count);
157 ga_concat(&ga, tv->vval.v_string);
158 clear_tv(tv);
159 }
160
161 // add a terminating NUL
162 ga_append(&ga, NUL);
163
164 ectx->ec_stack.ga_len -= count - 1;
165 STACK_TV_BOT(-1)->vval.v_string = ga.ga_data;
166
167 return OK;
168}
169
170/*
Bram Moolenaarfe270812020-04-11 22:31:27 +0200171 * Create a new list from "count" items at the bottom of the stack.
172 * When "count" is zero an empty list is added to the stack.
Bram Moolenaarec15b1c2022-03-27 16:29:53 +0100173 * When "count" is -1 a NULL list is added to the stack.
Bram Moolenaarfe270812020-04-11 22:31:27 +0200174 */
175 static int
176exe_newlist(int count, ectx_T *ectx)
177{
Bram Moolenaarec15b1c2022-03-27 16:29:53 +0100178 list_T *list = NULL;
Bram Moolenaarfe270812020-04-11 22:31:27 +0200179 int idx;
180 typval_T *tv;
181
Bram Moolenaarec15b1c2022-03-27 16:29:53 +0100182 if (count >= 0)
183 {
184 list = list_alloc_with_items(count);
185 if (list == NULL)
186 return FAIL;
187 for (idx = 0; idx < count; ++idx)
188 list_set_item(list, idx, STACK_TV_BOT(idx - count));
189 }
Bram Moolenaarfe270812020-04-11 22:31:27 +0200190
191 if (count > 0)
192 ectx->ec_stack.ga_len -= count - 1;
Bram Moolenaar35578162021-08-02 19:10:38 +0200193 else if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarec15b1c2022-03-27 16:29:53 +0100194 {
195 list_unref(list);
Bram Moolenaarfe270812020-04-11 22:31:27 +0200196 return FAIL;
Bram Moolenaarec15b1c2022-03-27 16:29:53 +0100197 }
Bram Moolenaarfe270812020-04-11 22:31:27 +0200198 else
199 ++ectx->ec_stack.ga_len;
200 tv = STACK_TV_BOT(-1);
201 tv->v_type = VAR_LIST;
202 tv->vval.v_list = list;
Bram Moolenaar566badc2022-09-18 13:46:08 +0100203 tv->v_lock = 0;
Bram Moolenaarec15b1c2022-03-27 16:29:53 +0100204 if (list != NULL)
205 ++list->lv_refcount;
206 return OK;
207}
208
209/*
210 * Implementation of ISN_NEWDICT.
211 * Returns FAIL on total failure, MAYBE on error.
212 */
213 static int
214exe_newdict(int count, ectx_T *ectx)
215{
216 dict_T *dict = NULL;
217 dictitem_T *item;
218 char_u *key;
219 int idx;
220 typval_T *tv;
221
222 if (count >= 0)
223 {
224 dict = dict_alloc();
225 if (unlikely(dict == NULL))
226 return FAIL;
227 for (idx = 0; idx < count; ++idx)
228 {
229 // have already checked key type is VAR_STRING
230 tv = STACK_TV_BOT(2 * (idx - count));
231 // check key is unique
Bram Moolenaara9fa8c52023-01-02 18:10:04 +0000232 key = tv->vval.v_string == NULL ? (char_u *)"" : tv->vval.v_string;
Bram Moolenaarec15b1c2022-03-27 16:29:53 +0100233 item = dict_find(dict, key, -1);
234 if (item != NULL)
235 {
Bram Moolenaara9fa8c52023-01-02 18:10:04 +0000236 semsg(_(e_duplicate_key_in_dictionary_str), key);
Bram Moolenaarec15b1c2022-03-27 16:29:53 +0100237 dict_unref(dict);
238 return MAYBE;
239 }
240 item = dictitem_alloc(key);
241 clear_tv(tv);
242 if (unlikely(item == NULL))
243 {
244 dict_unref(dict);
245 return FAIL;
246 }
Bram Moolenaar0d1f55c2022-04-05 17:30:29 +0100247 tv = STACK_TV_BOT(2 * (idx - count) + 1);
248 item->di_tv = *tv;
Bram Moolenaarec15b1c2022-03-27 16:29:53 +0100249 item->di_tv.v_lock = 0;
Bram Moolenaar0d1f55c2022-04-05 17:30:29 +0100250 tv->v_type = VAR_UNKNOWN;
Bram Moolenaarec15b1c2022-03-27 16:29:53 +0100251 if (dict_add(dict, item) == FAIL)
252 {
253 // can this ever happen?
254 dict_unref(dict);
255 return FAIL;
256 }
257 }
258 }
259
260 if (count > 0)
261 ectx->ec_stack.ga_len -= 2 * count - 1;
262 else if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Christian Brabandt86eddce2024-03-26 18:42:52 +0100263 {
264 dict_unref(dict);
Bram Moolenaarec15b1c2022-03-27 16:29:53 +0100265 return FAIL;
Christian Brabandt86eddce2024-03-26 18:42:52 +0100266 }
Bram Moolenaarec15b1c2022-03-27 16:29:53 +0100267 else
268 ++ectx->ec_stack.ga_len;
269 tv = STACK_TV_BOT(-1);
270 tv->v_type = VAR_DICT;
271 tv->v_lock = 0;
272 tv->vval.v_dict = dict;
273 if (dict != NULL)
274 ++dict->dv_refcount;
Bram Moolenaarfe270812020-04-11 22:31:27 +0200275 return OK;
276}
277
278/*
Bram Moolenaar4f8f5422021-06-20 19:28:14 +0200279 * If debug_tick changed check if "ufunc" has a breakpoint and update
280 * "uf_has_breakpoint".
281 */
Bram Moolenaar96923b72022-03-15 15:57:04 +0000282 void
Bram Moolenaar4f8f5422021-06-20 19:28:14 +0200283update_has_breakpoint(ufunc_T *ufunc)
284{
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +0000285 if (ufunc->uf_debug_tick == debug_tick)
286 return;
Bram Moolenaar4f8f5422021-06-20 19:28:14 +0200287
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +0000288 linenr_T breakpoint;
289
290 ufunc->uf_debug_tick = debug_tick;
291 breakpoint = dbg_find_breakpoint(FALSE, ufunc->uf_name, 0);
292 ufunc->uf_has_breakpoint = breakpoint > 0;
Bram Moolenaar4f8f5422021-06-20 19:28:14 +0200293}
294
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +0200295static garray_T dict_stack = GA_EMPTY;
296
297/*
298 * Put a value on the dict stack. This consumes "tv".
299 */
300 static int
301dict_stack_save(typval_T *tv)
302{
303 if (dict_stack.ga_growsize == 0)
Bram Moolenaar04935fb2022-01-08 16:19:22 +0000304 ga_init2(&dict_stack, sizeof(typval_T), 10);
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +0200305 if (ga_grow(&dict_stack, 1) == FAIL)
306 return FAIL;
307 ((typval_T *)dict_stack.ga_data)[dict_stack.ga_len] = *tv;
308 ++dict_stack.ga_len;
309 return OK;
310}
311
312/*
313 * Get the typval at top of the dict stack.
314 */
315 static typval_T *
316dict_stack_get_tv(void)
317{
318 if (dict_stack.ga_len == 0)
319 return NULL;
320 return ((typval_T *)dict_stack.ga_data) + dict_stack.ga_len - 1;
321}
322
323/*
324 * Get the dict at top of the dict stack.
325 */
326 static dict_T *
327dict_stack_get_dict(void)
328{
329 typval_T *tv;
330
331 if (dict_stack.ga_len == 0)
332 return NULL;
333 tv = ((typval_T *)dict_stack.ga_data) + dict_stack.ga_len - 1;
334 if (tv->v_type == VAR_DICT)
335 return tv->vval.v_dict;
336 return NULL;
337}
338
339/*
340 * Drop an item from the dict stack.
341 */
342 static void
343dict_stack_drop(void)
344{
345 if (dict_stack.ga_len == 0)
346 {
347 iemsg("Dict stack underflow");
348 return;
349 }
350 --dict_stack.ga_len;
351 clear_tv(((typval_T *)dict_stack.ga_data) + dict_stack.ga_len);
352}
353
354/*
355 * Drop items from the dict stack until the length is equal to "len".
356 */
357 static void
358dict_stack_clear(int len)
359{
360 while (dict_stack.ga_len > len)
361 dict_stack_drop();
362}
363
Bram Moolenaar4f8f5422021-06-20 19:28:14 +0200364/*
Bram Moolenaar7aca5ca2022-02-07 19:56:43 +0000365 * Get a pointer to useful "pt_outer" of "pt".
366 */
367 static outer_T *
368get_pt_outer(partial_T *pt)
369{
370 partial_T *ptref = pt->pt_outer_partial;
371
372 if (ptref == NULL)
373 return &pt->pt_outer;
374
375 // partial using partial (recursively)
376 while (ptref->pt_outer_partial != NULL)
377 ptref = ptref->pt_outer_partial;
378 return &ptref->pt_outer;
379}
380
381/*
Bram Moolenaar0d89d8a2022-12-31 14:01:24 +0000382 * Check "argcount" arguments on the stack against what "ufunc" expects.
383 * "off" is the offset of arguments on the stack.
384 * Return OK or FAIL.
385 */
386 static int
387check_ufunc_arg_types(ufunc_T *ufunc, int argcount, int off, ectx_T *ectx)
388{
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +0000389 if (ufunc->uf_arg_types == NULL && ufunc->uf_va_type == NULL)
390 return OK;
391
392 typval_T *argv = STACK_TV_BOT(0) - argcount - off;
393
394 // The function can change at runtime, check that the argument
395 // types are correct.
396 for (int i = 0; i < argcount; ++i)
Bram Moolenaar0d89d8a2022-12-31 14:01:24 +0000397 {
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +0000398 type_T *type = NULL;
Bram Moolenaar0d89d8a2022-12-31 14:01:24 +0000399
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +0000400 // assume a v:none argument, using the default value, is always OK
401 if (argv[i].v_type == VAR_SPECIAL
402 && argv[i].vval.v_number == VVAL_NONE)
403 continue;
Ernie Raelb077b582023-12-14 20:11:44 +0100404 // only pass values to user functions, never types
405 if (check_typval_is_value(&argv[i]) == FAIL)
406 return FAIL;
Bram Moolenaar0d89d8a2022-12-31 14:01:24 +0000407
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +0000408 if (i < ufunc->uf_args.ga_len && ufunc->uf_arg_types != NULL)
409 type = ufunc->uf_arg_types[i];
410 else if (ufunc->uf_va_type != NULL)
411 type = ufunc->uf_va_type->tt_member;
412 if (type != NULL && check_typval_arg_type(type,
413 &argv[i], NULL, i + 1) == FAIL)
414 return FAIL;
Bram Moolenaar0d89d8a2022-12-31 14:01:24 +0000415 }
416 return OK;
417}
418
419/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100420 * Call compiled function "cdf_idx" from compiled code.
Bram Moolenaarab360522021-01-10 14:02:28 +0100421 * This adds a stack frame and sets the instruction pointer to the start of the
422 * called function.
Bram Moolenaar5800c792022-09-22 17:34:01 +0100423 * If "pt_arg" is not NULL use "pt_arg->pt_outer" for ec_outer_ref->or_outer.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100424 *
425 * Stack has:
426 * - current arguments (already there)
427 * - omitted optional argument (default values) added here
428 * - stack frame:
429 * - pointer to calling function
430 * - Index of next instruction in calling function
431 * - previous frame pointer
432 * - reserved space for local variables
433 */
434 static int
Bram Moolenaar2fecb532021-03-24 22:00:56 +0100435call_dfunc(
436 int cdf_idx,
Bram Moolenaar5800c792022-09-22 17:34:01 +0100437 partial_T *pt_arg,
Bram Moolenaar2fecb532021-03-24 22:00:56 +0100438 int argcount_arg,
Bram Moolenaar2fecb532021-03-24 22:00:56 +0100439 ectx_T *ectx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100440{
Bram Moolenaar2fecb532021-03-24 22:00:56 +0100441 int argcount = argcount_arg;
442 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data) + cdf_idx;
443 ufunc_T *ufunc = dfunc->df_ufunc;
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +0200444 int did_emsg_before = did_emsg_cumul + did_emsg;
Bram Moolenaar2fecb532021-03-24 22:00:56 +0100445 int arg_to_add;
446 int vararg_count = 0;
447 int varcount;
448 int idx;
449 estack_T *entry;
450 funclocal_T *floc = NULL;
Bram Moolenaar648594e2021-07-11 17:55:01 +0200451 int res = OK;
Bram Moolenaar139575d2022-03-15 19:29:30 +0000452 compiletype_T compile_type;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100453
454 if (dfunc->df_deleted)
455 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +0100456 // don't use ufunc->uf_name, it may have been freed
Bram Moolenaar460ae5d2022-01-01 14:19:49 +0000457 emsg_funcname(e_function_was_deleted_str,
Bram Moolenaarcd45ed02020-12-22 17:35:54 +0100458 dfunc->df_name == NULL ? (char_u *)"unknown" : dfunc->df_name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100459 return FAIL;
460 }
461
Bram Moolenaare5ea3462021-01-25 21:01:48 +0100462#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +0100463 if (do_profiling == PROF_YES)
464 {
Bram Moolenaar35578162021-08-02 19:10:38 +0200465 if (GA_GROW_OK(&profile_info_ga, 1))
Bram Moolenaar12d26532021-02-19 19:13:21 +0100466 {
467 profinfo_T *info = ((profinfo_T *)profile_info_ga.ga_data)
468 + profile_info_ga.ga_len;
469 ++profile_info_ga.ga_len;
470 CLEAR_POINTER(info);
471 profile_may_start_func(info, ufunc,
472 (((dfunc_T *)def_functions.ga_data)
473 + ectx->ec_dfunc_idx)->df_ufunc);
474 }
Bram Moolenaar12d26532021-02-19 19:13:21 +0100475 }
Bram Moolenaare5ea3462021-01-25 21:01:48 +0100476#endif
477
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +0200478 // When debugging and using "cont" switches to the not-debugged
479 // instructions, may need to still compile them.
Bram Moolenaar139575d2022-03-15 19:29:30 +0000480 compile_type = get_compile_type(ufunc);
481 if (func_needs_compiling(ufunc, compile_type))
Bram Moolenaar648594e2021-07-11 17:55:01 +0200482 {
Bram Moolenaar139575d2022-03-15 19:29:30 +0000483 res = compile_def_function(ufunc, FALSE, compile_type, NULL);
Bram Moolenaar648594e2021-07-11 17:55:01 +0200484
485 // compile_def_function() may cause def_functions.ga_data to change
486 dfunc = ((dfunc_T *)def_functions.ga_data) + cdf_idx;
487 }
488 if (res == FAIL || INSTRUCTIONS(dfunc) == NULL)
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +0200489 {
490 if (did_emsg_cumul + did_emsg == did_emsg_before)
491 semsg(_(e_function_is_not_compiled_str),
492 printable_func_name(ufunc));
493 return FAIL;
494 }
495
Bram Moolenaar1378fbc2020-04-11 20:50:33 +0200496 if (ufunc->uf_va_name != NULL)
497 {
Bram Moolenaarfe270812020-04-11 22:31:27 +0200498 // Need to make a list out of the vararg arguments.
Bram Moolenaar1378fbc2020-04-11 20:50:33 +0200499 // Stack at time of call with 2 varargs:
500 // normal_arg
501 // optional_arg
502 // vararg_1
503 // vararg_2
Bram Moolenaarfe270812020-04-11 22:31:27 +0200504 // After creating the list:
505 // normal_arg
506 // optional_arg
507 // vararg-list
508 // With missing optional arguments we get:
Bram Moolenaar1378fbc2020-04-11 20:50:33 +0200509 // normal_arg
Bram Moolenaarfe270812020-04-11 22:31:27 +0200510 // After creating the list
511 // normal_arg
512 // (space for optional_arg)
513 // vararg-list
Bram Moolenaar1378fbc2020-04-11 20:50:33 +0200514 vararg_count = argcount - ufunc->uf_args.ga_len;
515 if (vararg_count < 0)
516 vararg_count = 0;
517 else
518 argcount -= vararg_count;
Bram Moolenaarfe270812020-04-11 22:31:27 +0200519 if (exe_newlist(vararg_count, ectx) == FAIL)
Bram Moolenaar1378fbc2020-04-11 20:50:33 +0200520 return FAIL;
Bram Moolenaarfe270812020-04-11 22:31:27 +0200521
522 vararg_count = 1;
Bram Moolenaar1378fbc2020-04-11 20:50:33 +0200523 }
524
Bram Moolenaarfe270812020-04-11 22:31:27 +0200525 arg_to_add = ufunc->uf_args.ga_len - argcount;
Bram Moolenaar1378fbc2020-04-11 20:50:33 +0200526 if (arg_to_add < 0)
527 {
Matvey Tarasovd14bb1a2022-06-29 13:18:27 +0100528 semsg(NGETTEXT(e_one_argument_too_many, e_nr_arguments_too_many,
529 -arg_to_add), -arg_to_add);
Bram Moolenaar1378fbc2020-04-11 20:50:33 +0200530 return FAIL;
531 }
Bram Moolenaarcd1cda22022-02-16 21:48:25 +0000532 else if (arg_to_add > ufunc->uf_def_args.ga_len)
533 {
534 int missing = arg_to_add - ufunc->uf_def_args.ga_len;
535
Matvey Tarasovd14bb1a2022-06-29 13:18:27 +0100536 semsg(NGETTEXT(e_one_argument_too_few, e_nr_arguments_too_few,
537 missing), missing);
Bram Moolenaarcd1cda22022-02-16 21:48:25 +0000538 return FAIL;
539 }
Bram Moolenaar148ce7a2020-09-23 21:57:23 +0200540
Bram Moolenaar574950d2023-01-03 19:08:50 +0000541 // If this is an object method, the object is just before the arguments.
542 typval_T *obj = STACK_TV_BOT(0) - argcount - vararg_count - 1;
543
Yegappan Lakshmananc1946262023-09-25 21:00:46 +0200544 if (IS_OBJECT_METHOD(ufunc) && !IS_CONSTRUCTOR_METHOD(ufunc)
545 && obj->v_type == VAR_OBJECT && obj->vval.v_object == NULL)
546 {
547 // If this is not a constructor method, then a valid object is
548 // needed.
549 emsg(_(e_using_null_object));
550 return FAIL;
551 }
552
Bram Moolenaar0d89d8a2022-12-31 14:01:24 +0000553 // Check the argument types.
554 if (check_ufunc_arg_types(ufunc, argcount, vararg_count, ectx) == FAIL)
555 return FAIL;
556
mityua5550692023-11-25 15:41:20 +0100557 // While check_ufunc_arg_types call, def function compilation process may
558 // run. If so many def functions are compiled, def_functions array may be
559 // reallocated and dfunc may no longer have valid pointer. Get the object
560 // pointer from def_functions again here.
561 dfunc = ((dfunc_T *)def_functions.ga_data) + cdf_idx;
562
Bram Moolenaar148ce7a2020-09-23 21:57:23 +0200563 // Reserve space for:
564 // - missing arguments
565 // - stack frame
566 // - local variables
567 // - if needed: a counter for number of closures created in
568 // ectx->ec_funcrefs.
569 varcount = dfunc->df_varcount + dfunc->df_has_closure;
Bram Moolenaarb46c0832022-09-15 17:19:37 +0100570 if (GA_GROW_FAILS(&ectx->ec_stack,
571 arg_to_add + STACK_FRAME_SIZE + varcount))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100572 return FAIL;
573
Yegappan Lakshmanan1087b8c2023-10-07 22:03:18 +0200574 // The object pointer is in the execution typval stack. The GA_GROW call
575 // above may have reallocated the execution typval stack. So the object
576 // pointer may not be valid anymore. Get the object pointer again from the
577 // execution stack.
578 obj = STACK_TV_BOT(0) - argcount - vararg_count - 1;
579
Bram Moolenaar0ba48e82020-11-17 18:23:19 +0100580 // If depth of calling is getting too high, don't execute the function.
581 if (funcdepth_increment() == FAIL)
582 return FAIL;
Bram Moolenaare99d4222021-06-13 14:01:26 +0200583 ++ex_nesting_level;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +0100584
Bram Moolenaar2fecb532021-03-24 22:00:56 +0100585 // Only make a copy of funclocal if it contains something to restore.
Bram Moolenaar4c137212021-04-19 16:48:48 +0200586 if (ectx->ec_funclocal.floc_restore_cmdmod)
Bram Moolenaar2fecb532021-03-24 22:00:56 +0100587 {
588 floc = ALLOC_ONE(funclocal_T);
589 if (floc == NULL)
590 return FAIL;
Bram Moolenaar4c137212021-04-19 16:48:48 +0200591 *floc = ectx->ec_funclocal;
592 ectx->ec_funclocal.floc_restore_cmdmod = FALSE;
Bram Moolenaar2fecb532021-03-24 22:00:56 +0100593 }
594
Bram Moolenaarfe270812020-04-11 22:31:27 +0200595 // Move the vararg-list to below the missing optional arguments.
596 if (vararg_count > 0 && arg_to_add > 0)
597 *STACK_TV_BOT(arg_to_add - 1) = *STACK_TV_BOT(-1);
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100598
599 // Reserve space for omitted optional arguments, filled in soon.
Bram Moolenaar1378fbc2020-04-11 20:50:33 +0200600 for (idx = 0; idx < arg_to_add; ++idx)
Bram Moolenaarfe270812020-04-11 22:31:27 +0200601 STACK_TV_BOT(idx - vararg_count)->v_type = VAR_UNKNOWN;
Bram Moolenaar1378fbc2020-04-11 20:50:33 +0200602 ectx->ec_stack.ga_len += arg_to_add;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100603
604 // Store current execution state in stack frame for ISN_RETURN.
Bram Moolenaar0186e582021-01-10 18:33:11 +0100605 STACK_TV_BOT(STACK_FRAME_FUNC_OFF)->vval.v_number = ectx->ec_dfunc_idx;
606 STACK_TV_BOT(STACK_FRAME_IIDX_OFF)->vval.v_number = ectx->ec_iidx;
Bram Moolenaar5930ddc2021-04-26 20:32:59 +0200607 STACK_TV_BOT(STACK_FRAME_INSTR_OFF)->vval.v_string = (void *)ectx->ec_instr;
Bram Moolenaarc04f2a42021-06-09 19:30:03 +0200608 STACK_TV_BOT(STACK_FRAME_OUTER_OFF)->vval.v_string =
609 (void *)ectx->ec_outer_ref;
Bram Moolenaar2fecb532021-03-24 22:00:56 +0100610 STACK_TV_BOT(STACK_FRAME_FUNCLOCAL_OFF)->vval.v_string = (void *)floc;
Bram Moolenaar0186e582021-01-10 18:33:11 +0100611 STACK_TV_BOT(STACK_FRAME_IDX_OFF)->vval.v_number = ectx->ec_frame_idx;
Bram Moolenaarbf67ea12020-05-02 17:52:42 +0200612 ectx->ec_frame_idx = ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100613
Bram Moolenaar5800c792022-09-22 17:34:01 +0100614 // Initialize all local variables to number zero. Also initialize the
615 // variable that counts how many closures were created. This is used in
616 // handle_closure_in_use().
617 int initcount = dfunc->df_varcount + (dfunc->df_has_closure ? 1 : 0);
618 for (idx = 0; idx < initcount; ++idx)
Bram Moolenaar5cd64792021-12-25 18:23:24 +0000619 {
620 typval_T *tv = STACK_TV_BOT(STACK_FRAME_SIZE + idx);
621
622 tv->v_type = VAR_NUMBER;
623 tv->vval.v_number = 0;
624 }
Bram Moolenaar148ce7a2020-09-23 21:57:23 +0200625 ectx->ec_stack.ga_len += STACK_FRAME_SIZE + varcount;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100626
Bram Moolenaar574950d2023-01-03 19:08:50 +0000627 // For an object method move the object from just before the arguments to
628 // the first local variable.
Yegappan Lakshmanan1db15142023-09-19 20:34:05 +0200629 if (IS_OBJECT_METHOD(ufunc))
Bram Moolenaar574950d2023-01-03 19:08:50 +0000630 {
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +0200631 if (obj->v_type != VAR_OBJECT)
632 {
633 semsg(_(e_internal_error_str), "type in stack is not an object");
634 return FAIL;
635 }
636
Bram Moolenaar574950d2023-01-03 19:08:50 +0000637 *STACK_TV_VAR(0) = *obj;
638 obj->v_type = VAR_UNKNOWN;
639 }
640
Bram Moolenaar5800c792022-09-22 17:34:01 +0100641 partial_T *pt = pt_arg != NULL ? pt_arg : ufunc->uf_partial;
642 if (pt != NULL || (ufunc->uf_flags & FC_CLOSURE))
Bram Moolenaarcd45ed02020-12-22 17:35:54 +0100643 {
Bram Moolenaarc04f2a42021-06-09 19:30:03 +0200644 outer_ref_T *ref = ALLOC_CLEAR_ONE(outer_ref_T);
Bram Moolenaar0186e582021-01-10 18:33:11 +0100645
Bram Moolenaarc04f2a42021-06-09 19:30:03 +0200646 if (ref == NULL)
Bram Moolenaar0186e582021-01-10 18:33:11 +0100647 return FAIL;
648 if (pt != NULL)
649 {
Bram Moolenaar7aca5ca2022-02-07 19:56:43 +0000650 ref->or_outer = get_pt_outer(pt);
Bram Moolenaarc04f2a42021-06-09 19:30:03 +0200651 ++pt->pt_refcount;
652 ref->or_partial = pt;
Bram Moolenaar0186e582021-01-10 18:33:11 +0100653 }
Bram Moolenaar0186e582021-01-10 18:33:11 +0100654 else
655 {
Bram Moolenaarc04f2a42021-06-09 19:30:03 +0200656 ref->or_outer = ALLOC_CLEAR_ONE(outer_T);
Dominique Pelle5a9e5842021-07-24 19:32:12 +0200657 if (unlikely(ref->or_outer == NULL))
Bram Moolenaarc04f2a42021-06-09 19:30:03 +0200658 {
659 vim_free(ref);
660 return FAIL;
661 }
662 ref->or_outer_allocated = TRUE;
663 ref->or_outer->out_stack = &ectx->ec_stack;
664 ref->or_outer->out_frame_idx = ectx->ec_frame_idx;
665 if (ectx->ec_outer_ref != NULL)
666 ref->or_outer->out_up = ectx->ec_outer_ref->or_outer;
Bram Moolenaar0186e582021-01-10 18:33:11 +0100667 }
Bram Moolenaarc04f2a42021-06-09 19:30:03 +0200668 ectx->ec_outer_ref = ref;
Bram Moolenaarab360522021-01-10 14:02:28 +0100669 }
Bram Moolenaar0186e582021-01-10 18:33:11 +0100670 else
Bram Moolenaarc04f2a42021-06-09 19:30:03 +0200671 ectx->ec_outer_ref = NULL;
Bram Moolenaarcd45ed02020-12-22 17:35:54 +0100672
Bram Moolenaarc970e422021-03-17 15:03:04 +0100673 ++ufunc->uf_calls;
674
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100675 // Set execution state to the start of the called function.
676 ectx->ec_dfunc_idx = cdf_idx;
Bram Moolenaare5ea3462021-01-25 21:01:48 +0100677 ectx->ec_instr = INSTRUCTIONS(dfunc);
Bram Moolenaarb2049902021-01-24 12:53:53 +0100678 entry = estack_push_ufunc(ufunc, 1);
Bram Moolenaarc620c052020-07-08 15:16:19 +0200679 if (entry != NULL)
680 {
681 // Set the script context to the script where the function was defined.
Bram Moolenaarc70fe462021-04-17 17:59:19 +0200682 // Save the current context so it can be restored on return.
683 entry->es_save_sctx = current_sctx;
684 current_sctx = ufunc->uf_script_ctx;
Bram Moolenaarc620c052020-07-08 15:16:19 +0200685 }
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100686
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +0200687 // Start execution at the first instruction.
688 ectx->ec_iidx = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100689
690 return OK;
691}
692
Bram Moolenaar7509ad82021-12-14 18:14:37 +0000693// Double linked list of funcstack_T in use.
694static funcstack_T *first_funcstack = NULL;
695
696 static void
697add_funcstack_to_list(funcstack_T *funcstack)
698{
699 // Link in list of funcstacks.
700 if (first_funcstack != NULL)
701 first_funcstack->fs_prev = funcstack;
702 funcstack->fs_next = first_funcstack;
703 funcstack->fs_prev = NULL;
704 first_funcstack = funcstack;
705}
706
707 static void
708remove_funcstack_from_list(funcstack_T *funcstack)
709{
710 if (funcstack->fs_prev == NULL)
711 first_funcstack = funcstack->fs_next;
712 else
713 funcstack->fs_prev->fs_next = funcstack->fs_next;
714 if (funcstack->fs_next != NULL)
715 funcstack->fs_next->fs_prev = funcstack->fs_prev;
716}
717
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100718/*
Bram Moolenaarbf67ea12020-05-02 17:52:42 +0200719 * Used when returning from a function: Check if any closure is still
720 * referenced. If so then move the arguments and variables to a separate piece
721 * of stack to be used when the closure is called.
722 * When "free_arguments" is TRUE the arguments are to be freed.
723 * Returns FAIL when out of memory.
724 */
725 static int
726handle_closure_in_use(ectx_T *ectx, int free_arguments)
727{
728 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
729 + ectx->ec_dfunc_idx;
Bram Moolenaarfdeab652020-09-19 15:16:50 +0200730 int argcount;
731 int top;
Bram Moolenaarbf67ea12020-05-02 17:52:42 +0200732 int idx;
733 typval_T *tv;
734 int closure_in_use = FALSE;
Bram Moolenaar148ce7a2020-09-23 21:57:23 +0200735 garray_T *gap = &ectx->ec_funcrefs;
736 varnumber_T closure_count;
Bram Moolenaarbf67ea12020-05-02 17:52:42 +0200737
Bram Moolenaarfdeab652020-09-19 15:16:50 +0200738 if (dfunc->df_ufunc == NULL)
Bram Moolenaar148ce7a2020-09-23 21:57:23 +0200739 return OK; // function was freed
740 if (dfunc->df_has_closure == 0)
741 return OK; // no closures
742 tv = STACK_TV(ectx->ec_frame_idx + STACK_FRAME_SIZE + dfunc->df_varcount);
743 closure_count = tv->vval.v_number;
744 if (closure_count == 0)
745 return OK; // no funcrefs created
746
Bram Moolenaar8fa745e2022-09-16 19:04:24 +0100747 // Compute "top": the first entry in the stack used by the function.
748 // This is the first argument (after that comes the stack frame and then
749 // the local variables).
Bram Moolenaarfdeab652020-09-19 15:16:50 +0200750 argcount = ufunc_argcount(dfunc->df_ufunc);
751 top = ectx->ec_frame_idx - argcount;
752
Bram Moolenaarbf67ea12020-05-02 17:52:42 +0200753 // Check if any created closure is still in use.
Bram Moolenaar148ce7a2020-09-23 21:57:23 +0200754 for (idx = 0; idx < closure_count; ++idx)
Bram Moolenaarbf67ea12020-05-02 17:52:42 +0200755 {
Bram Moolenaarc70bdab2020-09-26 19:59:38 +0200756 partial_T *pt;
757 int off = gap->ga_len - closure_count + idx;
Bram Moolenaar148ce7a2020-09-23 21:57:23 +0200758
Bram Moolenaarc70bdab2020-09-26 19:59:38 +0200759 if (off < 0)
760 continue; // count is off or already done
761 pt = ((partial_T **)gap->ga_data)[off];
Bram Moolenaar148ce7a2020-09-23 21:57:23 +0200762 if (pt->pt_refcount > 1)
Bram Moolenaarf7779c62020-05-03 15:38:16 +0200763 {
Bram Moolenaar148ce7a2020-09-23 21:57:23 +0200764 int refcount = pt->pt_refcount;
Bram Moolenaar221fcc72020-05-05 19:46:20 +0200765 int i;
766
Dominique Pelleaf4a61a2021-12-27 17:21:41 +0000767 // A Reference in a local variable doesn't count, it gets
Bram Moolenaar221fcc72020-05-05 19:46:20 +0200768 // unreferenced on return.
769 for (i = 0; i < dfunc->df_varcount; ++i)
770 {
771 typval_T *stv = STACK_TV(ectx->ec_frame_idx
772 + STACK_FRAME_SIZE + i);
Bram Moolenaar148ce7a2020-09-23 21:57:23 +0200773 if (stv->v_type == VAR_PARTIAL && pt == stv->vval.v_partial)
Bram Moolenaar221fcc72020-05-05 19:46:20 +0200774 --refcount;
775 }
776 if (refcount > 1)
777 {
778 closure_in_use = TRUE;
779 break;
780 }
Bram Moolenaarf7779c62020-05-03 15:38:16 +0200781 }
Bram Moolenaarbf67ea12020-05-02 17:52:42 +0200782 }
783
784 if (closure_in_use)
785 {
786 funcstack_T *funcstack = ALLOC_CLEAR_ONE(funcstack_T);
787 typval_T *stack;
788
789 // A closure is using the arguments and/or local variables.
790 // Move them to the called function.
791 if (funcstack == NULL)
792 return FAIL;
Bram Moolenaar7509ad82021-12-14 18:14:37 +0000793
Bram Moolenaar85d5e2b2020-10-10 14:13:01 +0200794 funcstack->fs_var_offset = argcount + STACK_FRAME_SIZE;
Bram Moolenaar1936c762022-09-28 15:19:10 +0100795 funcstack->fs_ga.ga_len = funcstack->fs_var_offset
796 + dfunc->df_varcount;
Bram Moolenaarbf67ea12020-05-02 17:52:42 +0200797 stack = ALLOC_CLEAR_MULT(typval_T, funcstack->fs_ga.ga_len);
798 funcstack->fs_ga.ga_data = stack;
799 if (stack == NULL)
800 {
801 vim_free(funcstack);
802 return FAIL;
803 }
Bram Moolenaar7509ad82021-12-14 18:14:37 +0000804 add_funcstack_to_list(funcstack);
Bram Moolenaarbf67ea12020-05-02 17:52:42 +0200805
806 // Move or copy the arguments.
807 for (idx = 0; idx < argcount; ++idx)
808 {
809 tv = STACK_TV(top + idx);
810 if (free_arguments)
811 {
812 *(stack + idx) = *tv;
813 tv->v_type = VAR_UNKNOWN;
814 }
815 else
816 copy_tv(tv, stack + idx);
817 }
Bram Moolenaar8fa745e2022-09-16 19:04:24 +0100818 // Skip the stack frame.
Bram Moolenaarbf67ea12020-05-02 17:52:42 +0200819 // Move the local variables.
820 for (idx = 0; idx < dfunc->df_varcount; ++idx)
821 {
822 tv = STACK_TV(ectx->ec_frame_idx + STACK_FRAME_SIZE + idx);
Bram Moolenaarf821dda2020-05-06 22:18:17 +0200823
Bram Moolenaar85d5e2b2020-10-10 14:13:01 +0200824 // A partial created for a local function, that is also used as a
825 // local variable, has a reference count for the variable, thus
826 // will never go down to zero. When all these refcounts are one
827 // then the funcstack is unused. We need to count how many we have
Bram Moolenaar7509ad82021-12-14 18:14:37 +0000828 // so we know when to check.
Bram Moolenaarf821dda2020-05-06 22:18:17 +0200829 if (tv->v_type == VAR_PARTIAL && tv->vval.v_partial != NULL)
830 {
Bram Moolenaar85d5e2b2020-10-10 14:13:01 +0200831 int i;
Bram Moolenaarf821dda2020-05-06 22:18:17 +0200832
Bram Moolenaar148ce7a2020-09-23 21:57:23 +0200833 for (i = 0; i < closure_count; ++i)
Bram Moolenaar85d5e2b2020-10-10 14:13:01 +0200834 if (tv->vval.v_partial == ((partial_T **)gap->ga_data)[
835 gap->ga_len - closure_count + i])
836 ++funcstack->fs_min_refcount;
Bram Moolenaarf821dda2020-05-06 22:18:17 +0200837 }
838
Bram Moolenaar85d5e2b2020-10-10 14:13:01 +0200839 *(stack + funcstack->fs_var_offset + idx) = *tv;
Bram Moolenaarbf67ea12020-05-02 17:52:42 +0200840 tv->v_type = VAR_UNKNOWN;
841 }
842
Bram Moolenaar148ce7a2020-09-23 21:57:23 +0200843 for (idx = 0; idx < closure_count; ++idx)
Bram Moolenaarbf67ea12020-05-02 17:52:42 +0200844 {
Bram Moolenaar148ce7a2020-09-23 21:57:23 +0200845 partial_T *pt = ((partial_T **)gap->ga_data)[gap->ga_len
846 - closure_count + idx];
847 if (pt->pt_refcount > 1)
Bram Moolenaarbf67ea12020-05-02 17:52:42 +0200848 {
Bram Moolenaar148ce7a2020-09-23 21:57:23 +0200849 ++funcstack->fs_refcount;
850 pt->pt_funcstack = funcstack;
Bram Moolenaar0186e582021-01-10 18:33:11 +0100851 pt->pt_outer.out_stack = &funcstack->fs_ga;
852 pt->pt_outer.out_frame_idx = ectx->ec_frame_idx - top;
Bram Moolenaarbf67ea12020-05-02 17:52:42 +0200853 }
854 }
855 }
856
Bram Moolenaar148ce7a2020-09-23 21:57:23 +0200857 for (idx = 0; idx < closure_count; ++idx)
858 partial_unref(((partial_T **)gap->ga_data)[gap->ga_len
859 - closure_count + idx]);
860 gap->ga_len -= closure_count;
861 if (gap->ga_len == 0)
862 ga_clear(gap);
863
Bram Moolenaarbf67ea12020-05-02 17:52:42 +0200864 return OK;
865}
866
867/*
Bram Moolenaar85d5e2b2020-10-10 14:13:01 +0200868 * Called when a partial is freed or its reference count goes down to one. The
869 * funcstack may be the only reference to the partials in the local variables.
870 * Go over all of them, the funcref and can be freed if all partials
871 * referencing the funcstack have a reference count of one.
Bram Moolenaaracd6b992022-09-17 16:27:39 +0100872 * Returns TRUE if the funcstack is freed, the partial referencing it will then
873 * also have been freed.
Bram Moolenaar85d5e2b2020-10-10 14:13:01 +0200874 */
Bram Moolenaaracd6b992022-09-17 16:27:39 +0100875 int
Bram Moolenaar85d5e2b2020-10-10 14:13:01 +0200876funcstack_check_refcount(funcstack_T *funcstack)
877{
Bram Moolenaaracd6b992022-09-17 16:27:39 +0100878 int i;
879 garray_T *gap = &funcstack->fs_ga;
880 int done = 0;
881 typval_T *stack;
Bram Moolenaar85d5e2b2020-10-10 14:13:01 +0200882
883 if (funcstack->fs_refcount > funcstack->fs_min_refcount)
Bram Moolenaaracd6b992022-09-17 16:27:39 +0100884 return FALSE;
Bram Moolenaar85d5e2b2020-10-10 14:13:01 +0200885 for (i = funcstack->fs_var_offset; i < gap->ga_len; ++i)
886 {
887 typval_T *tv = ((typval_T *)gap->ga_data) + i;
888
889 if (tv->v_type == VAR_PARTIAL && tv->vval.v_partial != NULL
890 && tv->vval.v_partial->pt_funcstack == funcstack
891 && tv->vval.v_partial->pt_refcount == 1)
892 ++done;
893 }
Bram Moolenaaracd6b992022-09-17 16:27:39 +0100894 if (done != funcstack->fs_min_refcount)
895 return FALSE;
Bram Moolenaar85d5e2b2020-10-10 14:13:01 +0200896
Bram Moolenaaracd6b992022-09-17 16:27:39 +0100897 stack = gap->ga_data;
898
899 // All partials referencing the funcstack have a reference count of
900 // one, thus the funcstack is no longer of use.
901 for (i = 0; i < gap->ga_len; ++i)
902 clear_tv(stack + i);
903 vim_free(stack);
904 remove_funcstack_from_list(funcstack);
905 vim_free(funcstack);
906
907 return TRUE;
Bram Moolenaar85d5e2b2020-10-10 14:13:01 +0200908}
909
910/*
Bram Moolenaar7509ad82021-12-14 18:14:37 +0000911 * For garbage collecting: set references in all variables referenced by
912 * all funcstacks.
913 */
914 int
915set_ref_in_funcstacks(int copyID)
916{
917 funcstack_T *funcstack;
918
919 for (funcstack = first_funcstack; funcstack != NULL;
920 funcstack = funcstack->fs_next)
921 {
922 typval_T *stack = funcstack->fs_ga.ga_data;
923 int i;
924
925 for (i = 0; i < funcstack->fs_ga.ga_len; ++i)
926 if (set_ref_in_item(stack + i, copyID, NULL, NULL))
927 return TRUE; // abort
928 }
929 return FALSE;
930}
931
Bram Moolenaar806a2732022-09-04 15:40:36 +0100932// Ugly static to avoid passing the execution context around through many
933// layers.
934static ectx_T *current_ectx = NULL;
935
Bram Moolenaar7509ad82021-12-14 18:14:37 +0000936/*
Bram Moolenaar806a2732022-09-04 15:40:36 +0100937 * Return TRUE if currently executing a :def function.
938 * Can be used by builtin functions only.
Bram Moolenaar1d84f762022-09-03 21:35:53 +0100939 */
Bram Moolenaar806a2732022-09-04 15:40:36 +0100940 int
941in_def_function(void)
942{
943 return current_ectx != NULL;
944}
945
946/*
Ernie Rael4c8da022023-10-11 21:35:11 +0200947 * If executing a class/object method, then fill in the lval_T.
948 * Set lr_tv to the executing item, and lr_exec_class to the executing class;
949 * use free_tv and class_unref when finished with the lval_root.
950 * For use by builtin functions.
951 *
952 * Return FAIL and do nothing if not executing in a class; otherwise OK.
953 */
954 int
955fill_exec_lval_root(lval_root_T *root)
956{
957 ectx_T *ectx = current_ectx;
958 if (ectx != NULL)
959 {
960 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
961 + current_ectx->ec_dfunc_idx;
962 ufunc_T *ufunc = dfunc->df_ufunc;
963 if (ufunc->uf_class != NULL) // executing a method?
964 {
965 typval_T *tv = alloc_tv();
966 if (tv != NULL)
967 {
968 CLEAR_POINTER(root);
969 root->lr_tv = tv;
970 copy_tv(STACK_TV_VAR(0), root->lr_tv);
971 root->lr_cl_exec = ufunc->uf_class;
972 ++root->lr_cl_exec->class_refcount;
973 return OK;
974 }
975 }
976 }
977
978 return FAIL;
979}
980
981/*
Bram Moolenaar98aff652022-09-06 21:02:35 +0100982 * Clear "current_ectx" and return the previous value. To be used when calling
983 * a user function.
984 */
985 ectx_T *
dundargocc57b5bc2022-11-02 13:30:51 +0000986clear_current_ectx(void)
Bram Moolenaar98aff652022-09-06 21:02:35 +0100987{
988 ectx_T *r = current_ectx;
989
990 current_ectx = NULL;
991 return r;
992}
993
994 void
995restore_current_ectx(ectx_T *ectx)
996{
997 if (current_ectx != NULL)
998 iemsg("Restoring current_ectx while it is not NULL");
999 current_ectx = ectx;
1000}
1001
1002/*
Bram Moolenaar806a2732022-09-04 15:40:36 +01001003 * Add an entry for a deferred function call to the currently executing
1004 * function.
1005 * Return the list or NULL when failed.
1006 */
1007 static list_T *
1008add_defer_item(int var_idx, int argcount, ectx_T *ectx)
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001009{
1010 typval_T *defer_tv = STACK_TV_VAR(var_idx);
1011 list_T *defer_l;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001012 list_T *l;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001013 typval_T listval;
1014
1015 if (defer_tv->v_type != VAR_LIST)
1016 {
Bram Moolenaara5348f22022-09-04 11:42:22 +01001017 // first time, allocate the list
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001018 if (rettv_list_alloc(defer_tv) == FAIL)
Bram Moolenaar806a2732022-09-04 15:40:36 +01001019 return NULL;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001020 }
1021 defer_l = defer_tv->vval.v_list;
1022
1023 l = list_alloc_with_items(argcount + 1);
1024 if (l == NULL)
Bram Moolenaar806a2732022-09-04 15:40:36 +01001025 return NULL;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001026 listval.v_type = VAR_LIST;
1027 listval.vval.v_list = l;
1028 listval.v_lock = 0;
Bram Moolenaara5348f22022-09-04 11:42:22 +01001029 if (list_insert_tv(defer_l, &listval, defer_l->lv_first) == FAIL)
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001030 {
1031 vim_free(l);
Bram Moolenaar806a2732022-09-04 15:40:36 +01001032 return NULL;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001033 }
1034
Bram Moolenaar806a2732022-09-04 15:40:36 +01001035 return l;
1036}
1037
1038/*
1039 * Handle ISN_DEFER. Stack has a function reference and "argcount" arguments.
1040 * The local variable that lists deferred functions is "var_idx".
1041 * Returns OK or FAIL.
1042 */
1043 static int
Yegappan Lakshmananf3eac692023-10-17 11:00:45 +02001044defer_command(int var_idx, int argcount, ectx_T *ectx)
Bram Moolenaar806a2732022-09-04 15:40:36 +01001045{
Yegappan Lakshmananf3eac692023-10-17 11:00:45 +02001046 list_T *l = add_defer_item(var_idx, argcount, ectx);
Bram Moolenaar806a2732022-09-04 15:40:36 +01001047 int i;
1048 typval_T *func_tv;
1049
1050 if (l == NULL)
1051 return FAIL;
1052
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001053 func_tv = STACK_TV_BOT(-argcount - 1);
Yegappan Lakshmananf3eac692023-10-17 11:00:45 +02001054 if (func_tv->v_type != VAR_PARTIAL && func_tv->v_type != VAR_FUNC)
Bram Moolenaarf5fec052022-09-11 11:49:22 +01001055 {
1056 semsg(_(e_expected_str_but_got_str),
Yegappan Lakshmananf3eac692023-10-17 11:00:45 +02001057 "function or partial",
Bram Moolenaarf5fec052022-09-11 11:49:22 +01001058 vartype_name(func_tv->v_type));
1059 return FAIL;
1060 }
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001061 list_set_item(l, 0, func_tv);
1062
Bram Moolenaarf5fec052022-09-11 11:49:22 +01001063 for (i = 0; i < argcount; ++i)
Yegappan Lakshmananf3eac692023-10-17 11:00:45 +02001064 list_set_item(l, i + 1, STACK_TV_BOT(-argcount + i));
1065 ectx->ec_stack.ga_len -= argcount + 1;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001066 return OK;
1067}
1068
1069/*
Bram Moolenaar8dbab1d2023-01-27 20:14:02 +00001070 * Add a deferred call for "name" with arguments "argvars[argcount]".
Bram Moolenaar806a2732022-09-04 15:40:36 +01001071 * Consumes "name", also on failure.
1072 * Only to be called when in_def_function() returns TRUE.
1073 */
1074 int
1075add_defer_function(char_u *name, int argcount, typval_T *argvars)
1076{
1077 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
1078 + current_ectx->ec_dfunc_idx;
1079 list_T *l;
1080 typval_T func_tv;
1081 int i;
1082
1083 if (dfunc->df_defer_var_idx == 0)
1084 {
1085 iemsg("df_defer_var_idx is zero");
Bram Moolenaar31ea6bf2022-09-05 10:47:13 +01001086 vim_free(name);
Bram Moolenaar806a2732022-09-04 15:40:36 +01001087 return FAIL;
1088 }
Bram Moolenaar806a2732022-09-04 15:40:36 +01001089
Bram Moolenaarf5fec052022-09-11 11:49:22 +01001090 l = add_defer_item(dfunc->df_defer_var_idx - 1, argcount, current_ectx);
Bram Moolenaar806a2732022-09-04 15:40:36 +01001091 if (l == NULL)
1092 {
Bram Moolenaar31ea6bf2022-09-05 10:47:13 +01001093 vim_free(name);
Bram Moolenaar806a2732022-09-04 15:40:36 +01001094 return FAIL;
1095 }
1096
Bram Moolenaar31ea6bf2022-09-05 10:47:13 +01001097 func_tv.v_type = VAR_FUNC;
1098 func_tv.v_lock = 0;
1099 func_tv.vval.v_string = name;
Bram Moolenaar806a2732022-09-04 15:40:36 +01001100 list_set_item(l, 0, &func_tv);
Bram Moolenaar31ea6bf2022-09-05 10:47:13 +01001101
Bram Moolenaar806a2732022-09-04 15:40:36 +01001102 for (i = 0; i < argcount; ++i)
1103 list_set_item(l, i + 1, argvars + i);
1104 return OK;
1105}
1106
1107/*
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001108 * Invoked when returning from a function: Invoke any deferred calls.
1109 */
1110 static void
1111invoke_defer_funcs(ectx_T *ectx)
1112{
1113 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
1114 + ectx->ec_dfunc_idx;
1115 typval_T *defer_tv = STACK_TV_VAR(dfunc->df_defer_var_idx - 1);
1116 listitem_T *li;
1117
1118 if (defer_tv->v_type != VAR_LIST)
1119 return; // no function added
Yegappan Lakshmanan14113fd2023-03-07 17:13:51 +00001120 FOR_ALL_LIST_ITEMS(defer_tv->vval.v_list, li)
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001121 {
1122 list_T *l = li->li_tv.vval.v_list;
1123 typval_T rettv;
1124 typval_T argvars[MAX_FUNC_ARGS];
1125 int i;
1126 listitem_T *arg_li = l->lv_first;
Bram Moolenaar8dbab1d2023-01-27 20:14:02 +00001127 typval_T *functv = &l->lv_first->li_tv;
Yegappan Lakshmananf3eac692023-10-17 11:00:45 +02001128 int argcount = l->lv_len - 1;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001129
zeertzjqa1f2b5d2023-04-18 21:04:53 +01001130 if (functv->vval.v_string == NULL)
1131 // already being called, can happen if function does ":qa"
1132 continue;
1133
Bram Moolenaar8dbab1d2023-01-27 20:14:02 +00001134 for (i = 0; i < argcount; ++i)
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001135 {
1136 arg_li = arg_li->li_next;
1137 argvars[i] = arg_li->li_tv;
1138 }
1139
Bram Moolenaar8dbab1d2023-01-27 20:14:02 +00001140 funcexe_T funcexe;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001141 CLEAR_FIELD(funcexe);
1142 funcexe.fe_evaluate = TRUE;
1143 rettv.v_type = VAR_UNKNOWN;
Bram Moolenaar8dbab1d2023-01-27 20:14:02 +00001144 if (functv->v_type == VAR_PARTIAL)
1145 {
1146 funcexe.fe_partial = functv->vval.v_partial;
Yegappan Lakshmananf3eac692023-10-17 11:00:45 +02001147 funcexe.fe_object = functv->vval.v_partial->pt_obj;
Bram Moolenaar8dbab1d2023-01-27 20:14:02 +00001148 if (funcexe.fe_object != NULL)
1149 ++funcexe.fe_object->obj_refcount;
1150 }
zeertzjqa1f2b5d2023-04-18 21:04:53 +01001151
1152 char_u *name = functv->vval.v_string;
1153 functv->vval.v_string = NULL;
1154
Yegappan Lakshmanan06725952023-10-18 11:47:37 +02001155 // If the deferred function is called after an exception, then only the
Yegappan Lakshmananc59c1e02023-10-19 10:52:34 +02001156 // first statement in the function will be executed (because of the
1157 // exception). So save and restore the try/catch/throw exception
1158 // state.
1159 exception_state_T estate;
1160 exception_state_save(&estate);
1161 exception_state_clear();
Yegappan Lakshmanan06725952023-10-18 11:47:37 +02001162
zeertzjqa1f2b5d2023-04-18 21:04:53 +01001163 (void)call_func(name, -1, &rettv, argcount, argvars, &funcexe);
1164
Yegappan Lakshmananc59c1e02023-10-19 10:52:34 +02001165 exception_state_restore(&estate);
Yegappan Lakshmanan06725952023-10-18 11:47:37 +02001166
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001167 clear_tv(&rettv);
zeertzjqa1f2b5d2023-04-18 21:04:53 +01001168 vim_free(name);
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001169 }
1170}
1171
1172/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001173 * Return from the current function.
1174 */
Bram Moolenaarbf67ea12020-05-02 17:52:42 +02001175 static int
Bram Moolenaar4c137212021-04-19 16:48:48 +02001176func_return(ectx_T *ectx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001177{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001178 int idx;
Bram Moolenaar34c54eb2020-11-25 19:15:19 +01001179 int ret_idx;
Bram Moolenaarbf67ea12020-05-02 17:52:42 +02001180 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
1181 + ectx->ec_dfunc_idx;
1182 int argcount = ufunc_argcount(dfunc->df_ufunc);
Bram Moolenaarc620c052020-07-08 15:16:19 +02001183 estack_T *entry;
Bram Moolenaar12d26532021-02-19 19:13:21 +01001184 int prev_dfunc_idx = STACK_TV(ectx->ec_frame_idx
1185 + STACK_FRAME_FUNC_OFF)->vval.v_number;
Bram Moolenaarb06b50d2021-04-26 21:39:25 +02001186 funclocal_T *floc;
1187#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01001188 dfunc_T *prev_dfunc = ((dfunc_T *)def_functions.ga_data)
1189 + prev_dfunc_idx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001190
Bram Moolenaar12d26532021-02-19 19:13:21 +01001191 if (do_profiling == PROF_YES)
1192 {
1193 ufunc_T *caller = prev_dfunc->df_ufunc;
1194
1195 if (dfunc->df_ufunc->uf_profiling
1196 || (caller != NULL && caller->uf_profiling))
1197 {
1198 profile_may_end_func(((profinfo_T *)profile_info_ga.ga_data)
1199 + profile_info_ga.ga_len - 1, dfunc->df_ufunc, caller);
1200 --profile_info_ga.ga_len;
1201 }
1202 }
1203#endif
Bram Moolenaar919c12c2021-12-14 14:29:16 +00001204
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001205 if (dfunc->df_defer_var_idx > 0)
1206 invoke_defer_funcs(ectx);
1207
Bram Moolenaar919c12c2021-12-14 14:29:16 +00001208 // No check for uf_refcount being zero, cannot think of a way that would
1209 // happen.
Bram Moolenaarc970e422021-03-17 15:03:04 +01001210 --dfunc->df_ufunc->uf_calls;
1211
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001212 // execution context goes one level up
Bram Moolenaarc620c052020-07-08 15:16:19 +02001213 entry = estack_pop();
1214 if (entry != NULL)
Bram Moolenaarc70fe462021-04-17 17:59:19 +02001215 current_sctx = entry->es_save_sctx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001216
Bram Moolenaarbf67ea12020-05-02 17:52:42 +02001217 if (handle_closure_in_use(ectx, TRUE) == FAIL)
1218 return FAIL;
1219
Bram Moolenaar574950d2023-01-03 19:08:50 +00001220 // Clear the arguments. If this was an object method also clear the
1221 // object, it is just before the arguments.
1222 int top = ectx->ec_frame_idx - argcount;
Yegappan Lakshmanan1db15142023-09-19 20:34:05 +02001223 if (IS_OBJECT_METHOD(dfunc->df_ufunc))
Bram Moolenaar574950d2023-01-03 19:08:50 +00001224 --top;
Bram Moolenaarbf67ea12020-05-02 17:52:42 +02001225 for (idx = top; idx < ectx->ec_frame_idx; ++idx)
1226 clear_tv(STACK_TV(idx));
1227
1228 // Clear local variables and temp values, but not the return value.
1229 for (idx = ectx->ec_frame_idx + STACK_FRAME_SIZE;
Bram Moolenaar170fcfc2020-02-06 17:51:35 +01001230 idx < ectx->ec_stack.ga_len - 1; ++idx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001231 clear_tv(STACK_TV(idx));
Bram Moolenaar170fcfc2020-02-06 17:51:35 +01001232
Bram Moolenaar34c54eb2020-11-25 19:15:19 +01001233 // The return value should be on top of the stack. However, when aborting
1234 // it may not be there and ec_frame_idx is the top of the stack.
1235 ret_idx = ectx->ec_stack.ga_len - 1;
Bram Moolenaar0186e582021-01-10 18:33:11 +01001236 if (ret_idx == ectx->ec_frame_idx + STACK_FRAME_IDX_OFF)
Bram Moolenaar34c54eb2020-11-25 19:15:19 +01001237 ret_idx = 0;
1238
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02001239 if (ectx->ec_outer_ref != NULL)
1240 {
1241 if (ectx->ec_outer_ref->or_outer_allocated)
1242 vim_free(ectx->ec_outer_ref->or_outer);
1243 partial_unref(ectx->ec_outer_ref->or_partial);
1244 vim_free(ectx->ec_outer_ref);
1245 }
Bram Moolenaar0186e582021-01-10 18:33:11 +01001246
Bram Moolenaar170fcfc2020-02-06 17:51:35 +01001247 // Restore the previous frame.
Bram Moolenaar12d26532021-02-19 19:13:21 +01001248 ectx->ec_dfunc_idx = prev_dfunc_idx;
Bram Moolenaar0186e582021-01-10 18:33:11 +01001249 ectx->ec_iidx = STACK_TV(ectx->ec_frame_idx
1250 + STACK_FRAME_IIDX_OFF)->vval.v_number;
Bram Moolenaar5930ddc2021-04-26 20:32:59 +02001251 ectx->ec_instr = (void *)STACK_TV(ectx->ec_frame_idx
1252 + STACK_FRAME_INSTR_OFF)->vval.v_string;
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02001253 ectx->ec_outer_ref = (void *)STACK_TV(ectx->ec_frame_idx
Bram Moolenaar0186e582021-01-10 18:33:11 +01001254 + STACK_FRAME_OUTER_OFF)->vval.v_string;
Bram Moolenaar2fecb532021-03-24 22:00:56 +01001255 floc = (void *)STACK_TV(ectx->ec_frame_idx
1256 + STACK_FRAME_FUNCLOCAL_OFF)->vval.v_string;
Bram Moolenaar5366e1a2020-10-01 13:01:34 +02001257 // restoring ec_frame_idx must be last
Bram Moolenaar0186e582021-01-10 18:33:11 +01001258 ectx->ec_frame_idx = STACK_TV(ectx->ec_frame_idx
1259 + STACK_FRAME_IDX_OFF)->vval.v_number;
Bram Moolenaard386e922021-04-25 14:48:49 +02001260
Bram Moolenaar2fecb532021-03-24 22:00:56 +01001261 if (floc == NULL)
Bram Moolenaar4c137212021-04-19 16:48:48 +02001262 ectx->ec_funclocal.floc_restore_cmdmod = FALSE;
Bram Moolenaar2fecb532021-03-24 22:00:56 +01001263 else
1264 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02001265 ectx->ec_funclocal = *floc;
Bram Moolenaar2fecb532021-03-24 22:00:56 +01001266 vim_free(floc);
1267 }
1268
Bram Moolenaar34c54eb2020-11-25 19:15:19 +01001269 if (ret_idx > 0)
1270 {
1271 // Reset the stack to the position before the call, with a spot for the
1272 // return value, moved there from above the frame.
1273 ectx->ec_stack.ga_len = top + 1;
1274 *STACK_TV_BOT(-1) = *STACK_TV(ret_idx);
1275 }
1276 else
1277 // Reset the stack to the position before the call.
1278 ectx->ec_stack.ga_len = top;
Bram Moolenaarbf67ea12020-05-02 17:52:42 +02001279
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01001280 funcdepth_decrement();
Bram Moolenaare99d4222021-06-13 14:01:26 +02001281 --ex_nesting_level;
Bram Moolenaarbf67ea12020-05-02 17:52:42 +02001282 return OK;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001283}
1284
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001285/*
1286 * Prepare arguments and rettv for calling a builtin or user function.
1287 */
1288 static int
1289call_prepare(int argcount, typval_T *argvars, ectx_T *ectx)
1290{
1291 int idx;
1292 typval_T *tv;
1293
1294 // Move arguments from bottom of the stack to argvars[] and add terminator.
1295 for (idx = 0; idx < argcount; ++idx)
1296 argvars[idx] = *STACK_TV_BOT(idx - argcount);
1297 argvars[argcount].v_type = VAR_UNKNOWN;
1298
1299 // Result replaces the arguments on the stack.
1300 if (argcount > 0)
1301 ectx->ec_stack.ga_len -= argcount - 1;
Bram Moolenaar35578162021-08-02 19:10:38 +02001302 else if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001303 return FAIL;
1304 else
1305 ++ectx->ec_stack.ga_len;
1306
1307 // Default return value is zero.
1308 tv = STACK_TV_BOT(-1);
1309 tv->v_type = VAR_NUMBER;
1310 tv->vval.v_number = 0;
Bram Moolenaar24565cf2022-03-28 18:16:52 +01001311 tv->v_lock = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001312
1313 return OK;
1314}
1315
1316/*
1317 * Call a builtin function by index.
1318 */
1319 static int
1320call_bfunc(int func_idx, int argcount, ectx_T *ectx)
1321{
1322 typval_T argvars[MAX_FUNC_ARGS];
1323 int idx;
Bram Moolenaar171fb922020-10-28 16:54:47 +01001324 int did_emsg_before = did_emsg;
Bram Moolenaar08f7a412020-07-13 20:41:08 +02001325 ectx_T *prev_ectx = current_ectx;
Bram Moolenaar7a3fe3e2021-07-22 14:58:47 +02001326 char *save_func_name = ectx->ec_where.wt_func_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001327
1328 if (call_prepare(argcount, argvars, ectx) == FAIL)
1329 return FAIL;
Bram Moolenaar7a3fe3e2021-07-22 14:58:47 +02001330 ectx->ec_where.wt_func_name = internal_func_name(func_idx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001331
Bram Moolenaar08f7a412020-07-13 20:41:08 +02001332 // Call the builtin function. Set "current_ectx" so that when it
1333 // recursively invokes call_def_function() a closure context can be set.
1334 current_ectx = ectx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001335 call_internal_func_by_idx(func_idx, argvars, STACK_TV_BOT(-1));
Bram Moolenaar08f7a412020-07-13 20:41:08 +02001336 current_ectx = prev_ectx;
Bram Moolenaar7a3fe3e2021-07-22 14:58:47 +02001337 ectx->ec_where.wt_func_name = save_func_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001338
1339 // Clear the arguments.
1340 for (idx = 0; idx < argcount; ++idx)
1341 clear_tv(&argvars[idx]);
Bram Moolenaar015f4262020-05-05 21:25:22 +02001342
Bram Moolenaar57f799e2020-12-12 20:42:19 +01001343 if (did_emsg > did_emsg_before)
Bram Moolenaar015f4262020-05-05 21:25:22 +02001344 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001345 return OK;
1346}
1347
1348/*
1349 * Execute a user defined function.
Bram Moolenaarab360522021-01-10 14:02:28 +01001350 * If the function is compiled this will add a stack frame and set the
1351 * instruction pointer at the start of the function.
1352 * Otherwise the function is called here.
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02001353 * If "pt" is not null use "pt->pt_outer" for ec_outer_ref->or_outer.
Bram Moolenaar7eeefd42020-02-26 21:24:23 +01001354 * "iptr" can be used to replace the instruction with a more efficient one.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001355 */
1356 static int
Bram Moolenaar0186e582021-01-10 18:33:11 +01001357call_ufunc(
1358 ufunc_T *ufunc,
1359 partial_T *pt,
1360 int argcount,
1361 ectx_T *ectx,
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02001362 isn_T *iptr,
1363 dict_T *selfdict)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001364{
1365 typval_T argvars[MAX_FUNC_ARGS];
1366 funcexe_T funcexe;
Bram Moolenaar0917e862023-02-18 14:42:44 +00001367 funcerror_T error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001368 int idx;
Bram Moolenaar28ee8922020-10-28 20:20:00 +01001369 int did_emsg_before = did_emsg;
Bram Moolenaar139575d2022-03-15 19:29:30 +00001370 compiletype_T compile_type = get_compile_type(ufunc);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001371
Bram Moolenaare99d4222021-06-13 14:01:26 +02001372 if (func_needs_compiling(ufunc, compile_type)
1373 && compile_def_function(ufunc, FALSE, compile_type, NULL)
1374 == FAIL)
Bram Moolenaar822ba242020-05-24 23:00:18 +02001375 return FAIL;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001376 if (ufunc->uf_def_status == UF_COMPILED)
Bram Moolenaar7eeefd42020-02-26 21:24:23 +01001377 {
Bram Moolenaar52c124d2020-12-20 21:43:35 +01001378 error = check_user_func_argcount(ufunc, argcount);
Bram Moolenaar50824712020-12-20 21:10:17 +01001379 if (error != FCERR_UNKNOWN)
1380 {
1381 if (error == FCERR_TOOMANY)
Bram Moolenaara6c18d32022-03-31 20:02:56 +01001382 semsg(_(e_too_many_arguments_for_function_str),
1383 printable_func_name(ufunc));
Bram Moolenaar50824712020-12-20 21:10:17 +01001384 else
Bram Moolenaare1242042021-12-16 20:56:57 +00001385 semsg(_(e_not_enough_arguments_for_function_str),
Bram Moolenaara6c18d32022-03-31 20:02:56 +01001386 printable_func_name(ufunc));
Bram Moolenaar50824712020-12-20 21:10:17 +01001387 return FAIL;
1388 }
1389
Bram Moolenaar7eeefd42020-02-26 21:24:23 +01001390 // The function has been compiled, can call it quickly. For a function
1391 // that was defined later: we can call it directly next time.
1392 if (iptr != NULL)
1393 {
Bram Moolenaar20431c92020-03-20 18:39:46 +01001394 delete_instr(iptr);
Bram Moolenaar7eeefd42020-02-26 21:24:23 +01001395 iptr->isn_type = ISN_DCALL;
1396 iptr->isn_arg.dfunc.cdf_idx = ufunc->uf_dfunc_idx;
1397 iptr->isn_arg.dfunc.cdf_argcount = argcount;
1398 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02001399 return call_dfunc(ufunc->uf_dfunc_idx, pt, argcount, ectx);
Bram Moolenaar7eeefd42020-02-26 21:24:23 +01001400 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001401
1402 if (call_prepare(argcount, argvars, ectx) == FAIL)
1403 return FAIL;
Bram Moolenaara80faa82020-04-12 19:37:17 +02001404 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00001405 funcexe.fe_evaluate = TRUE;
1406 funcexe.fe_selfdict = selfdict != NULL ? selfdict : dict_stack_get_dict();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001407
1408 // Call the user function. Result goes in last position on the stack.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001409 error = call_user_func_check(ufunc, argcount, argvars,
Bram Moolenaar851f86b2021-12-13 14:26:44 +00001410 STACK_TV_BOT(-1), &funcexe, funcexe.fe_selfdict);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001411
1412 // Clear the arguments.
1413 for (idx = 0; idx < argcount; ++idx)
1414 clear_tv(&argvars[idx]);
1415
1416 if (error != FCERR_NONE)
1417 {
Bram Moolenaar87b4e5c2022-10-01 15:32:46 +01001418 user_func_error(error, printable_func_name(ufunc),
1419 funcexe.fe_found_var);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001420 return FAIL;
1421 }
Bram Moolenaar28ee8922020-10-28 20:20:00 +01001422 if (did_emsg > did_emsg_before)
Bram Moolenaared677f52020-08-12 16:38:10 +02001423 // Error other than from calling the function itself.
1424 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001425 return OK;
1426}
1427
1428/*
Bram Moolenaara91a7132021-03-25 21:12:15 +01001429 * If command modifiers were applied restore them.
1430 */
1431 static void
1432may_restore_cmdmod(funclocal_T *funclocal)
1433{
1434 if (funclocal->floc_restore_cmdmod)
1435 {
1436 cmdmod.cmod_filter_regmatch.regprog = NULL;
1437 undo_cmdmod(&cmdmod);
1438 cmdmod = funclocal->floc_save_cmdmod;
1439 funclocal->floc_restore_cmdmod = FALSE;
1440 }
1441}
1442
1443/*
Bram Moolenaar88c89c72021-08-14 14:01:05 +02001444 * Return TRUE if an error was given (not caught in try/catch) or CTRL-C was
1445 * pressed.
Bram Moolenaara1773442020-08-12 15:21:22 +02001446 */
1447 static int
Bram Moolenaar88c89c72021-08-14 14:01:05 +02001448vim9_aborting(int prev_uncaught_emsg)
Bram Moolenaara1773442020-08-12 15:21:22 +02001449{
Bram Moolenaar88c89c72021-08-14 14:01:05 +02001450 return uncaught_emsg > prev_uncaught_emsg || got_int || did_throw;
Bram Moolenaara1773442020-08-12 15:21:22 +02001451}
1452
1453/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001454 * Execute a function by "name".
1455 * This can be a builtin function or a user function.
Bram Moolenaar7eeefd42020-02-26 21:24:23 +01001456 * "iptr" can be used to replace the instruction with a more efficient one.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001457 * Returns FAIL if not found without an error message.
1458 */
1459 static int
Bram Moolenaar2fecb532021-03-24 22:00:56 +01001460call_by_name(
1461 char_u *name,
1462 int argcount,
Bram Moolenaar2fecb532021-03-24 22:00:56 +01001463 ectx_T *ectx,
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02001464 isn_T *iptr,
1465 dict_T *selfdict)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001466{
1467 ufunc_T *ufunc;
1468
1469 if (builtin_function(name, -1))
1470 {
1471 int func_idx = find_internal_func(name);
1472
Bram Moolenaar1983f1a2022-02-28 20:55:02 +00001473 if (func_idx < 0) // Impossible?
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001474 return FAIL;
Bram Moolenaar389df252020-07-09 21:20:47 +02001475 if (check_internal_func(func_idx, argcount) < 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001476 return FAIL;
1477 return call_bfunc(func_idx, argcount, ectx);
1478 }
1479
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00001480 ufunc = find_func(name, FALSE);
Bram Moolenaara1773442020-08-12 15:21:22 +02001481
1482 if (ufunc == NULL)
1483 {
Bram Moolenaar88c89c72021-08-14 14:01:05 +02001484 int prev_uncaught_emsg = uncaught_emsg;
Bram Moolenaara1773442020-08-12 15:21:22 +02001485
1486 if (script_autoload(name, TRUE))
1487 // loaded a package, search for the function again
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00001488 ufunc = find_func(name, FALSE);
Bram Moolenaar88c89c72021-08-14 14:01:05 +02001489
1490 if (vim9_aborting(prev_uncaught_emsg))
Bram Moolenaara1773442020-08-12 15:21:22 +02001491 return FAIL; // bail out if loading the script caused an error
1492 }
1493
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001494 if (ufunc != NULL)
Bram Moolenaar04947cc2021-03-06 19:26:46 +01001495 {
Bram Moolenaar0d89d8a2022-12-31 14:01:24 +00001496 if (check_ufunc_arg_types(ufunc, argcount, 0, ectx) == FAIL)
1497 return FAIL;
Bram Moolenaar04947cc2021-03-06 19:26:46 +01001498
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02001499 return call_ufunc(ufunc, NULL, argcount, ectx, iptr, selfdict);
Bram Moolenaar04947cc2021-03-06 19:26:46 +01001500 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001501
1502 return FAIL;
1503}
1504
1505 static int
Bram Moolenaar2fecb532021-03-24 22:00:56 +01001506call_partial(
1507 typval_T *tv,
1508 int argcount_arg,
Bram Moolenaar2fecb532021-03-24 22:00:56 +01001509 ectx_T *ectx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001510{
Bram Moolenaara90afb92020-07-15 22:38:56 +02001511 int argcount = argcount_arg;
Bram Moolenaarbd5da372020-03-31 23:13:10 +02001512 char_u *name = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001513 int called_emsg_before = called_emsg;
Bram Moolenaarcb6cbf22021-01-12 17:17:01 +01001514 int res = FAIL;
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02001515 dict_T *selfdict = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001516
1517 if (tv->v_type == VAR_PARTIAL)
1518 {
Bram Moolenaara90afb92020-07-15 22:38:56 +02001519 partial_T *pt = tv->vval.v_partial;
1520 int i;
1521
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02001522 if (pt->pt_obj != NULL)
1523 {
1524 // partial with an object method. Push the object before the
1525 // function arguments.
1526 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
1527 return FAIL;
1528 for (i = 1; i <= argcount; ++i)
1529 *STACK_TV_BOT(-i + 1) = *STACK_TV_BOT(-i);
1530
1531 typval_T *obj_tv = STACK_TV_BOT(-argcount);
1532 obj_tv->v_type = VAR_OBJECT;
1533 obj_tv->v_lock = 0;
1534 obj_tv->vval.v_object = pt->pt_obj;
1535 ++pt->pt_obj->obj_refcount;
1536 ++ectx->ec_stack.ga_len;
1537 }
1538
Bram Moolenaara90afb92020-07-15 22:38:56 +02001539 if (pt->pt_argc > 0)
1540 {
1541 // Make space for arguments from the partial, shift the "argcount"
1542 // arguments up.
Bram Moolenaar35578162021-08-02 19:10:38 +02001543 if (GA_GROW_FAILS(&ectx->ec_stack, pt->pt_argc))
Bram Moolenaara90afb92020-07-15 22:38:56 +02001544 return FAIL;
1545 for (i = 1; i <= argcount; ++i)
1546 *STACK_TV_BOT(-i + pt->pt_argc) = *STACK_TV_BOT(-i);
1547 ectx->ec_stack.ga_len += pt->pt_argc;
1548 argcount += pt->pt_argc;
1549
1550 // copy the arguments from the partial onto the stack
1551 for (i = 0; i < pt->pt_argc; ++i)
1552 copy_tv(&pt->pt_argv[i], STACK_TV_BOT(-argcount + i));
1553 }
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02001554 selfdict = pt->pt_dict;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001555
1556 if (pt->pt_func != NULL)
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02001557 return call_ufunc(pt->pt_func, pt, argcount, ectx, NULL, selfdict);
Bram Moolenaarf7779c62020-05-03 15:38:16 +02001558
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001559 name = pt->pt_name;
1560 }
Bram Moolenaarbd5da372020-03-31 23:13:10 +02001561 else if (tv->v_type == VAR_FUNC)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001562 name = tv->vval.v_string;
Bram Moolenaar95006e32020-08-29 17:47:08 +02001563 if (name != NULL)
1564 {
Bram Moolenaar0917e862023-02-18 14:42:44 +00001565 char_u fname_buf[FLEN_FIXED + 1];
1566 char_u *tofree = NULL;
1567 funcerror_T error = FCERR_NONE;
1568 char_u *fname;
Bram Moolenaar95006e32020-08-29 17:47:08 +02001569
1570 // May need to translate <SNR>123_ to K_SNR.
1571 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
1572 if (error != FCERR_NONE)
1573 res = FAIL;
1574 else
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02001575 res = call_by_name(fname, argcount, ectx, NULL, selfdict);
Bram Moolenaar95006e32020-08-29 17:47:08 +02001576 vim_free(tofree);
1577 }
1578
Bram Moolenaarcb6cbf22021-01-12 17:17:01 +01001579 if (res == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001580 {
1581 if (called_emsg == called_emsg_before)
Bram Moolenaara6c18d32022-03-31 20:02:56 +01001582 emsg_funcname(e_unknown_function_str,
Bram Moolenaar015f4262020-05-05 21:25:22 +02001583 name == NULL ? (char_u *)"[unknown]" : name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001584 return FAIL;
1585 }
1586 return OK;
1587}
1588
1589/*
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +02001590 * Check if "lock" is VAR_LOCKED or VAR_FIXED. If so give an error and return
1591 * TRUE.
1592 */
1593 static int
1594error_if_locked(int lock, char *error)
1595{
1596 if (lock & (VAR_LOCKED | VAR_FIXED))
1597 {
1598 emsg(_(error));
1599 return TRUE;
1600 }
1601 return FALSE;
1602}
1603
1604/*
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01001605 * Give an error if "tv" is not a number and return FAIL.
1606 */
1607 static int
1608check_for_number(typval_T *tv)
1609{
1610 if (tv->v_type != VAR_NUMBER)
1611 {
1612 semsg(_(e_expected_str_but_got_str),
1613 vartype_name(VAR_NUMBER), vartype_name(tv->v_type));
1614 return FAIL;
1615 }
1616 return OK;
1617}
1618
1619/*
Bram Moolenaar0bbf7222020-02-19 22:31:48 +01001620 * Store "tv" in variable "name".
1621 * This is for s: and g: variables.
1622 */
1623 static void
1624store_var(char_u *name, typval_T *tv)
1625{
1626 funccal_entry_T entry;
Bram Moolenaard877a572021-04-01 19:42:48 +02001627 int flags = ASSIGN_DECL;
Bram Moolenaar0bbf7222020-02-19 22:31:48 +01001628
Bram Moolenaard877a572021-04-01 19:42:48 +02001629 if (tv->v_lock)
1630 flags |= ASSIGN_CONST;
Bram Moolenaar0bbf7222020-02-19 22:31:48 +01001631 save_funccal(&entry);
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001632 set_var_const(name, 0, NULL, tv, FALSE, flags, 0);
Bram Moolenaar0bbf7222020-02-19 22:31:48 +01001633 restore_funccal();
1634}
1635
Bram Moolenaar3beaf9c2020-12-18 17:23:14 +01001636/*
Bram Moolenaar4f5e3972020-12-21 17:30:50 +01001637 * Convert "tv" to a string.
1638 * Return FAIL if not allowed.
1639 */
1640 static int
Yegappan Lakshmananbce51d92024-04-15 19:19:52 +02001641do_2string(typval_T *tv, int is_2string_any, int tostring_flags)
Bram Moolenaar4f5e3972020-12-21 17:30:50 +01001642{
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00001643 if (tv->v_type == VAR_STRING)
1644 return OK;
1645
1646 char_u *str;
1647
1648 if (is_2string_any)
Bram Moolenaar4f5e3972020-12-21 17:30:50 +01001649 {
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00001650 switch (tv->v_type)
Bram Moolenaar4f5e3972020-12-21 17:30:50 +01001651 {
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00001652 case VAR_SPECIAL:
1653 case VAR_BOOL:
1654 case VAR_NUMBER:
1655 case VAR_FLOAT:
Yegappan Lakshmananf01493c2024-04-14 23:21:02 +02001656 case VAR_DICT:
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00001657 case VAR_BLOB: break;
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02001658
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00001659 case VAR_LIST:
Yegappan Lakshmananbce51d92024-04-15 19:19:52 +02001660 if (tostring_flags & TOSTRING_TOLERANT)
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02001661 {
Bram Moolenaarb288ba92021-06-05 17:10:55 +02001662 char_u *s, *e, *p;
1663 garray_T ga;
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02001664
Bram Moolenaarb288ba92021-06-05 17:10:55 +02001665 ga_init2(&ga, sizeof(char_u *), 1);
1666
1667 // Convert to NL separated items, then
1668 // escape the items and replace the NL with
1669 // a space.
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02001670 str = typval2string(tv, TRUE);
Bram Moolenaarb288ba92021-06-05 17:10:55 +02001671 if (str == NULL)
1672 return FAIL;
1673 s = str;
1674 while ((e = vim_strchr(s, '\n')) != NULL)
1675 {
1676 *e = NUL;
Bram Moolenaar21c1a0c2021-10-17 17:20:23 +01001677 p = vim_strsave_fnameescape(s,
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00001678 VSE_NONE);
Bram Moolenaarb288ba92021-06-05 17:10:55 +02001679 if (p != NULL)
1680 {
1681 ga_concat(&ga, p);
1682 ga_concat(&ga, (char_u *)" ");
1683 vim_free(p);
1684 }
1685 s = e + 1;
1686 }
1687 vim_free(str);
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02001688 clear_tv(tv);
1689 tv->v_type = VAR_STRING;
Bram Moolenaarb288ba92021-06-05 17:10:55 +02001690 tv->vval.v_string = ga.ga_data;
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02001691 return OK;
1692 }
Yegappan Lakshmananbce51d92024-04-15 19:19:52 +02001693 if (tostring_flags & TOSTRING_INTERPOLATE)
1694 break;
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02001695 // FALLTHROUGH
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00001696 default: to_string_error(tv->v_type);
1697 return FAIL;
Bram Moolenaar4f5e3972020-12-21 17:30:50 +01001698 }
Bram Moolenaar4f5e3972020-12-21 17:30:50 +01001699 }
Yegappan Lakshmanan142ed772023-01-26 12:00:00 +00001700 str = typval_tostring(tv, TRUE);
1701 clear_tv(tv);
1702 tv->v_type = VAR_STRING;
1703 tv->vval.v_string = str;
Bram Moolenaar4f5e3972020-12-21 17:30:50 +01001704 return OK;
1705}
1706
1707/*
Bram Moolenaar3beaf9c2020-12-18 17:23:14 +01001708 * When the value of "sv" is a null list of dict, allocate it.
1709 */
1710 static void
Bram Moolenaar859cc212022-03-28 15:22:35 +01001711allocate_if_null(svar_T *sv)
Bram Moolenaar3beaf9c2020-12-18 17:23:14 +01001712{
Bram Moolenaar859cc212022-03-28 15:22:35 +01001713 typval_T *tv = sv->sv_tv;
1714
Bram Moolenaar3beaf9c2020-12-18 17:23:14 +01001715 switch (tv->v_type)
1716 {
1717 case VAR_LIST:
Bram Moolenaar859cc212022-03-28 15:22:35 +01001718 if (tv->vval.v_list == NULL && sv->sv_type != &t_list_empty)
Bram Moolenaarfef80642021-02-03 20:01:19 +01001719 (void)rettv_list_alloc(tv);
Bram Moolenaar3beaf9c2020-12-18 17:23:14 +01001720 break;
1721 case VAR_DICT:
Bram Moolenaar859cc212022-03-28 15:22:35 +01001722 if (tv->vval.v_dict == NULL && sv->sv_type != &t_dict_empty)
Bram Moolenaarfef80642021-02-03 20:01:19 +01001723 (void)rettv_dict_alloc(tv);
Bram Moolenaar3beaf9c2020-12-18 17:23:14 +01001724 break;
Bram Moolenaarb7c21af2021-04-18 14:12:31 +02001725 case VAR_BLOB:
Bram Moolenaar859cc212022-03-28 15:22:35 +01001726 if (tv->vval.v_blob == NULL && sv->sv_type != &t_blob_null)
Bram Moolenaarb7c21af2021-04-18 14:12:31 +02001727 (void)rettv_blob_alloc(tv);
1728 break;
Bram Moolenaar3beaf9c2020-12-18 17:23:14 +01001729 default:
1730 break;
1731 }
1732}
Bram Moolenaard3aac292020-04-19 14:32:17 +02001733
Bram Moolenaare7525c52021-01-09 13:20:37 +01001734/*
Bram Moolenaar0289a092021-03-14 18:40:19 +01001735 * Return the character "str[index]" where "index" is the character index,
1736 * including composing characters.
1737 * If "index" is out of range NULL is returned.
Bram Moolenaare7525c52021-01-09 13:20:37 +01001738 */
1739 char_u *
1740char_from_string(char_u *str, varnumber_T index)
1741{
1742 size_t nbyte = 0;
1743 varnumber_T nchar = index;
1744 size_t slen;
1745
1746 if (str == NULL)
1747 return NULL;
1748 slen = STRLEN(str);
1749
Bram Moolenaarff871402021-03-26 13:34:05 +01001750 // Do the same as for a list: a negative index counts from the end.
1751 // Optimization to check the first byte to be below 0x80 (and no composing
1752 // character follows) makes this a lot faster.
Bram Moolenaare7525c52021-01-09 13:20:37 +01001753 if (index < 0)
1754 {
1755 int clen = 0;
1756
1757 for (nbyte = 0; nbyte < slen; ++clen)
Bram Moolenaarff871402021-03-26 13:34:05 +01001758 {
1759 if (str[nbyte] < 0x80 && str[nbyte + 1] < 0x80)
1760 ++nbyte;
1761 else if (enc_utf8)
1762 nbyte += utfc_ptr2len(str + nbyte);
1763 else
1764 nbyte += mb_ptr2len(str + nbyte);
1765 }
Bram Moolenaare7525c52021-01-09 13:20:37 +01001766 nchar = clen + index;
1767 if (nchar < 0)
1768 // unlike list: index out of range results in empty string
1769 return NULL;
1770 }
1771
1772 for (nbyte = 0; nchar > 0 && nbyte < slen; --nchar)
Bram Moolenaarff871402021-03-26 13:34:05 +01001773 {
1774 if (str[nbyte] < 0x80 && str[nbyte + 1] < 0x80)
1775 ++nbyte;
1776 else if (enc_utf8)
1777 nbyte += utfc_ptr2len(str + nbyte);
1778 else
1779 nbyte += mb_ptr2len(str + nbyte);
1780 }
Bram Moolenaare7525c52021-01-09 13:20:37 +01001781 if (nbyte >= slen)
1782 return NULL;
Bram Moolenaar0289a092021-03-14 18:40:19 +01001783 return vim_strnsave(str + nbyte, mb_ptr2len(str + nbyte));
Bram Moolenaare7525c52021-01-09 13:20:37 +01001784}
1785
1786/*
1787 * Get the byte index for character index "idx" in string "str" with length
Bram Moolenaar0289a092021-03-14 18:40:19 +01001788 * "str_len". Composing characters are included.
Bram Moolenaare7525c52021-01-09 13:20:37 +01001789 * If going over the end return "str_len".
1790 * If "idx" is negative count from the end, -1 is the last character.
1791 * When going over the start return -1.
1792 */
1793 static long
1794char_idx2byte(char_u *str, size_t str_len, varnumber_T idx)
1795{
1796 varnumber_T nchar = idx;
1797 size_t nbyte = 0;
1798
1799 if (nchar >= 0)
1800 {
1801 while (nchar > 0 && nbyte < str_len)
1802 {
Bram Moolenaar0289a092021-03-14 18:40:19 +01001803 nbyte += mb_ptr2len(str + nbyte);
Bram Moolenaare7525c52021-01-09 13:20:37 +01001804 --nchar;
1805 }
1806 }
1807 else
1808 {
1809 nbyte = str_len;
1810 while (nchar < 0 && nbyte > 0)
1811 {
1812 --nbyte;
1813 nbyte -= mb_head_off(str, str + nbyte);
1814 ++nchar;
1815 }
1816 if (nchar < 0)
1817 return -1;
1818 }
1819 return (long)nbyte;
1820}
1821
1822/*
Bram Moolenaar0289a092021-03-14 18:40:19 +01001823 * Return the slice "str[first : last]" using character indexes. Composing
1824 * characters are included.
Bram Moolenaar6601b622021-01-13 21:47:15 +01001825 * "exclusive" is TRUE for slice().
Bram Moolenaare7525c52021-01-09 13:20:37 +01001826 * Return NULL when the result is empty.
1827 */
1828 char_u *
Bram Moolenaar6601b622021-01-13 21:47:15 +01001829string_slice(char_u *str, varnumber_T first, varnumber_T last, int exclusive)
Bram Moolenaare7525c52021-01-09 13:20:37 +01001830{
1831 long start_byte, end_byte;
1832 size_t slen;
1833
1834 if (str == NULL)
1835 return NULL;
1836 slen = STRLEN(str);
1837 start_byte = char_idx2byte(str, slen, first);
1838 if (start_byte < 0)
1839 start_byte = 0; // first index very negative: use zero
Bram Moolenaar6601b622021-01-13 21:47:15 +01001840 if ((last == -1 && !exclusive) || last == VARNUM_MAX)
Bram Moolenaare7525c52021-01-09 13:20:37 +01001841 end_byte = (long)slen;
1842 else
1843 {
1844 end_byte = char_idx2byte(str, slen, last);
Bram Moolenaar6601b622021-01-13 21:47:15 +01001845 if (!exclusive && end_byte >= 0 && end_byte < (long)slen)
Bram Moolenaare7525c52021-01-09 13:20:37 +01001846 // end index is inclusive
Bram Moolenaar0289a092021-03-14 18:40:19 +01001847 end_byte += mb_ptr2len(str + end_byte);
Bram Moolenaare7525c52021-01-09 13:20:37 +01001848 }
1849
1850 if (start_byte >= (long)slen || end_byte <= start_byte)
1851 return NULL;
1852 return vim_strnsave(str + start_byte, end_byte - start_byte);
1853}
1854
Bram Moolenaar6db660b2021-08-01 14:08:54 +02001855/*
1856 * Get a script variable for ISN_STORESCRIPT and ISN_LOADSCRIPT.
1857 * When "dfunc_idx" is negative don't give an error.
1858 * Returns NULL for an error.
1859 */
Bram Moolenaar07a65d22020-12-26 20:09:15 +01001860 static svar_T *
Bram Moolenaar6db660b2021-08-01 14:08:54 +02001861get_script_svar(scriptref_T *sref, int dfunc_idx)
Bram Moolenaar07a65d22020-12-26 20:09:15 +01001862{
1863 scriptitem_T *si = SCRIPT_ITEM(sref->sref_sid);
Bram Moolenaar6db660b2021-08-01 14:08:54 +02001864 dfunc_T *dfunc = dfunc_idx < 0 ? NULL
1865 : ((dfunc_T *)def_functions.ga_data) + dfunc_idx;
Bram Moolenaar07a65d22020-12-26 20:09:15 +01001866 svar_T *sv;
1867
1868 if (sref->sref_seq != si->sn_script_seq)
1869 {
Bram Moolenaar6db660b2021-08-01 14:08:54 +02001870 // The script was reloaded after the function was compiled, the
1871 // script_idx may not be valid.
1872 if (dfunc != NULL)
1873 semsg(_(e_script_variable_invalid_after_reload_in_function_str),
1874 printable_func_name(dfunc->df_ufunc));
Bram Moolenaar07a65d22020-12-26 20:09:15 +01001875 return NULL;
1876 }
1877 sv = ((svar_T *)si->sn_var_vals.ga_data) + sref->sref_idx;
Bram Moolenaar6de22962022-09-09 21:35:36 +01001878 if (sv->sv_name == NULL)
1879 {
1880 if (dfunc != NULL)
1881 emsg(_(e_script_variable_was_deleted));
1882 return NULL;
1883 }
Bram Moolenaar60dc8272021-07-29 22:48:54 +02001884 if (!equal_type(sv->sv_type, sref->sref_type, 0))
Bram Moolenaar07a65d22020-12-26 20:09:15 +01001885 {
Bram Moolenaar6db660b2021-08-01 14:08:54 +02001886 if (dfunc != NULL)
1887 emsg(_(e_script_variable_type_changed));
Bram Moolenaar07a65d22020-12-26 20:09:15 +01001888 return NULL;
1889 }
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001890
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01001891 if ((sv->sv_flags & SVFLAG_EXPORTED) == 0
1892 && sref->sref_sid != current_sctx.sc_sid)
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001893 {
1894 if (dfunc != NULL)
1895 semsg(_(e_item_not_exported_in_script_str), sv->sv_name);
1896 return NULL;
1897 }
Bram Moolenaar07a65d22020-12-26 20:09:15 +01001898 return sv;
1899}
1900
Bram Moolenaar0bbf7222020-02-19 22:31:48 +01001901/*
Bram Moolenaar20677332021-06-06 17:02:53 +02001902 * Function passed to do_cmdline() for splitting a script joined by NL
1903 * characters.
1904 */
1905 static char_u *
1906get_split_sourceline(
1907 int c UNUSED,
1908 void *cookie,
1909 int indent UNUSED,
1910 getline_opt_T options UNUSED)
1911{
1912 source_cookie_T *sp = (source_cookie_T *)cookie;
1913 char_u *p;
1914 char_u *line;
1915
Bram Moolenaar20677332021-06-06 17:02:53 +02001916 p = vim_strchr(sp->nextline, '\n');
1917 if (p == NULL)
1918 {
1919 line = vim_strsave(sp->nextline);
1920 sp->nextline += STRLEN(sp->nextline);
1921 }
1922 else
1923 {
1924 line = vim_strnsave(sp->nextline, p - sp->nextline);
1925 sp->nextline = p + 1;
1926 }
1927 return line;
1928}
1929
1930/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001931 * Execute a function by "name".
1932 * This can be a builtin function, user function or a funcref.
Bram Moolenaar7eeefd42020-02-26 21:24:23 +01001933 * "iptr" can be used to replace the instruction with a more efficient one.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001934 */
1935 static int
Bram Moolenaar2fecb532021-03-24 22:00:56 +01001936call_eval_func(
1937 char_u *name,
1938 int argcount,
Bram Moolenaar2fecb532021-03-24 22:00:56 +01001939 ectx_T *ectx,
1940 isn_T *iptr)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001941{
Bram Moolenaared677f52020-08-12 16:38:10 +02001942 int called_emsg_before = called_emsg;
1943 int res;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001944
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02001945 res = call_by_name(name, argcount, ectx, iptr, NULL);
Bram Moolenaared677f52020-08-12 16:38:10 +02001946 if (res == FAIL && called_emsg == called_emsg_before)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001947 {
Bram Moolenaar1df8b3f2020-04-23 18:13:23 +02001948 dictitem_T *v;
1949
1950 v = find_var(name, NULL, FALSE);
Bram Moolenaara6c18d32022-03-31 20:02:56 +01001951 if (v == NULL || (v->di_tv.v_type != VAR_PARTIAL
1952 && v->di_tv.v_type != VAR_FUNC))
Bram Moolenaar1df8b3f2020-04-23 18:13:23 +02001953 {
Bram Moolenaara6c18d32022-03-31 20:02:56 +01001954 emsg_funcname(e_unknown_function_str, name);
Bram Moolenaar1df8b3f2020-04-23 18:13:23 +02001955 return FAIL;
1956 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02001957 return call_partial(&v->di_tv, argcount, ectx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001958 }
Bram Moolenaared677f52020-08-12 16:38:10 +02001959 return res;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001960}
1961
1962/*
Bram Moolenaarf112f302020-12-20 17:47:52 +01001963 * When a function reference is used, fill a partial with the information
1964 * needed, especially when it is used as a closure.
1965 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01001966 int
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01001967fill_partial_and_closure(
Bram Moolenaarcc341812022-09-19 15:54:34 +01001968 partial_T *pt,
1969 ufunc_T *ufunc,
1970 loopvarinfo_T *lvi,
1971 ectx_T *ectx)
Bram Moolenaarf112f302020-12-20 17:47:52 +01001972{
1973 pt->pt_func = ufunc;
1974 pt->pt_refcount = 1;
1975
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01001976 if (ufunc->uf_flags & FC_CLOSURE)
Bram Moolenaarf112f302020-12-20 17:47:52 +01001977 {
1978 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
1979 + ectx->ec_dfunc_idx;
1980
Bram Moolenaarb46c0832022-09-15 17:19:37 +01001981 // The closure may need to find arguments and local variables of the
1982 // current function in the stack.
Bram Moolenaar0186e582021-01-10 18:33:11 +01001983 pt->pt_outer.out_stack = &ectx->ec_stack;
1984 pt->pt_outer.out_frame_idx = ectx->ec_frame_idx;
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02001985 if (ectx->ec_outer_ref != NULL)
1986 {
1987 // The current context already has a context, link to that one.
1988 pt->pt_outer.out_up = ectx->ec_outer_ref->or_outer;
1989 if (ectx->ec_outer_ref->or_partial != NULL)
1990 {
1991 pt->pt_outer.out_up_partial = ectx->ec_outer_ref->or_partial;
1992 ++pt->pt_outer.out_up_partial->pt_refcount;
1993 }
1994 }
Bram Moolenaarf112f302020-12-20 17:47:52 +01001995
Bram Moolenaarcc341812022-09-19 15:54:34 +01001996 if (lvi != NULL)
1997 {
1998 int depth;
1999
2000 // The closure may need to find variables defined inside a loop,
2001 // for every nested loop. A new reference is made every time,
2002 // ISN_ENDLOOP will check if they are actually used.
2003 for (depth = 0; depth < lvi->lvi_depth; ++depth)
2004 {
2005 pt->pt_outer.out_loop[depth].stack = &ectx->ec_stack;
2006 pt->pt_outer.out_loop[depth].var_idx = ectx->ec_frame_idx
2007 + STACK_FRAME_SIZE + lvi->lvi_loop[depth].var_idx;
2008 pt->pt_outer.out_loop[depth].var_count =
2009 lvi->lvi_loop[depth].var_count;
2010 }
Bram Moolenaar6d313be2022-09-22 16:36:25 +01002011 pt->pt_outer.out_loop_size = lvi->lvi_depth;
Bram Moolenaarcc341812022-09-19 15:54:34 +01002012 }
Bram Moolenaar6d313be2022-09-22 16:36:25 +01002013 else
2014 pt->pt_outer.out_loop_size = 0;
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01002015
Bram Moolenaarb46c0832022-09-15 17:19:37 +01002016 // If the function currently executing returns and the closure is still
2017 // being referenced, we need to make a copy of the context (arguments
2018 // and local variables) so that the closure can use it later.
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02002019 // Store a reference to the partial so we can handle that.
Bram Moolenaar35578162021-08-02 19:10:38 +02002020 if (GA_GROW_FAILS(&ectx->ec_funcrefs, 1))
Bram Moolenaarf112f302020-12-20 17:47:52 +01002021 {
2022 vim_free(pt);
2023 return FAIL;
2024 }
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02002025 // Extra variable keeps the count of closures created in the current
2026 // function call.
Bram Moolenaarf112f302020-12-20 17:47:52 +01002027 ++(((typval_T *)ectx->ec_stack.ga_data) + ectx->ec_frame_idx
2028 + STACK_FRAME_SIZE + dfunc->df_varcount)->vval.v_number;
2029
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01002030 ((partial_T **)ectx->ec_funcrefs.ga_data)[ectx->ec_funcrefs.ga_len]
2031 = pt;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002032 ++pt->pt_refcount;
2033 ++ectx->ec_funcrefs.ga_len;
2034 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002035 ++ufunc->uf_refcount;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002036 return OK;
2037}
2038
Bram Moolenaaraacc9662021-08-13 19:40:51 +02002039/*
2040 * Execute iptr->isn_arg.string as an Ex command.
2041 */
2042 static int
Ernie Raelee865f32023-09-29 19:53:55 +02002043exec_command(isn_T *iptr, char_u *cmd_string)
Bram Moolenaaraacc9662021-08-13 19:40:51 +02002044{
2045 source_cookie_T cookie;
2046
2047 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaarc4e1b862023-02-26 18:58:23 +00002048 // Pass getsourceline to get an error for a missing ":end" command.
Bram Moolenaaraacc9662021-08-13 19:40:51 +02002049 CLEAR_FIELD(cookie);
2050 cookie.sourcing_lnum = iptr->isn_lnum - 1;
Ernie Raelee865f32023-09-29 19:53:55 +02002051 if (do_cmdline(cmd_string, getsourceline, &cookie,
Bram Moolenaaraacc9662021-08-13 19:40:51 +02002052 DOCMD_VERBOSE|DOCMD_NOWAIT|DOCMD_KEYTYPED) == FAIL
2053 || did_emsg)
2054 return FAIL;
2055 return OK;
2056}
2057
Bram Moolenaar89445512022-04-14 12:58:23 +01002058/*
2059 * If script "sid" is not loaded yet then load it now.
2060 * Caller must make sure "sid" is a valid script ID.
2061 * "loaded" is set to TRUE if the script had to be loaded.
2062 * Returns FAIL if loading fails, OK if already loaded or loaded now.
2063 */
2064 int
2065may_load_script(int sid, int *loaded)
2066{
2067 scriptitem_T *si = SCRIPT_ITEM(sid);
2068
2069 if (si->sn_state == SN_STATE_NOT_LOADED)
2070 {
2071 *loaded = TRUE;
2072 if (do_source(si->sn_name, FALSE, DOSO_NONE, NULL) == FAIL)
2073 {
2074 semsg(_(e_cant_open_file_str), si->sn_name);
2075 return FAIL;
2076 }
2077 }
2078 return OK;
2079}
2080
Bram Moolenaarf18332f2021-05-07 17:55:55 +02002081// used for v_instr of typval of VAR_INSTR
2082struct instr_S {
2083 ectx_T *instr_ectx;
2084 isn_T *instr_instr;
2085};
2086
Bram Moolenaar4c137212021-04-19 16:48:48 +02002087// used for substitute_instr
2088typedef struct subs_expr_S {
2089 ectx_T *subs_ectx;
2090 isn_T *subs_instr;
2091 int subs_status;
2092} subs_expr_T;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002093
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02002094// Set when calling do_debug().
2095static ectx_T *debug_context = NULL;
Bram Moolenaar6bc30b02021-06-16 19:19:55 +02002096static int debug_var_count;
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02002097
2098/*
2099 * When debugging lookup "name" and return the typeval.
2100 * When not found return NULL.
2101 */
2102 typval_T *
2103lookup_debug_var(char_u *name)
2104{
2105 int idx;
2106 dfunc_T *dfunc;
Bram Moolenaar6bc30b02021-06-16 19:19:55 +02002107 ufunc_T *ufunc;
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02002108 ectx_T *ectx = debug_context;
Bram Moolenaar6bc30b02021-06-16 19:19:55 +02002109 int varargs_off;
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02002110
2111 if (ectx == NULL)
2112 return NULL;
2113 dfunc = ((dfunc_T *)def_functions.ga_data) + ectx->ec_dfunc_idx;
2114
2115 // Go through the local variable names, from last to first.
Bram Moolenaar6bc30b02021-06-16 19:19:55 +02002116 for (idx = debug_var_count - 1; idx >= 0; --idx)
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02002117 {
Bram Moolenaare406ff82022-03-10 20:47:43 +00002118 char_u *varname = ((char_u **)dfunc->df_var_names.ga_data)[idx];
2119
2120 // the variable name may be NULL when not available in this block
2121 if (varname != NULL && STRCMP(varname, name) == 0)
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02002122 return STACK_TV_VAR(idx);
2123 }
2124
Bram Moolenaar6bc30b02021-06-16 19:19:55 +02002125 // Go through argument names.
2126 ufunc = dfunc->df_ufunc;
2127 varargs_off = ufunc->uf_va_name == NULL ? 0 : 1;
2128 for (idx = 0; idx < ufunc->uf_args.ga_len; ++idx)
2129 if (STRCMP(((char_u **)(ufunc->uf_args.ga_data))[idx], name) == 0)
2130 return STACK_TV(ectx->ec_frame_idx - ufunc->uf_args.ga_len
2131 - varargs_off + idx);
2132 if (ufunc->uf_va_name != NULL && STRCMP(ufunc->uf_va_name, name) == 0)
2133 return STACK_TV(ectx->ec_frame_idx - 1);
2134
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02002135 return NULL;
2136}
2137
Bram Moolenaar26a44842021-09-02 18:49:06 +02002138/*
2139 * Return TRUE if there might be a breakpoint in "ufunc", which is when a
2140 * breakpoint was set in that function or when there is any expression.
2141 */
2142 int
2143may_break_in_function(ufunc_T *ufunc)
2144{
2145 return ufunc->uf_has_breakpoint || debug_has_expr_breakpoint();
2146}
2147
Bram Moolenaar4cea5362021-06-16 22:24:40 +02002148 static void
2149handle_debug(isn_T *iptr, ectx_T *ectx)
2150{
2151 char_u *line;
2152 ufunc_T *ufunc = (((dfunc_T *)def_functions.ga_data)
2153 + ectx->ec_dfunc_idx)->df_ufunc;
2154 isn_T *ni;
2155 int end_lnum = iptr->isn_lnum;
2156 garray_T ga;
2157 int lnum;
2158
Bram Moolenaar4f8f5422021-06-20 19:28:14 +02002159 if (ex_nesting_level > debug_break_level)
2160 {
2161 linenr_T breakpoint;
2162
Bram Moolenaar26a44842021-09-02 18:49:06 +02002163 if (!may_break_in_function(ufunc))
Bram Moolenaar4f8f5422021-06-20 19:28:14 +02002164 return;
2165
2166 // check for the next breakpoint if needed
2167 breakpoint = dbg_find_breakpoint(FALSE, ufunc->uf_name,
Bram Moolenaar8cec9272021-06-23 20:20:53 +02002168 iptr->isn_arg.debug.dbg_break_lnum);
Bram Moolenaar4f8f5422021-06-20 19:28:14 +02002169 if (breakpoint <= 0 || breakpoint > iptr->isn_lnum)
2170 return;
2171 }
2172
Bram Moolenaar4cea5362021-06-16 22:24:40 +02002173 SOURCING_LNUM = iptr->isn_lnum;
2174 debug_context = ectx;
Bram Moolenaar8cec9272021-06-23 20:20:53 +02002175 debug_var_count = iptr->isn_arg.debug.dbg_var_names_len;
Bram Moolenaar4cea5362021-06-16 22:24:40 +02002176
2177 for (ni = iptr + 1; ni->isn_type != ISN_FINISH; ++ni)
2178 if (ni->isn_type == ISN_DEBUG
2179 || ni->isn_type == ISN_RETURN
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002180 || ni->isn_type == ISN_RETURN_OBJECT
Bram Moolenaar4cea5362021-06-16 22:24:40 +02002181 || ni->isn_type == ISN_RETURN_VOID)
2182 {
Bram Moolenaar112bed02021-11-23 22:16:34 +00002183 end_lnum = ni->isn_lnum + (ni->isn_type == ISN_DEBUG ? 0 : 1);
Bram Moolenaar4cea5362021-06-16 22:24:40 +02002184 break;
2185 }
2186
2187 if (end_lnum > iptr->isn_lnum)
2188 {
2189 ga_init2(&ga, sizeof(char_u *), 10);
Bram Moolenaar310091d2021-12-23 21:14:37 +00002190 for (lnum = iptr->isn_lnum; lnum < end_lnum
2191 && lnum <= ufunc->uf_lines.ga_len; ++lnum)
Bram Moolenaar59b50c32021-06-17 22:27:48 +02002192 {
Bram Moolenaar303215d2021-07-07 20:10:43 +02002193 char_u *p = ((char_u **)ufunc->uf_lines.ga_data)[lnum - 1];
Bram Moolenaar59b50c32021-06-17 22:27:48 +02002194
Bram Moolenaar303215d2021-07-07 20:10:43 +02002195 if (p == NULL)
2196 continue; // left over from continuation line
2197 p = skipwhite(p);
Bram Moolenaar59b50c32021-06-17 22:27:48 +02002198 if (*p == '#')
2199 break;
Bram Moolenaar35578162021-08-02 19:10:38 +02002200 if (GA_GROW_OK(&ga, 1))
Bram Moolenaar59b50c32021-06-17 22:27:48 +02002201 ((char_u **)(ga.ga_data))[ga.ga_len++] = p;
2202 if (STRNCMP(p, "def ", 4) == 0)
2203 break;
2204 }
Bram Moolenaar4cea5362021-06-16 22:24:40 +02002205 line = ga_concat_strings(&ga, " ");
2206 vim_free(ga.ga_data);
2207 }
2208 else
2209 line = ((char_u **)ufunc->uf_lines.ga_data)[iptr->isn_lnum - 1];
Bram Moolenaar4cea5362021-06-16 22:24:40 +02002210
Dominique Pelle6e969552021-06-17 13:53:41 +02002211 do_debug(line == NULL ? (char_u *)"[empty]" : line);
Bram Moolenaar4cea5362021-06-16 22:24:40 +02002212 debug_context = NULL;
2213
2214 if (end_lnum > iptr->isn_lnum)
2215 vim_free(line);
2216}
2217
Bram Moolenaar4c137212021-04-19 16:48:48 +02002218/*
Bram Moolenaar65b0d162022-12-13 18:43:22 +00002219 * Store a value in a list, dict, blob or object variable.
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002220 * Returns OK, FAIL or NOTDONE (uncatchable error).
2221 */
2222 static int
2223execute_storeindex(isn_T *iptr, ectx_T *ectx)
2224{
Bram Moolenaarf7d1c6e2023-01-16 20:47:57 +00002225 vartype_T dest_type = iptr->isn_arg.storeindex.si_vartype;
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002226 typval_T *tv;
2227 typval_T *tv_idx = STACK_TV_BOT(-2);
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002228 long lidx = 0;
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002229 typval_T *tv_dest = STACK_TV_BOT(-1);
2230 int status = OK;
2231
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002232 if (tv_idx->v_type == VAR_NUMBER)
2233 lidx = (long)tv_idx->vval.v_number;
2234
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002235 // Stack contains:
2236 // -3 value to be stored
2237 // -2 index
Yegappan Lakshmanan3775f772023-09-01 22:05:45 +02002238 // -1 dict, list, blob, object or class
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002239 tv = STACK_TV_BOT(-3);
2240 SOURCING_LNUM = iptr->isn_lnum;
Gianmaria Bajod7085a02023-08-31 18:15:26 +02002241
2242 // Make sure an object has been initialized
2243 if (dest_type == VAR_OBJECT && tv_dest->vval.v_object == NULL)
2244 {
2245 emsg(_(e_using_null_object));
2246 status = FAIL;
2247 }
2248 else if (dest_type == VAR_ANY)
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002249 {
2250 dest_type = tv_dest->v_type;
2251 if (dest_type == VAR_DICT)
2252 status = do_2string(tv_idx, TRUE, FALSE);
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002253 else if (dest_type == VAR_OBJECT && tv_idx->v_type == VAR_STRING)
2254 {
2255 // Need to get the member index now that the class is known.
2256 object_T *obj = tv_dest->vval.v_object;
Ernie Raelbe828252024-07-26 18:37:02 +02002257 if (obj == NULL)
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002258 {
Ernie Raelbe828252024-07-26 18:37:02 +02002259 emsg(_(e_using_null_object));
2260 status = FAIL;
Yegappan Lakshmananf36bbcd2023-09-10 18:19:06 +02002261 }
2262 else
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002263 {
Ernie Raelbe828252024-07-26 18:37:02 +02002264 class_T *cl = obj->obj_class;
2265 char_u *member = tv_idx->vval.v_string;
2266
2267 int m_idx;
2268 ocmember_T *m = object_member_lookup(cl, member, 0, &m_idx);
2269 if (m != NULL)
2270 {
Yegappan Lakshmanan56d45f12024-11-11 19:58:55 +01002271 // Get the current function
2272 ufunc_T *ufunc = (((dfunc_T *)def_functions.ga_data)
2273 + ectx->ec_dfunc_idx)->df_ufunc;
Yegappan Lakshmanane7984462024-11-12 21:03:00 +01002274 where_T where = WHERE_INIT;
Yegappan Lakshmanan56d45f12024-11-11 19:58:55 +01002275
2276 // Check whether the member variable is writeable
2277 if ((m->ocm_access != VIM_ACCESS_ALL) &&
2278 (ufunc->uf_class == NULL ||
2279 !class_instance_of(ufunc->uf_class, cl)))
Ernie Raelbe828252024-07-26 18:37:02 +02002280 {
Yegappan Lakshmanan56d45f12024-11-11 19:58:55 +01002281 char *msg = (m->ocm_access == VIM_ACCESS_PRIVATE)
2282 ? e_cannot_access_protected_variable_str
2283 : e_variable_is_not_writable_str;
2284 emsg_var_cl_define(msg, m->ocm_name, 0, cl);
Ernie Raelbe828252024-07-26 18:37:02 +02002285 status = FAIL;
2286 }
Yegappan Lakshmanane7984462024-11-12 21:03:00 +01002287 // Fail if the variable is a const or final or the type
2288 // is not compatible
2289 else if (oc_var_check_ro(cl, m) ||
2290 check_typval_type(m->ocm_type, tv, where)
2291 == FAIL)
2292 status = FAIL;
Yegappan Lakshmanan56d45f12024-11-11 19:58:55 +01002293 else
2294 lidx = m_idx;
Ernie Raelbe828252024-07-26 18:37:02 +02002295 }
2296 else
2297 {
2298 member_not_found_msg(cl, VAR_OBJECT, member, 0);
2299 status = FAIL;
2300 }
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002301 }
2302 }
2303 else if ((dest_type == VAR_LIST || dest_type == VAR_OBJECT)
2304 && tv_idx->v_type != VAR_NUMBER)
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002305 {
2306 emsg(_(e_number_expected));
2307 status = FAIL;
2308 }
2309 }
Bram Moolenaare08be092022-02-17 13:08:26 +00002310
2311 if (status == OK)
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002312 {
Bram Moolenaare08be092022-02-17 13:08:26 +00002313 if (dest_type == VAR_LIST)
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002314 {
Bram Moolenaare08be092022-02-17 13:08:26 +00002315 list_T *list = tv_dest->vval.v_list;
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002316
Bram Moolenaare08be092022-02-17 13:08:26 +00002317 if (list == NULL)
2318 {
2319 emsg(_(e_list_not_set));
2320 return FAIL;
2321 }
2322 if (lidx < 0 && list->lv_len + lidx >= 0)
2323 // negative index is relative to the end
2324 lidx = list->lv_len + lidx;
2325 if (lidx < 0 || lidx > list->lv_len)
2326 {
2327 semsg(_(e_list_index_out_of_range_nr), lidx);
2328 return FAIL;
2329 }
2330 if (lidx < list->lv_len)
2331 {
2332 listitem_T *li = list_find(list, lidx);
2333
2334 if (error_if_locked(li->li_tv.v_lock,
Bram Moolenaar70c43d82022-01-26 21:01:15 +00002335 e_cannot_change_locked_list_item))
Bram Moolenaare08be092022-02-17 13:08:26 +00002336 return FAIL;
2337 // overwrite existing list item
2338 clear_tv(&li->li_tv);
2339 li->li_tv = *tv;
2340 }
2341 else
2342 {
2343 if (error_if_locked(list->lv_lock, e_cannot_change_locked_list))
2344 return FAIL;
2345 // append to list, only fails when out of memory
2346 if (list_append_tv(list, tv) == FAIL)
2347 return NOTDONE;
2348 clear_tv(tv);
2349 }
2350 }
2351 else if (dest_type == VAR_DICT)
2352 {
2353 char_u *key = tv_idx->vval.v_string;
2354 dict_T *dict = tv_dest->vval.v_dict;
2355 dictitem_T *di;
2356
2357 SOURCING_LNUM = iptr->isn_lnum;
2358 if (dict == NULL)
2359 {
2360 emsg(_(e_dictionary_not_set));
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002361 return FAIL;
Bram Moolenaare08be092022-02-17 13:08:26 +00002362 }
2363 if (key == NULL)
2364 key = (char_u *)"";
2365 di = dict_find(dict, key, -1);
2366 if (di != NULL)
2367 {
2368 if (error_if_locked(di->di_tv.v_lock,
2369 e_cannot_change_dict_item))
2370 return FAIL;
2371 // overwrite existing value
2372 clear_tv(&di->di_tv);
2373 di->di_tv = *tv;
2374 }
2375 else
2376 {
2377 if (error_if_locked(dict->dv_lock, e_cannot_change_dict))
2378 return FAIL;
2379 // add to dict, only fails when out of memory
2380 if (dict_add_tv(dict, (char *)key, tv) == FAIL)
2381 return NOTDONE;
2382 clear_tv(tv);
2383 }
2384 }
2385 else if (dest_type == VAR_BLOB)
2386 {
Bram Moolenaare08be092022-02-17 13:08:26 +00002387 blob_T *blob = tv_dest->vval.v_blob;
Bram Moolenaar65b0d162022-12-13 18:43:22 +00002388 varnumber_T nr;
2389 int error = FALSE;
2390 int len;
Bram Moolenaare08be092022-02-17 13:08:26 +00002391
2392 if (blob == NULL)
2393 {
2394 emsg(_(e_blob_not_set));
2395 return FAIL;
2396 }
2397 len = blob_len(blob);
2398 if (lidx < 0 && len + lidx >= 0)
2399 // negative index is relative to the end
2400 lidx = len + lidx;
2401
2402 // Can add one byte at the end.
2403 if (lidx < 0 || lidx > len)
2404 {
2405 semsg(_(e_blob_index_out_of_range_nr), lidx);
2406 return FAIL;
2407 }
2408 if (value_check_lock(blob->bv_lock, (char_u *)"blob", FALSE))
2409 return FAIL;
2410 nr = tv_get_number_chk(tv, &error);
2411 if (error)
2412 return FAIL;
2413 blob_set_append(blob, lidx, nr);
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002414 }
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002415 else if (dest_type == VAR_CLASS || dest_type == VAR_OBJECT)
2416 {
Yegappan Lakshmanan3775f772023-09-01 22:05:45 +02002417 typval_T *otv;
Bram Moolenaarf7d1c6e2023-01-16 20:47:57 +00002418
Yegappan Lakshmanan3775f772023-09-01 22:05:45 +02002419 if (dest_type == VAR_OBJECT)
2420 {
2421 object_T *obj = tv_dest->vval.v_object;
2422
2423 otv = (typval_T *)(obj + 1);
2424 class_T *itf = iptr->isn_arg.storeindex.si_class;
2425 if (itf != NULL)
2426 // convert interface member index to class member index
Ernie Rael18143d32023-09-04 22:30:41 +02002427 lidx = object_index_from_itf_index(itf, FALSE, lidx,
Yegappan Lakshmanan5a05d372023-09-29 19:43:11 +02002428 obj->obj_class);
Yegappan Lakshmanan3775f772023-09-01 22:05:45 +02002429 }
2430 else
2431 {
2432 // VAR_CLASS
2433 class_T *class = tv_dest->vval.v_class;
2434 otv = class->class_members_tv;
2435 }
Bram Moolenaarf7d1c6e2023-01-16 20:47:57 +00002436
Bram Moolenaar2c1c8032023-02-18 18:38:37 +00002437 clear_tv(&otv[lidx]);
2438 otv[lidx] = *tv;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00002439 }
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002440 else
2441 {
Bram Moolenaare08be092022-02-17 13:08:26 +00002442 status = FAIL;
2443 semsg(_(e_cannot_index_str), vartype_name(dest_type));
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002444 }
2445 }
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002446
2447 clear_tv(tv_idx);
2448 clear_tv(tv_dest);
2449 ectx->ec_stack.ga_len -= 3;
2450 if (status == FAIL)
2451 {
2452 clear_tv(tv);
2453 return FAIL;
2454 }
2455 return OK;
2456}
2457
2458/*
Bram Moolenaarea5c8982022-02-17 14:42:02 +00002459 * Store a value in a list or blob range.
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002460 */
2461 static int
2462execute_storerange(isn_T *iptr, ectx_T *ectx)
2463{
2464 typval_T *tv;
2465 typval_T *tv_idx1 = STACK_TV_BOT(-3);
2466 typval_T *tv_idx2 = STACK_TV_BOT(-2);
2467 typval_T *tv_dest = STACK_TV_BOT(-1);
2468 int status = OK;
2469
2470 // Stack contains:
2471 // -4 value to be stored
2472 // -3 first index or "none"
2473 // -2 second index or "none"
2474 // -1 destination list or blob
2475 tv = STACK_TV_BOT(-4);
Bram Moolenaarea5c8982022-02-17 14:42:02 +00002476 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002477 if (tv_dest->v_type == VAR_LIST)
2478 {
Bram Moolenaar2995e5c2022-03-18 21:41:47 +00002479 long n1;
2480 long n2;
2481 listitem_T *li1;
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002482
Bram Moolenaar2995e5c2022-03-18 21:41:47 +00002483 n1 = (long)tv_get_number_chk(tv_idx1, NULL);
2484 if (tv_idx2->v_type == VAR_SPECIAL
2485 && tv_idx2->vval.v_number == VVAL_NONE)
2486 n2 = list_len(tv_dest->vval.v_list) - 1;
2487 else
2488 n2 = (long)tv_get_number_chk(tv_idx2, NULL);
2489
Bram Moolenaar22ebd172022-04-01 15:26:58 +01002490 li1 = check_range_index_one(tv_dest->vval.v_list, &n1, TRUE, FALSE);
Bram Moolenaar2995e5c2022-03-18 21:41:47 +00002491 if (li1 == NULL)
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002492 status = FAIL;
2493 else
2494 {
Bram Moolenaar2995e5c2022-03-18 21:41:47 +00002495 status = check_range_index_two(tv_dest->vval.v_list,
2496 &n1, li1, &n2, FALSE);
2497 if (status != FAIL)
2498 status = list_assign_range(
2499 tv_dest->vval.v_list,
2500 tv->vval.v_list,
2501 n1,
2502 n2,
2503 tv_idx2->v_type == VAR_SPECIAL,
2504 (char_u *)"=",
2505 (char_u *)"[unknown]");
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002506 }
2507 }
2508 else if (tv_dest->v_type == VAR_BLOB)
2509 {
2510 varnumber_T n1;
2511 varnumber_T n2;
Bram Moolenaar2995e5c2022-03-18 21:41:47 +00002512 long bloblen;
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002513
Bram Moolenaar2995e5c2022-03-18 21:41:47 +00002514 n1 = tv_get_number_chk(tv_idx1, NULL);
2515 if (tv_idx2->v_type == VAR_SPECIAL
2516 && tv_idx2->vval.v_number == VVAL_NONE)
2517 n2 = blob_len(tv_dest->vval.v_blob) - 1;
2518 else
2519 n2 = tv_get_number_chk(tv_idx2, NULL);
2520 bloblen = blob_len(tv_dest->vval.v_blob);
2521
2522 if (check_blob_index(bloblen, n1, FALSE) == FAIL
2523 || check_blob_range(bloblen, n1, n2, FALSE) == FAIL)
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002524 status = FAIL;
2525 else
Bram Moolenaar2995e5c2022-03-18 21:41:47 +00002526 status = blob_set_range(tv_dest->vval.v_blob, n1, n2, tv);
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002527 }
2528 else
2529 {
2530 status = FAIL;
Bram Moolenaarea5c8982022-02-17 14:42:02 +00002531 emsg(_(e_list_or_blob_required));
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002532 }
2533
2534 clear_tv(tv_idx1);
2535 clear_tv(tv_idx2);
2536 clear_tv(tv_dest);
2537 ectx->ec_stack.ga_len -= 4;
2538 clear_tv(tv);
2539
2540 return status;
2541}
2542
2543/*
2544 * Unlet item in list or dict variable.
2545 */
2546 static int
2547execute_unletindex(isn_T *iptr, ectx_T *ectx)
2548{
2549 typval_T *tv_idx = STACK_TV_BOT(-2);
2550 typval_T *tv_dest = STACK_TV_BOT(-1);
2551 int status = OK;
2552
2553 // Stack contains:
2554 // -2 index
2555 // -1 dict or list
Bram Moolenaar6296d1e2022-02-17 16:30:11 +00002556 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002557 if (tv_dest->v_type == VAR_DICT)
2558 {
2559 // unlet a dict item, index must be a string
Bram Moolenaarea5c8982022-02-17 14:42:02 +00002560 if (tv_idx->v_type != VAR_STRING && tv_idx->v_type != VAR_NUMBER)
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002561 {
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002562 semsg(_(e_expected_str_but_got_str),
2563 vartype_name(VAR_STRING),
2564 vartype_name(tv_idx->v_type));
2565 status = FAIL;
2566 }
2567 else
2568 {
2569 dict_T *d = tv_dest->vval.v_dict;
Bram Moolenaarea5c8982022-02-17 14:42:02 +00002570 char_u *key;
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002571 dictitem_T *di = NULL;
2572
2573 if (d != NULL && value_check_lock(
2574 d->dv_lock, NULL, FALSE))
2575 status = FAIL;
2576 else
2577 {
Bram Moolenaarea5c8982022-02-17 14:42:02 +00002578 if (tv_idx->v_type == VAR_STRING)
2579 {
2580 key = tv_idx->vval.v_string;
2581 if (key == NULL)
2582 key = (char_u *)"";
2583 }
2584 else
2585 {
2586 key = tv_get_string(tv_idx);
2587 }
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002588 if (d != NULL)
2589 di = dict_find(d, key, (int)STRLEN(key));
2590 if (di == NULL)
2591 {
2592 // NULL dict is equivalent to empty dict
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00002593 semsg(_(e_key_not_present_in_dictionary_str), key);
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002594 status = FAIL;
2595 }
2596 else if (var_check_fixed(di->di_flags,
2597 NULL, FALSE)
2598 || var_check_ro(di->di_flags,
2599 NULL, FALSE))
2600 status = FAIL;
2601 else
Bram Moolenaaref2c3252022-11-25 16:31:51 +00002602 dictitem_remove(d, di, "unlet");
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002603 }
2604 }
2605 }
2606 else if (tv_dest->v_type == VAR_LIST)
2607 {
2608 // unlet a List item, index must be a number
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002609 if (check_for_number(tv_idx) == FAIL)
2610 {
2611 status = FAIL;
2612 }
2613 else
2614 {
2615 list_T *l = tv_dest->vval.v_list;
2616 long n = (long)tv_idx->vval.v_number;
2617
2618 if (l != NULL && value_check_lock(
2619 l->lv_lock, NULL, FALSE))
2620 status = FAIL;
2621 else
2622 {
2623 listitem_T *li = list_find(l, n);
2624
2625 if (li == NULL)
2626 {
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002627 semsg(_(e_list_index_out_of_range_nr), n);
2628 status = FAIL;
2629 }
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002630 else
2631 listitem_remove(l, li);
2632 }
2633 }
2634 }
2635 else
2636 {
2637 status = FAIL;
2638 semsg(_(e_cannot_index_str),
2639 vartype_name(tv_dest->v_type));
2640 }
2641
2642 clear_tv(tv_idx);
2643 clear_tv(tv_dest);
2644 ectx->ec_stack.ga_len -= 2;
2645
2646 return status;
2647}
2648
2649/*
2650 * Unlet a range of items in a list variable.
2651 */
2652 static int
2653execute_unletrange(isn_T *iptr, ectx_T *ectx)
2654{
2655 // Stack contains:
2656 // -3 index1
2657 // -2 index2
2658 // -1 dict or list
2659 typval_T *tv_idx1 = STACK_TV_BOT(-3);
2660 typval_T *tv_idx2 = STACK_TV_BOT(-2);
2661 typval_T *tv_dest = STACK_TV_BOT(-1);
2662 int status = OK;
2663
2664 if (tv_dest->v_type == VAR_LIST)
2665 {
2666 // indexes must be a number
2667 SOURCING_LNUM = iptr->isn_lnum;
2668 if (check_for_number(tv_idx1) == FAIL
2669 || (tv_idx2->v_type != VAR_SPECIAL
2670 && check_for_number(tv_idx2) == FAIL))
2671 {
2672 status = FAIL;
2673 }
2674 else
2675 {
2676 list_T *l = tv_dest->vval.v_list;
2677 long n1 = (long)tv_idx1->vval.v_number;
2678 long n2 = tv_idx2->v_type == VAR_SPECIAL
2679 ? 0 : (long)tv_idx2->vval.v_number;
2680 listitem_T *li;
2681
2682 li = list_find_index(l, &n1);
2683 if (li == NULL)
Bram Moolenaar6296d1e2022-02-17 16:30:11 +00002684 {
2685 semsg(_(e_list_index_out_of_range_nr),
2686 (long)tv_idx1->vval.v_number);
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002687 status = FAIL;
Bram Moolenaar6296d1e2022-02-17 16:30:11 +00002688 }
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002689 else
2690 {
2691 if (n1 < 0)
2692 n1 = list_idx_of_item(l, li);
2693 if (n2 < 0)
2694 {
2695 listitem_T *li2 = list_find(l, n2);
2696
2697 if (li2 == NULL)
Bram Moolenaar6296d1e2022-02-17 16:30:11 +00002698 {
2699 semsg(_(e_list_index_out_of_range_nr), n2);
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002700 status = FAIL;
Bram Moolenaar6296d1e2022-02-17 16:30:11 +00002701 }
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002702 else
2703 n2 = list_idx_of_item(l, li2);
2704 }
2705 if (status != FAIL
2706 && tv_idx2->v_type != VAR_SPECIAL
2707 && n2 < n1)
2708 {
2709 semsg(_(e_list_index_out_of_range_nr), n2);
2710 status = FAIL;
2711 }
Bram Moolenaar6b8c7ba2022-03-20 17:46:06 +00002712 if (status != FAIL)
2713 list_unlet_range(l, li, n1,
2714 tv_idx2->v_type != VAR_SPECIAL, n2);
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002715 }
2716 }
2717 }
2718 else
2719 {
2720 status = FAIL;
2721 SOURCING_LNUM = iptr->isn_lnum;
2722 semsg(_(e_cannot_index_str),
2723 vartype_name(tv_dest->v_type));
2724 }
2725
2726 clear_tv(tv_idx1);
2727 clear_tv(tv_idx2);
2728 clear_tv(tv_dest);
2729 ectx->ec_stack.ga_len -= 3;
2730
2731 return status;
2732}
2733
2734/*
2735 * Top of a for loop.
2736 */
2737 static int
2738execute_for(isn_T *iptr, ectx_T *ectx)
2739{
2740 typval_T *tv;
Bram Moolenaarb46c0832022-09-15 17:19:37 +01002741 int jump = FALSE;
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002742 typval_T *ltv = STACK_TV_BOT(-1);
2743 typval_T *idxtv =
Bram Moolenaarcc341812022-09-19 15:54:34 +01002744 STACK_TV_VAR(iptr->isn_arg.forloop.for_loop_idx);
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002745
2746 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
2747 return FAIL;
2748 if (ltv->v_type == VAR_LIST)
2749 {
2750 list_T *list = ltv->vval.v_list;
2751
2752 // push the next item from the list
2753 ++idxtv->vval.v_number;
2754 if (list == NULL
2755 || idxtv->vval.v_number >= list->lv_len)
2756 {
Bram Moolenaarb46c0832022-09-15 17:19:37 +01002757 jump = TRUE;
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002758 }
2759 else if (list->lv_first == &range_list_item)
2760 {
2761 // non-materialized range() list
2762 tv = STACK_TV_BOT(0);
2763 tv->v_type = VAR_NUMBER;
2764 tv->v_lock = 0;
2765 tv->vval.v_number = list_find_nr(
2766 list, idxtv->vval.v_number, NULL);
2767 ++ectx->ec_stack.ga_len;
2768 }
2769 else
2770 {
2771 listitem_T *li = list_find(list,
2772 idxtv->vval.v_number);
2773
2774 copy_tv(&li->li_tv, STACK_TV_BOT(0));
2775 ++ectx->ec_stack.ga_len;
2776 }
2777 }
2778 else if (ltv->v_type == VAR_STRING)
2779 {
2780 char_u *str = ltv->vval.v_string;
2781
2782 // The index is for the last byte of the previous
2783 // character.
2784 ++idxtv->vval.v_number;
2785 if (str == NULL || str[idxtv->vval.v_number] == NUL)
2786 {
Bram Moolenaarb46c0832022-09-15 17:19:37 +01002787 jump = TRUE;
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002788 }
2789 else
2790 {
2791 int clen = mb_ptr2len(str + idxtv->vval.v_number);
2792
2793 // Push the next character from the string.
2794 tv = STACK_TV_BOT(0);
2795 tv->v_type = VAR_STRING;
2796 tv->vval.v_string = vim_strnsave(
2797 str + idxtv->vval.v_number, clen);
2798 ++ectx->ec_stack.ga_len;
2799 idxtv->vval.v_number += clen - 1;
2800 }
2801 }
2802 else if (ltv->v_type == VAR_BLOB)
2803 {
2804 blob_T *blob = ltv->vval.v_blob;
2805
2806 // When we get here the first time make a copy of the
2807 // blob, so that the iteration still works when it is
2808 // changed.
2809 if (idxtv->vval.v_number == -1 && blob != NULL)
2810 {
2811 blob_copy(blob, ltv);
2812 blob_unref(blob);
2813 blob = ltv->vval.v_blob;
2814 }
2815
2816 // The index is for the previous byte.
2817 ++idxtv->vval.v_number;
Bram Moolenaarb46c0832022-09-15 17:19:37 +01002818 if (blob == NULL || idxtv->vval.v_number >= blob_len(blob))
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002819 {
Bram Moolenaarb46c0832022-09-15 17:19:37 +01002820 jump = TRUE;
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002821 }
2822 else
2823 {
2824 // Push the next byte from the blob.
2825 tv = STACK_TV_BOT(0);
2826 tv->v_type = VAR_NUMBER;
2827 tv->vval.v_number = blob_get(blob,
2828 idxtv->vval.v_number);
2829 ++ectx->ec_stack.ga_len;
2830 }
2831 }
2832 else
2833 {
2834 semsg(_(e_for_loop_on_str_not_supported),
2835 vartype_name(ltv->v_type));
2836 return FAIL;
2837 }
Bram Moolenaarb46c0832022-09-15 17:19:37 +01002838
2839 if (jump)
2840 {
2841 // past the end of the list/string/blob, jump to "endfor"
2842 ectx->ec_iidx = iptr->isn_arg.forloop.for_end;
2843 may_restore_cmdmod(&ectx->ec_funclocal);
2844 }
2845 else
2846 {
2847 // Store the current number of funcrefs, this may be used in
2848 // ISN_LOOPEND. The variable index is always one more than the loop
2849 // variable index.
Bram Moolenaarcc341812022-09-19 15:54:34 +01002850 tv = STACK_TV_VAR(iptr->isn_arg.forloop.for_loop_idx + 1);
Bram Moolenaarb46c0832022-09-15 17:19:37 +01002851 tv->vval.v_number = ectx->ec_funcrefs.ga_len;
2852 }
2853
2854 return OK;
2855}
2856
2857/*
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01002858 * Code for handling variables declared inside a loop and used in a closure.
2859 * This is very similar to what is done with funcstack_T. The difference is
2860 * that the funcstack_T has the scope of a function, while a loopvars_T has the
2861 * scope of the block inside a loop and each loop may have its own.
2862 */
2863
2864// Double linked list of loopvars_T in use.
2865static loopvars_T *first_loopvars = NULL;
2866
2867 static void
2868add_loopvars_to_list(loopvars_T *loopvars)
2869{
2870 // Link in list of loopvarss.
2871 if (first_loopvars != NULL)
2872 first_loopvars->lvs_prev = loopvars;
2873 loopvars->lvs_next = first_loopvars;
2874 loopvars->lvs_prev = NULL;
2875 first_loopvars = loopvars;
2876}
2877
2878 static void
2879remove_loopvars_from_list(loopvars_T *loopvars)
2880{
2881 if (loopvars->lvs_prev == NULL)
2882 first_loopvars = loopvars->lvs_next;
2883 else
2884 loopvars->lvs_prev->lvs_next = loopvars->lvs_next;
2885 if (loopvars->lvs_next != NULL)
2886 loopvars->lvs_next->lvs_prev = loopvars->lvs_prev;
2887}
2888
2889/*
Bram Moolenaarb46c0832022-09-15 17:19:37 +01002890 * End of a for or while loop: Handle any variables used by a closure.
2891 */
2892 static int
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01002893execute_endloop(isn_T *iptr, ectx_T *ectx)
Bram Moolenaarb46c0832022-09-15 17:19:37 +01002894{
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01002895 endloop_T *endloop = &iptr->isn_arg.endloop;
2896 typval_T *tv_refcount = STACK_TV_VAR(endloop->end_funcref_idx);
2897 int prev_closure_count = tv_refcount->vval.v_number;
Bram Moolenaarcc341812022-09-19 15:54:34 +01002898 int depth = endloop->end_depth;
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01002899 garray_T *gap = &ectx->ec_funcrefs;
2900 int closure_in_use = FALSE;
2901 loopvars_T *loopvars;
2902 typval_T *stack;
2903 int idx;
2904
Bram Moolenaarcc341812022-09-19 15:54:34 +01002905 // Check if any created closure is still being referenced and loopvars have
2906 // not been saved yet for the current depth.
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01002907 for (idx = prev_closure_count; idx < gap->ga_len; ++idx)
2908 {
2909 partial_T *pt = ((partial_T **)gap->ga_data)[idx];
2910
Bram Moolenaarcc341812022-09-19 15:54:34 +01002911 if (pt->pt_refcount > 1 && pt->pt_loopvars[depth] == NULL)
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01002912 {
2913 int refcount = pt->pt_refcount;
2914 int i;
2915
2916 // A Reference in a variable inside the loop doesn't count, it gets
2917 // unreferenced at the end of the loop.
2918 for (i = 0; i < endloop->end_var_count; ++i)
2919 {
2920 typval_T *stv = STACK_TV_VAR(endloop->end_var_idx + i);
2921
2922 if (stv->v_type == VAR_PARTIAL && pt == stv->vval.v_partial)
2923 --refcount;
2924 }
2925 if (refcount > 1)
2926 {
2927 closure_in_use = TRUE;
2928 break;
2929 }
2930 }
2931 }
2932
2933 // If no function reference were created since the start of the loop block
2934 // or it is no longer referenced there is nothing to do.
2935 if (!closure_in_use)
2936 return OK;
2937
2938 // A closure is using variables declared inside the loop.
2939 // Move them to the called function.
2940 loopvars = ALLOC_CLEAR_ONE(loopvars_T);
2941 if (loopvars == NULL)
2942 return FAIL;
2943
2944 loopvars->lvs_ga.ga_len = endloop->end_var_count;
2945 stack = ALLOC_CLEAR_MULT(typval_T, loopvars->lvs_ga.ga_len);
2946 loopvars->lvs_ga.ga_data = stack;
2947 if (stack == NULL)
2948 {
2949 vim_free(loopvars);
2950 return FAIL;
2951 }
2952 add_loopvars_to_list(loopvars);
2953
2954 // Move the variable values.
2955 for (idx = 0; idx < endloop->end_var_count; ++idx)
2956 {
2957 typval_T *tv = STACK_TV_VAR(endloop->end_var_idx + idx);
2958
2959 *(stack + idx) = *tv;
2960 tv->v_type = VAR_UNKNOWN;
2961 }
2962
2963 for (idx = prev_closure_count; idx < gap->ga_len; ++idx)
2964 {
2965 partial_T *pt = ((partial_T **)gap->ga_data)[idx];
2966
Bram Moolenaarcc341812022-09-19 15:54:34 +01002967 if (pt->pt_refcount > 1 && pt->pt_loopvars[depth] == NULL)
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01002968 {
2969 ++loopvars->lvs_refcount;
Bram Moolenaarcc341812022-09-19 15:54:34 +01002970 pt->pt_loopvars[depth] = loopvars;
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01002971
Bram Moolenaarcc341812022-09-19 15:54:34 +01002972 pt->pt_outer.out_loop[depth].stack = &loopvars->lvs_ga;
2973 pt->pt_outer.out_loop[depth].var_idx -=
2974 ectx->ec_frame_idx + STACK_FRAME_SIZE + endloop->end_var_idx;
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01002975 }
2976 }
Bram Moolenaarb46c0832022-09-15 17:19:37 +01002977
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00002978 return OK;
2979}
2980
2981/*
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01002982 * Called when a partial is freed or its reference count goes down to one. The
2983 * loopvars may be the only reference to the partials in the local variables.
2984 * Go over all of them, the funcref and can be freed if all partials
2985 * referencing the loopvars have a reference count of one.
Bram Moolenaarcc341812022-09-19 15:54:34 +01002986 * Return TRUE if it was freed.
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01002987 */
Bram Moolenaarcc341812022-09-19 15:54:34 +01002988 int
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01002989loopvars_check_refcount(loopvars_T *loopvars)
2990{
2991 int i;
2992 garray_T *gap = &loopvars->lvs_ga;
2993 int done = 0;
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01002994 typval_T *stack = gap->ga_data;
2995
Bram Moolenaarcc341812022-09-19 15:54:34 +01002996 if (loopvars->lvs_refcount > loopvars->lvs_min_refcount)
2997 return FALSE;
2998 for (i = 0; i < gap->ga_len; ++i)
2999 {
3000 typval_T *tv = ((typval_T *)gap->ga_data) + i;
3001
3002 if (tv->v_type == VAR_PARTIAL && tv->vval.v_partial != NULL
3003 && tv->vval.v_partial->pt_refcount == 1)
3004 {
3005 int depth;
3006
3007 for (depth = 0; depth < MAX_LOOP_DEPTH; ++depth)
3008 if (tv->vval.v_partial->pt_loopvars[depth] == loopvars)
3009 ++done;
3010 }
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01003011 }
Bram Moolenaarcc341812022-09-19 15:54:34 +01003012 if (done != loopvars->lvs_min_refcount)
3013 return FALSE;
3014
3015 // All partials referencing the loopvars have a reference count of
3016 // one, thus the loopvars is no longer of use.
3017 stack = gap->ga_data;
3018 for (i = 0; i < gap->ga_len; ++i)
3019 clear_tv(stack + i);
3020 vim_free(stack);
3021 remove_loopvars_from_list(loopvars);
3022 vim_free(loopvars);
3023 return TRUE;
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01003024}
3025
3026/*
3027 * For garbage collecting: set references in all variables referenced by
3028 * all loopvars.
3029 */
3030 int
3031set_ref_in_loopvars(int copyID)
3032{
3033 loopvars_T *loopvars;
3034
3035 for (loopvars = first_loopvars; loopvars != NULL;
3036 loopvars = loopvars->lvs_next)
3037 {
3038 typval_T *stack = loopvars->lvs_ga.ga_data;
3039 int i;
3040
3041 for (i = 0; i < loopvars->lvs_ga.ga_len; ++i)
3042 if (set_ref_in_item(stack + i, copyID, NULL, NULL))
3043 return TRUE; // abort
3044 }
3045 return FALSE;
3046}
3047
3048/*
Bram Moolenaar06b77222022-01-25 15:51:56 +00003049 * Load instruction for w:/b:/g:/t: variable.
3050 * "isn_type" is used instead of "iptr->isn_type".
3051 */
3052 static int
3053load_namespace_var(ectx_T *ectx, isntype_T isn_type, isn_T *iptr)
3054{
3055 dictitem_T *di = NULL;
3056 hashtab_T *ht = NULL;
3057 char namespace;
3058
3059 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
3060 return NOTDONE;
3061 switch (isn_type)
3062 {
3063 case ISN_LOADG:
3064 ht = get_globvar_ht();
3065 namespace = 'g';
3066 break;
3067 case ISN_LOADB:
3068 ht = &curbuf->b_vars->dv_hashtab;
3069 namespace = 'b';
3070 break;
3071 case ISN_LOADW:
3072 ht = &curwin->w_vars->dv_hashtab;
3073 namespace = 'w';
3074 break;
3075 case ISN_LOADT:
3076 ht = &curtab->tp_vars->dv_hashtab;
3077 namespace = 't';
3078 break;
3079 default: // Cannot reach here
3080 return NOTDONE;
3081 }
3082 di = find_var_in_ht(ht, 0, iptr->isn_arg.string, TRUE);
3083
Bram Moolenaar06b77222022-01-25 15:51:56 +00003084 if (di == NULL)
3085 {
Bram Moolenaarfe732552022-02-22 19:39:13 +00003086 if (isn_type == ISN_LOADG)
3087 {
3088 ufunc_T *ufunc = find_func(iptr->isn_arg.string, TRUE);
3089
3090 // g:Something could be a function
3091 if (ufunc != NULL)
3092 {
3093 typval_T *tv = STACK_TV_BOT(0);
3094
3095 ++ectx->ec_stack.ga_len;
3096 tv->v_type = VAR_FUNC;
3097 tv->vval.v_string = alloc(STRLEN(iptr->isn_arg.string) + 3);
3098 if (tv->vval.v_string == NULL)
3099 return FAIL;
3100 STRCPY(tv->vval.v_string, "g:");
3101 STRCPY(tv->vval.v_string + 2, iptr->isn_arg.string);
3102 return OK;
3103 }
3104 }
Bram Moolenaar06b77222022-01-25 15:51:56 +00003105 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaarfe732552022-02-22 19:39:13 +00003106 if (vim_strchr(iptr->isn_arg.string, AUTOLOAD_CHAR) != NULL)
Bram Moolenaar06b77222022-01-25 15:51:56 +00003107 // no check if the item exists in the script but
3108 // isn't exported, it is too complicated
Bram Moolenaarfe732552022-02-22 19:39:13 +00003109 semsg(_(e_item_not_found_in_script_str), iptr->isn_arg.string);
Bram Moolenaar06b77222022-01-25 15:51:56 +00003110 else
3111 semsg(_(e_undefined_variable_char_str),
Bram Moolenaarfe732552022-02-22 19:39:13 +00003112 namespace, iptr->isn_arg.string);
Bram Moolenaar06b77222022-01-25 15:51:56 +00003113 return FAIL;
3114 }
3115 else
3116 {
3117 copy_tv(&di->di_tv, STACK_TV_BOT(0));
3118 ++ectx->ec_stack.ga_len;
3119 }
3120 return OK;
3121}
3122
Bram Moolenaard0200c82023-01-28 15:19:40 +00003123
3124 static void
3125object_required_error(typval_T *tv)
3126{
3127 garray_T type_list;
3128 ga_init2(&type_list, sizeof(type_T *), 10);
3129 type_T *type = typval2type(tv, get_copyID(), &type_list, TVTT_DO_MEMBER);
3130 char *tofree = NULL;
3131 char *typename = type_name(type, &tofree);
3132 semsg(_(e_object_required_found_str), typename);
3133 vim_free(tofree);
3134 clear_type_list(&type_list);
3135}
3136
Bram Moolenaar06b77222022-01-25 15:51:56 +00003137/*
Yegappan Lakshmanan56d45f12024-11-11 19:58:55 +01003138 * Accessing the member of an object stored in a variable of type "any".
3139 * Returns OK if the member variable is present.
3140 * Returns FAIL if the variable is not found.
3141 */
3142 static int
3143any_var_get_obj_member(class_T *current_class, isn_T *iptr, typval_T *tv)
3144{
3145 object_T *obj = tv->vval.v_object;
3146 typval_T mtv;
3147
3148 if (obj == NULL)
3149 {
3150 SOURCING_LNUM = iptr->isn_lnum;
3151 emsg(_(e_using_null_object));
3152 return FAIL;
3153 }
3154
3155 // get_member_tv() needs the object information in the typval argument.
3156 // So set the object information.
3157 copy_tv(tv, &mtv);
3158
3159 // 'name' can either be a object variable or a object method
3160 int namelen = STRLEN(iptr->isn_arg.string);
3161 int save_did_emsg = did_emsg;
3162
3163 if (get_member_tv(obj->obj_class, TRUE, iptr->isn_arg.string, namelen,
3164 current_class, &mtv) == OK)
3165 {
3166 copy_tv(&mtv, tv);
3167 clear_tv(&mtv);
3168 return OK;
3169 }
3170
3171 if (did_emsg != save_did_emsg)
3172 return FAIL;
3173
3174 // could be a member function
3175 ufunc_T *obj_method;
3176 int obj_method_idx;
3177
3178 obj_method = method_lookup(obj->obj_class, VAR_OBJECT,
3179 iptr->isn_arg.string, namelen,
3180 &obj_method_idx);
3181 if (obj_method == NULL)
3182 {
3183 SOURCING_LNUM = iptr->isn_lnum;
3184 semsg(_(e_variable_not_found_on_object_str_str), iptr->isn_arg.string,
3185 obj->obj_class->class_name);
3186 return FAIL;
3187 }
3188
3189 // Protected methods are not accessible outside the class
3190 if (*obj_method->uf_name == '_'
3191 && !class_instance_of(current_class, obj->obj_class))
3192 {
3193 semsg(_(e_cannot_access_protected_method_str), obj_method->uf_name);
3194 return FAIL;
3195 }
3196
3197 // Create a partial for the member function
3198 if (obj_method_to_partial_tv(obj, obj_method, tv) == FAIL)
3199 return FAIL;
3200
3201 return OK;
3202}
3203
3204/*
Bram Moolenaar4c137212021-04-19 16:48:48 +02003205 * Execute instructions in execution context "ectx".
3206 * Return OK or FAIL;
3207 */
3208 static int
3209exec_instructions(ectx_T *ectx)
3210{
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003211 int ret = FAIL;
3212 int save_trylevel_at_start = ectx->ec_trylevel_at_start;
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02003213 int dict_stack_len_at_start = dict_stack.ga_len;
Bram Moolenaarf785aa12021-02-11 21:19:34 +01003214
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +02003215 // Start execution at the first instruction.
Bram Moolenaar4c137212021-04-19 16:48:48 +02003216 ectx->ec_iidx = 0;
Bram Moolenaar170fcfc2020-02-06 17:51:35 +01003217
Bram Moolenaarff652882021-05-16 15:24:49 +02003218 // Only catch exceptions in this instruction list.
3219 ectx->ec_trylevel_at_start = trylevel;
3220
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003221 for (;;)
3222 {
Bram Moolenaara7490192021-07-22 12:26:14 +02003223 static int breakcheck_count = 0; // using "static" makes it faster
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003224 isn_T *iptr;
Bram Moolenaara7490192021-07-22 12:26:14 +02003225 typval_T *tv;
Bram Moolenaar20431c92020-03-20 18:39:46 +01003226
Dominique Pelle5a9e5842021-07-24 19:32:12 +02003227 if (unlikely(++breakcheck_count >= 100))
Bram Moolenaar270d0382020-05-15 21:42:53 +02003228 {
3229 line_breakcheck();
3230 breakcheck_count = 0;
3231 }
Dominique Pelle5a9e5842021-07-24 19:32:12 +02003232 if (unlikely(got_int))
Bram Moolenaar20431c92020-03-20 18:39:46 +01003233 {
3234 // Turn CTRL-C into an exception.
3235 got_int = FALSE;
Bram Moolenaar97acfc72020-03-22 13:44:28 +01003236 if (throw_exception("Vim:Interrupt", ET_INTERRUPT, NULL) == FAIL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003237 goto theend;
Bram Moolenaar20431c92020-03-20 18:39:46 +01003238 did_throw = TRUE;
3239 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003240
Dominique Pelle5a9e5842021-07-24 19:32:12 +02003241 if (unlikely(did_emsg && msg_list != NULL && *msg_list != NULL))
Bram Moolenaara26b9702020-04-18 19:53:28 +02003242 {
3243 // Turn an error message into an exception.
3244 did_emsg = FALSE;
3245 if (throw_exception(*msg_list, ET_ERROR, NULL) == FAIL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003246 goto theend;
Bram Moolenaara26b9702020-04-18 19:53:28 +02003247 did_throw = TRUE;
3248 *msg_list = NULL;
Bram Moolenaar3ef2e412023-04-30 18:50:48 +01003249
3250 // This exception was not caught (yet).
3251 garray_T *trystack = &ectx->ec_trystack;
3252 if (trystack->ga_len > 0)
3253 {
3254 trycmd_T *trycmd = ((trycmd_T *)trystack->ga_data)
3255 + trystack->ga_len - 1;
3256 if (trycmd->tcd_frame_idx == ectx->ec_frame_idx)
3257 trycmd->tcd_caught = FALSE;
3258 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003259 }
3260
Dominique Pelle5a9e5842021-07-24 19:32:12 +02003261 if (unlikely(did_throw))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003262 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02003263 garray_T *trystack = &ectx->ec_trystack;
Bram Moolenaar20431c92020-03-20 18:39:46 +01003264 trycmd_T *trycmd = NULL;
Bram Moolenaard3d8fee2021-06-30 19:54:43 +02003265 int index = trystack->ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003266
3267 // An exception jumps to the first catch, finally, or returns from
3268 // the current function.
Bram Moolenaard3d8fee2021-06-30 19:54:43 +02003269 while (index > 0)
3270 {
3271 trycmd = ((trycmd_T *)trystack->ga_data) + index - 1;
Bram Moolenaar3ef2e412023-04-30 18:50:48 +01003272 // 1. after :try and before :catch - jump to first :catch
3273 // 2. in :catch block - jump to :finally
3274 // 3. in :catch block and no finally - jump to :endtry
3275 if (!trycmd->tcd_in_catch || trycmd->tcd_finally_idx != 0
3276 || trycmd->tcd_frame_idx == ectx->ec_frame_idx)
Bram Moolenaard3d8fee2021-06-30 19:54:43 +02003277 break;
3278 // In the catch and finally block of this try we have to go up
3279 // one level.
3280 --index;
3281 trycmd = NULL;
3282 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02003283 if (trycmd != NULL && trycmd->tcd_frame_idx == ectx->ec_frame_idx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003284 {
Bram Moolenaar834193a2021-06-30 20:39:15 +02003285 if (trycmd->tcd_in_catch)
3286 {
Bram Moolenaar3ef2e412023-04-30 18:50:48 +01003287 if (trycmd->tcd_finally_idx > 0)
3288 {
3289 // exception inside ":catch", jump to ":finally" once
3290 ectx->ec_iidx = trycmd->tcd_finally_idx;
3291 trycmd->tcd_finally_idx = 0;
3292 }
3293 else
3294 {
3295 // exception inside ":catch" or ":finally", jump to
3296 // ":endtry"
3297 ectx->ec_iidx = trycmd->tcd_endtry_idx;
3298 }
Bram Moolenaar834193a2021-06-30 20:39:15 +02003299 }
3300 else
Bram Moolenaar3ef2e412023-04-30 18:50:48 +01003301 {
Bram Moolenaar834193a2021-06-30 20:39:15 +02003302 // jump to first ":catch"
3303 ectx->ec_iidx = trycmd->tcd_catch_idx;
Bram Moolenaar3ef2e412023-04-30 18:50:48 +01003304 trycmd->tcd_in_catch = TRUE;
3305 }
Bram Moolenaard3d8fee2021-06-30 19:54:43 +02003306 did_throw = FALSE; // don't come back here until :endtry
3307 trycmd->tcd_did_throw = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003308 }
3309 else
3310 {
Bram Moolenaar3ef2e412023-04-30 18:50:48 +01003311 // Not inside try or need to return from current function.
Bram Moolenaarcdd70f02020-08-13 21:40:18 +02003312 // Push a dummy return value.
Bram Moolenaar35578162021-08-02 19:10:38 +02003313 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003314 goto theend;
Bram Moolenaarcdd70f02020-08-13 21:40:18 +02003315 tv = STACK_TV_BOT(0);
3316 tv->v_type = VAR_NUMBER;
3317 tv->vval.v_number = 0;
Bram Moolenaar4c137212021-04-19 16:48:48 +02003318 ++ectx->ec_stack.ga_len;
3319 if (ectx->ec_frame_idx == ectx->ec_initial_frame_idx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003320 {
Bram Moolenaarcdd70f02020-08-13 21:40:18 +02003321 // At the toplevel we are done.
Bram Moolenaar257cc5e2020-02-19 17:06:11 +01003322 need_rethrow = TRUE;
Bram Moolenaar4c137212021-04-19 16:48:48 +02003323 if (handle_closure_in_use(ectx, FALSE) == FAIL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003324 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003325 goto done;
3326 }
3327
Bram Moolenaar4c137212021-04-19 16:48:48 +02003328 if (func_return(ectx) == FAIL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003329 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003330 }
3331 continue;
3332 }
3333
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00003334 /*
3335 * Big switch on the instruction. Most compilers will be turning this
3336 * into an efficient lookup table, since the "case" values are an enum
3337 * with sequential numbers. It may look ugly, but it should be the
3338 * most efficient way.
3339 */
Bram Moolenaar4c137212021-04-19 16:48:48 +02003340 iptr = &ectx->ec_instr[ectx->ec_iidx++];
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003341 switch (iptr->isn_type)
3342 {
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00003343 // Constructor, first instruction in a new() method.
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003344 case ISN_CONSTRUCT:
3345 // "this" is always the local variable at index zero
3346 tv = STACK_TV_VAR(0);
3347 tv->v_type = VAR_OBJECT;
3348 tv->vval.v_object = alloc_clear(
3349 iptr->isn_arg.construct.construct_size);
3350 tv->vval.v_object->obj_class =
3351 iptr->isn_arg.construct.construct_class;
Bram Moolenaard28d7b92022-12-08 20:42:00 +00003352 ++tv->vval.v_object->obj_class->class_refcount;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003353 tv->vval.v_object->obj_refcount = 1;
Bram Moolenaard28d7b92022-12-08 20:42:00 +00003354 object_created(tv->vval.v_object);
Yegappan Lakshmanan3164cf82024-03-28 10:36:42 +01003355
3356 // When creating an enum value object, initialize the name and
3357 // ordinal object variables.
3358 class_T *en = tv->vval.v_object->obj_class;
3359 if (IS_ENUM(en))
3360 enum_set_internal_obj_vars(en, tv->vval.v_object);
Bram Moolenaar00b28d62022-12-08 15:32:33 +00003361 break;
3362
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003363 // execute Ex command line
3364 case ISN_EXEC:
Ernie Raelee865f32023-09-29 19:53:55 +02003365 if (exec_command(iptr, iptr->isn_arg.string) == FAIL)
Bram Moolenaaraacc9662021-08-13 19:40:51 +02003366 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003367 break;
3368
Bram Moolenaar20677332021-06-06 17:02:53 +02003369 // execute Ex command line split at NL characters.
3370 case ISN_EXEC_SPLIT:
3371 {
3372 source_cookie_T cookie;
Bram Moolenaar518df272021-06-06 17:34:13 +02003373 char_u *line;
Bram Moolenaar20677332021-06-06 17:02:53 +02003374
3375 SOURCING_LNUM = iptr->isn_lnum;
3376 CLEAR_FIELD(cookie);
3377 cookie.sourcing_lnum = iptr->isn_lnum - 1;
3378 cookie.nextline = iptr->isn_arg.string;
Bram Moolenaar518df272021-06-06 17:34:13 +02003379 line = get_split_sourceline(0, &cookie, 0, 0);
3380 if (do_cmdline(line,
Bram Moolenaar20677332021-06-06 17:02:53 +02003381 get_split_sourceline, &cookie,
3382 DOCMD_VERBOSE|DOCMD_NOWAIT|DOCMD_KEYTYPED)
3383 == FAIL
3384 || did_emsg)
Bram Moolenaar518df272021-06-06 17:34:13 +02003385 {
3386 vim_free(line);
Bram Moolenaar20677332021-06-06 17:02:53 +02003387 goto on_error;
Bram Moolenaar518df272021-06-06 17:34:13 +02003388 }
3389 vim_free(line);
Bram Moolenaar20677332021-06-06 17:02:53 +02003390 }
3391 break;
3392
Bram Moolenaare4eed8c2021-12-01 15:22:56 +00003393 // execute Ex command line that is only a range
3394 case ISN_EXECRANGE:
3395 {
3396 exarg_T ea;
3397 char *error = NULL;
3398
3399 CLEAR_FIELD(ea);
3400 ea.cmdidx = CMD_SIZE;
3401 ea.addr_type = ADDR_LINES;
3402 ea.cmd = iptr->isn_arg.string;
Bram Moolenaar0c7f2612022-02-17 19:44:07 +00003403 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaare4eed8c2021-12-01 15:22:56 +00003404 parse_cmd_address(&ea, &error, FALSE);
Bram Moolenaar01a4dcb2021-12-04 13:15:10 +00003405 if (ea.cmd == NULL)
3406 goto on_error;
Bram Moolenaar0c7f2612022-02-17 19:44:07 +00003407 // error is always NULL when using ADDR_LINES
3408 error = ex_range_without_command(&ea);
Bram Moolenaare4eed8c2021-12-01 15:22:56 +00003409 if (error != NULL)
3410 {
Bram Moolenaare4eed8c2021-12-01 15:22:56 +00003411 emsg(error);
3412 goto on_error;
3413 }
3414 }
3415 break;
3416
Bram Moolenaar3b1373b2021-05-17 00:01:42 +02003417 // Evaluate an expression with legacy syntax, push it onto the
3418 // stack.
3419 case ISN_LEGACY_EVAL:
3420 {
3421 char_u *arg = iptr->isn_arg.string;
3422 int res;
3423 int save_flags = cmdmod.cmod_flags;
3424
Bram Moolenaar35578162021-08-02 19:10:38 +02003425 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003426 goto theend;
Bram Moolenaar3b1373b2021-05-17 00:01:42 +02003427 tv = STACK_TV_BOT(0);
3428 init_tv(tv);
3429 cmdmod.cmod_flags |= CMOD_LEGACY;
3430 res = eval0(arg, tv, NULL, &EVALARG_EVALUATE);
3431 cmdmod.cmod_flags = save_flags;
3432 if (res == FAIL)
3433 goto on_error;
3434 ++ectx->ec_stack.ga_len;
3435 }
3436 break;
3437
Bram Moolenaarf18332f2021-05-07 17:55:55 +02003438 // push typeval VAR_INSTR with instructions to be executed
3439 case ISN_INSTR:
3440 {
Bram Moolenaar35578162021-08-02 19:10:38 +02003441 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003442 goto theend;
Bram Moolenaarf18332f2021-05-07 17:55:55 +02003443 tv = STACK_TV_BOT(0);
3444 tv->vval.v_instr = ALLOC_ONE(instr_T);
3445 if (tv->vval.v_instr == NULL)
3446 goto on_error;
3447 ++ectx->ec_stack.ga_len;
3448
3449 tv->v_type = VAR_INSTR;
3450 tv->vval.v_instr->instr_ectx = ectx;
3451 tv->vval.v_instr->instr_instr = iptr->isn_arg.instr;
3452 }
3453 break;
3454
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003455 case ISN_SOURCE:
3456 {
Bram Moolenaar89445512022-04-14 12:58:23 +01003457 int notused;
LemonBoy77142312022-04-15 20:50:46 +01003458
Bram Moolenaar89445512022-04-14 12:58:23 +01003459 SOURCING_LNUM = iptr->isn_lnum;
3460 if (may_load_script((int)iptr->isn_arg.number, &notused)
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003461 == FAIL)
Bram Moolenaar89445512022-04-14 12:58:23 +01003462 goto on_error;
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003463 }
3464 break;
3465
Bram Moolenaar4c137212021-04-19 16:48:48 +02003466 // execute :substitute with an expression
3467 case ISN_SUBSTITUTE:
3468 {
3469 subs_T *subs = &iptr->isn_arg.subs;
3470 source_cookie_T cookie;
3471 struct subs_expr_S *save_instr = substitute_instr;
3472 struct subs_expr_S subs_instr;
3473 int res;
3474
3475 subs_instr.subs_ectx = ectx;
3476 subs_instr.subs_instr = subs->subs_instr;
3477 subs_instr.subs_status = OK;
3478 substitute_instr = &subs_instr;
3479
3480 SOURCING_LNUM = iptr->isn_lnum;
3481 // This is very much like ISN_EXEC
3482 CLEAR_FIELD(cookie);
3483 cookie.sourcing_lnum = iptr->isn_lnum - 1;
3484 res = do_cmdline(subs->subs_cmd,
3485 getsourceline, &cookie,
3486 DOCMD_VERBOSE|DOCMD_NOWAIT|DOCMD_KEYTYPED);
3487 substitute_instr = save_instr;
3488
3489 if (res == FAIL || did_emsg
3490 || subs_instr.subs_status == FAIL)
3491 goto on_error;
3492 }
3493 break;
3494
3495 case ISN_FINISH:
3496 goto done;
3497
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02003498 case ISN_REDIRSTART:
3499 // create a dummy entry for var_redir_str()
3500 if (alloc_redir_lval() == FAIL)
3501 goto on_error;
3502
3503 // The output is stored in growarray "redir_ga" until
3504 // redirection ends.
3505 init_redir_ga();
3506 redir_vname = 1;
3507 break;
3508
3509 case ISN_REDIREND:
3510 {
3511 char_u *res = get_clear_redir_ga();
3512
3513 // End redirection, put redirected text on the stack.
3514 clear_redir_lval();
3515 redir_vname = 0;
3516
Bram Moolenaar35578162021-08-02 19:10:38 +02003517 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02003518 {
3519 vim_free(res);
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003520 goto theend;
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02003521 }
3522 tv = STACK_TV_BOT(0);
3523 tv->v_type = VAR_STRING;
3524 tv->vval.v_string = res;
3525 ++ectx->ec_stack.ga_len;
3526 }
3527 break;
3528
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02003529 case ISN_CEXPR_AUCMD:
Bram Moolenaarb7c97812021-05-05 22:51:39 +02003530#ifdef FEAT_QUICKFIX
Bram Moolenaar397a87a2022-03-20 21:14:15 +00003531 force_abort = TRUE;
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02003532 if (trigger_cexpr_autocmd(iptr->isn_arg.number) == FAIL)
3533 goto on_error;
Bram Moolenaar397a87a2022-03-20 21:14:15 +00003534 force_abort = FALSE;
Bram Moolenaarb7c97812021-05-05 22:51:39 +02003535#endif
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02003536 break;
3537
3538 case ISN_CEXPR_CORE:
Bram Moolenaarb7c97812021-05-05 22:51:39 +02003539#ifdef FEAT_QUICKFIX
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02003540 {
3541 exarg_T ea;
3542 int res;
3543
3544 CLEAR_FIELD(ea);
3545 ea.cmdidx = iptr->isn_arg.cexpr.cexpr_ref->cer_cmdidx;
3546 ea.forceit = iptr->isn_arg.cexpr.cexpr_ref->cer_forceit;
3547 ea.cmdlinep = &iptr->isn_arg.cexpr.cexpr_ref->cer_cmdline;
3548 --ectx->ec_stack.ga_len;
3549 tv = STACK_TV_BOT(0);
Bram Moolenaarbd683e32022-07-18 17:49:03 +01003550 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02003551 res = cexpr_core(&ea, tv);
3552 clear_tv(tv);
3553 if (res == FAIL)
3554 goto on_error;
3555 }
Bram Moolenaarb7c97812021-05-05 22:51:39 +02003556#endif
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02003557 break;
3558
Bram Moolenaarcfe435d2020-04-25 20:02:55 +02003559 // execute Ex command from pieces on the stack
3560 case ISN_EXECCONCAT:
3561 {
3562 int count = iptr->isn_arg.number;
Bram Moolenaar7f6f56f2020-04-30 20:21:43 +02003563 size_t len = 0;
Bram Moolenaarcfe435d2020-04-25 20:02:55 +02003564 int pass;
3565 int i;
3566 char_u *cmd = NULL;
3567 char_u *str;
3568
3569 for (pass = 1; pass <= 2; ++pass)
3570 {
3571 for (i = 0; i < count; ++i)
3572 {
3573 tv = STACK_TV_BOT(i - count);
3574 str = tv->vval.v_string;
3575 if (str != NULL && *str != NUL)
3576 {
3577 if (pass == 2)
3578 STRCPY(cmd + len, str);
3579 len += STRLEN(str);
3580 }
3581 if (pass == 2)
3582 clear_tv(tv);
3583 }
3584 if (pass == 1)
3585 {
3586 cmd = alloc(len + 1);
Dominique Pelle5a9e5842021-07-24 19:32:12 +02003587 if (unlikely(cmd == NULL))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003588 goto theend;
Bram Moolenaarcfe435d2020-04-25 20:02:55 +02003589 len = 0;
3590 }
3591 }
3592
Bram Moolenaar6378c4f2020-04-26 13:50:41 +02003593 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaarcfe435d2020-04-25 20:02:55 +02003594 do_cmdline_cmd(cmd);
3595 vim_free(cmd);
3596 }
3597 break;
3598
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003599 // execute :echo {string} ...
3600 case ISN_ECHO:
3601 {
3602 int count = iptr->isn_arg.echo.echo_count;
3603 int atstart = TRUE;
3604 int needclr = TRUE;
Bram Moolenaar4c137212021-04-19 16:48:48 +02003605 int idx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003606
3607 for (idx = 0; idx < count; ++idx)
3608 {
3609 tv = STACK_TV_BOT(idx - count);
3610 echo_one(tv, iptr->isn_arg.echo.echo_with_white,
3611 &atstart, &needclr);
3612 clear_tv(tv);
3613 }
Bram Moolenaare0807ea2020-02-20 22:18:06 +01003614 if (needclr)
3615 msg_clr_eos();
Bram Moolenaar4c137212021-04-19 16:48:48 +02003616 ectx->ec_stack.ga_len -= count;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003617 }
3618 break;
3619
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +02003620 // :execute {string} ...
3621 // :echomsg {string} ...
Bram Moolenaar7d7ad7b2022-09-01 16:00:53 +01003622 // :echowindow {string} ...
Bram Moolenaar7de62622021-08-07 15:05:47 +02003623 // :echoconsole {string} ...
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +02003624 // :echoerr {string} ...
Bram Moolenaarad39c092020-02-26 18:23:43 +01003625 case ISN_EXECUTE:
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +02003626 case ISN_ECHOMSG:
Bram Moolenaar7d7ad7b2022-09-01 16:00:53 +01003627 case ISN_ECHOWINDOW:
Bram Moolenaar7de62622021-08-07 15:05:47 +02003628 case ISN_ECHOCONSOLE:
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +02003629 case ISN_ECHOERR:
Bram Moolenaarad39c092020-02-26 18:23:43 +01003630 {
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003631 int count;
Bram Moolenaarad39c092020-02-26 18:23:43 +01003632 garray_T ga;
3633 char_u buf[NUMBUFLEN];
3634 char_u *p;
3635 int len;
3636 int failed = FALSE;
Bram Moolenaar4c137212021-04-19 16:48:48 +02003637 int idx;
Bram Moolenaarad39c092020-02-26 18:23:43 +01003638
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003639 if (iptr->isn_type == ISN_ECHOWINDOW)
3640 count = iptr->isn_arg.echowin.ewin_count;
3641 else
3642 count = iptr->isn_arg.number;
Bram Moolenaarad39c092020-02-26 18:23:43 +01003643 ga_init2(&ga, 1, 80);
3644 for (idx = 0; idx < count; ++idx)
3645 {
3646 tv = STACK_TV_BOT(idx - count);
Bram Moolenaare5abf7a2020-08-16 18:29:35 +02003647 if (iptr->isn_type == ISN_EXECUTE)
Bram Moolenaarad39c092020-02-26 18:23:43 +01003648 {
Bram Moolenaare5abf7a2020-08-16 18:29:35 +02003649 if (tv->v_type == VAR_CHANNEL
3650 || tv->v_type == VAR_JOB)
3651 {
3652 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar68db9962021-05-09 23:19:22 +02003653 semsg(_(e_using_invalid_value_as_string_str),
3654 vartype_name(tv->v_type));
Bram Moolenaare5abf7a2020-08-16 18:29:35 +02003655 break;
3656 }
3657 else
3658 p = tv_get_string_buf(tv, buf);
Bram Moolenaarad39c092020-02-26 18:23:43 +01003659 }
3660 else
Ernie Raelbe828252024-07-26 18:37:02 +02003661 {
3662 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaare5abf7a2020-08-16 18:29:35 +02003663 p = tv_stringify(tv, buf);
Ernie Raelbe828252024-07-26 18:37:02 +02003664 }
Bram Moolenaarad39c092020-02-26 18:23:43 +01003665
3666 len = (int)STRLEN(p);
Bram Moolenaar35578162021-08-02 19:10:38 +02003667 if (GA_GROW_FAILS(&ga, len + 2))
Bram Moolenaarad39c092020-02-26 18:23:43 +01003668 failed = TRUE;
3669 else
3670 {
3671 if (ga.ga_len > 0)
3672 ((char_u *)(ga.ga_data))[ga.ga_len++] = ' ';
3673 STRCPY((char_u *)(ga.ga_data) + ga.ga_len, p);
3674 ga.ga_len += len;
3675 }
3676 clear_tv(tv);
3677 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02003678 ectx->ec_stack.ga_len -= count;
Bram Moolenaare5abf7a2020-08-16 18:29:35 +02003679 if (failed)
Bram Moolenaarc71ee822020-11-21 11:45:50 +01003680 {
3681 ga_clear(&ga);
Bram Moolenaare5abf7a2020-08-16 18:29:35 +02003682 goto on_error;
Bram Moolenaarc71ee822020-11-21 11:45:50 +01003683 }
Bram Moolenaarad39c092020-02-26 18:23:43 +01003684
Bram Moolenaare5abf7a2020-08-16 18:29:35 +02003685 if (ga.ga_data != NULL)
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +02003686 {
3687 if (iptr->isn_type == ISN_EXECUTE)
Bram Moolenaar430deb12020-08-23 16:29:11 +02003688 {
3689 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +02003690 do_cmdline_cmd((char_u *)ga.ga_data);
Bram Moolenaareeece9e2020-11-20 19:26:48 +01003691 if (did_emsg)
Bram Moolenaarc71ee822020-11-21 11:45:50 +01003692 {
3693 ga_clear(&ga);
Bram Moolenaareeece9e2020-11-20 19:26:48 +01003694 goto on_error;
Bram Moolenaarc71ee822020-11-21 11:45:50 +01003695 }
Bram Moolenaar430deb12020-08-23 16:29:11 +02003696 }
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +02003697 else
3698 {
3699 msg_sb_eol();
3700 if (iptr->isn_type == ISN_ECHOMSG)
3701 {
3702 msg_attr(ga.ga_data, echo_attr);
3703 out_flush();
3704 }
Bram Moolenaar7d7ad7b2022-09-01 16:00:53 +01003705#ifdef HAS_MESSAGE_WINDOW
3706 else if (iptr->isn_type == ISN_ECHOWINDOW)
3707 {
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01003708 start_echowindow(
3709 iptr->isn_arg.echowin.ewin_time);
Bram Moolenaar7d7ad7b2022-09-01 16:00:53 +01003710 msg_attr(ga.ga_data, echo_attr);
3711 end_echowindow();
3712 }
3713#endif
Bram Moolenaar7de62622021-08-07 15:05:47 +02003714 else if (iptr->isn_type == ISN_ECHOCONSOLE)
3715 {
3716 ui_write(ga.ga_data, (int)STRLEN(ga.ga_data),
3717 TRUE);
3718 ui_write((char_u *)"\r\n", 2, TRUE);
3719 }
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +02003720 else
3721 {
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +02003722 SOURCING_LNUM = iptr->isn_lnum;
3723 emsg(ga.ga_data);
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +02003724 }
3725 }
3726 }
Bram Moolenaarad39c092020-02-26 18:23:43 +01003727 ga_clear(&ga);
3728 }
3729 break;
3730
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003731 // load local variable or argument
3732 case ISN_LOAD:
Bram Moolenaar35578162021-08-02 19:10:38 +02003733 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003734 goto theend;
Bram Moolenaar2ed57ac2023-04-01 22:05:38 +01003735 tv = STACK_TV_VAR(iptr->isn_arg.number);
3736 if (tv->v_type == VAR_UNKNOWN)
3737 {
3738 // missing argument or default value v:none
3739 STACK_TV_BOT(0)->v_type = VAR_SPECIAL;
3740 STACK_TV_BOT(0)->vval.v_number = VVAL_NONE;
3741 }
3742 else
3743 copy_tv(tv, STACK_TV_BOT(0));
Bram Moolenaar4c137212021-04-19 16:48:48 +02003744 ++ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003745 break;
3746
3747 // load v: variable
3748 case ISN_LOADV:
Bram Moolenaar35578162021-08-02 19:10:38 +02003749 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003750 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003751 copy_tv(get_vim_var_tv(iptr->isn_arg.number), STACK_TV_BOT(0));
Bram Moolenaar4c137212021-04-19 16:48:48 +02003752 ++ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003753 break;
3754
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01003755 // load s: variable in Vim9 script
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003756 case ISN_LOADSCRIPT:
3757 {
Bram Moolenaar4aab88d2020-12-24 21:56:41 +01003758 scriptref_T *sref = iptr->isn_arg.script.scriptref;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003759 svar_T *sv;
3760
Bram Moolenaar6db660b2021-08-01 14:08:54 +02003761 sv = get_script_svar(sref, ectx->ec_dfunc_idx);
Bram Moolenaar07a65d22020-12-26 20:09:15 +01003762 if (sv == NULL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003763 goto theend;
Bram Moolenaar859cc212022-03-28 15:22:35 +01003764 allocate_if_null(sv);
Bram Moolenaar35578162021-08-02 19:10:38 +02003765 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003766 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003767 copy_tv(sv->sv_tv, STACK_TV_BOT(0));
Bram Moolenaar4c137212021-04-19 16:48:48 +02003768 ++ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003769 }
3770 break;
3771
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003772 // load s: variable in old script or autoload import
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003773 case ISN_LOADS:
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003774 case ISN_LOADEXPORT:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003775 {
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003776 int sid = iptr->isn_arg.loadstore.ls_sid;
3777 hashtab_T *ht = &SCRIPT_VARS(sid);
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01003778 char_u *name = iptr->isn_arg.loadstore.ls_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003779 dictitem_T *di = find_var_in_ht(ht, 0, name, TRUE);
Bram Moolenaar0bbf7222020-02-19 22:31:48 +01003780
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003781 if (di == NULL)
3782 {
Bram Moolenaar7517ffd2020-08-14 18:35:07 +02003783 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar451c2e32020-08-15 16:33:28 +02003784 semsg(_(e_undefined_variable_str), name);
Bram Moolenaarf0b9f432020-07-17 23:03:17 +02003785 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003786 }
3787 else
3788 {
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003789 if (iptr->isn_type == ISN_LOADEXPORT)
3790 {
3791 int idx = get_script_item_idx(sid, name, 0,
3792 NULL, NULL);
3793 svar_T *sv;
3794
3795 if (idx >= 0)
3796 {
3797 sv = ((svar_T *)SCRIPT_ITEM(sid)
3798 ->sn_var_vals.ga_data) + idx;
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003799 if ((sv->sv_flags & SVFLAG_EXPORTED) == 0)
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003800 {
3801 SOURCING_LNUM = iptr->isn_lnum;
3802 semsg(_(e_item_not_exported_in_script_str),
3803 name);
3804 goto on_error;
3805 }
3806 }
3807 }
Bram Moolenaar35578162021-08-02 19:10:38 +02003808 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003809 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003810 copy_tv(&di->di_tv, STACK_TV_BOT(0));
Bram Moolenaar4c137212021-04-19 16:48:48 +02003811 ++ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003812 }
3813 }
3814 break;
3815
Bram Moolenaard3aac292020-04-19 14:32:17 +02003816 // load g:/b:/w:/t: variable
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003817 case ISN_LOADG:
Bram Moolenaard3aac292020-04-19 14:32:17 +02003818 case ISN_LOADB:
3819 case ISN_LOADW:
3820 case ISN_LOADT:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003821 {
Bram Moolenaar06b77222022-01-25 15:51:56 +00003822 int res = load_namespace_var(ectx, iptr->isn_type, iptr);
Bram Moolenaar2f8ce0a2020-07-19 19:47:35 +02003823
Bram Moolenaar06b77222022-01-25 15:51:56 +00003824 if (res == NOTDONE)
Bram Moolenaarcbbc48f2022-01-18 12:58:28 +00003825 goto theend;
Bram Moolenaar06b77222022-01-25 15:51:56 +00003826 if (res == FAIL)
Bram Moolenaarf0b9f432020-07-17 23:03:17 +02003827 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003828 }
Bram Moolenaar06b77222022-01-25 15:51:56 +00003829
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003830 break;
3831
Bram Moolenaar03290b82020-12-19 16:30:44 +01003832 // load autoload variable
3833 case ISN_LOADAUTO:
3834 {
3835 char_u *name = iptr->isn_arg.string;
3836
Bram Moolenaar35578162021-08-02 19:10:38 +02003837 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003838 goto theend;
Bram Moolenaar03290b82020-12-19 16:30:44 +01003839 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaard5f400c2022-01-06 21:10:28 +00003840 if (eval_variable(name, (int)STRLEN(name), 0,
Bram Moolenaarcb4e80f2021-03-13 20:57:19 +01003841 STACK_TV_BOT(0), NULL, EVAL_VAR_VERBOSE) == FAIL)
Bram Moolenaar03290b82020-12-19 16:30:44 +01003842 goto on_error;
Bram Moolenaar4c137212021-04-19 16:48:48 +02003843 ++ectx->ec_stack.ga_len;
Bram Moolenaar03290b82020-12-19 16:30:44 +01003844 }
3845 break;
3846
Bram Moolenaar2f8ce0a2020-07-19 19:47:35 +02003847 // load g:/b:/w:/t: namespace
3848 case ISN_LOADGDICT:
3849 case ISN_LOADBDICT:
3850 case ISN_LOADWDICT:
3851 case ISN_LOADTDICT:
3852 {
3853 dict_T *d = NULL;
3854
3855 switch (iptr->isn_type)
3856 {
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003857 case ISN_LOADGDICT: d = get_globvar_dict(); break;
3858 case ISN_LOADBDICT: d = curbuf->b_vars; break;
3859 case ISN_LOADWDICT: d = curwin->w_vars; break;
3860 case ISN_LOADTDICT: d = curtab->tp_vars; break;
Bram Moolenaar2f8ce0a2020-07-19 19:47:35 +02003861 default: // Cannot reach here
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003862 goto theend;
Bram Moolenaar2f8ce0a2020-07-19 19:47:35 +02003863 }
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 Moolenaar2f8ce0a2020-07-19 19:47:35 +02003866 tv = STACK_TV_BOT(0);
3867 tv->v_type = VAR_DICT;
3868 tv->v_lock = 0;
3869 tv->vval.v_dict = d;
Bram Moolenaar1bd3cb22021-02-24 12:27:31 +01003870 ++d->dv_refcount;
Bram Moolenaar4c137212021-04-19 16:48:48 +02003871 ++ectx->ec_stack.ga_len;
Bram Moolenaar2f8ce0a2020-07-19 19:47:35 +02003872 }
3873 break;
3874
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003875 // load &option
3876 case ISN_LOADOPT:
3877 {
3878 typval_T optval;
3879 char_u *name = iptr->isn_arg.string;
3880
Bram Moolenaara8c17702020-04-01 21:17:24 +02003881 // This is not expected to fail, name is checked during
3882 // compilation: don't set SOURCING_LNUM.
Bram Moolenaar35578162021-08-02 19:10:38 +02003883 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003884 goto theend;
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02003885 if (eval_option(&name, &optval, TRUE) == FAIL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003886 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003887 *STACK_TV_BOT(0) = optval;
Bram Moolenaar4c137212021-04-19 16:48:48 +02003888 ++ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003889 }
3890 break;
3891
3892 // load $ENV
3893 case ISN_LOADENV:
3894 {
3895 typval_T optval;
3896 char_u *name = iptr->isn_arg.string;
3897
Bram Moolenaar35578162021-08-02 19:10:38 +02003898 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003899 goto theend;
Bram Moolenaar0bbf7222020-02-19 22:31:48 +01003900 // name is always valid, checked when compiling
Bram Moolenaar9a78e6d2020-07-01 18:29:55 +02003901 (void)eval_env_var(&name, &optval, TRUE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003902 *STACK_TV_BOT(0) = optval;
Bram Moolenaar4c137212021-04-19 16:48:48 +02003903 ++ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003904 }
3905 break;
3906
3907 // load @register
3908 case ISN_LOADREG:
Bram Moolenaar35578162021-08-02 19:10:38 +02003909 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02003910 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003911 tv = STACK_TV_BOT(0);
3912 tv->v_type = VAR_STRING;
Bram Moolenaar2f8ce0a2020-07-19 19:47:35 +02003913 tv->v_lock = 0;
Bram Moolenaar1e021e62020-10-16 20:25:23 +02003914 // This may result in NULL, which should be equivalent to an
3915 // empty string.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003916 tv->vval.v_string = get_reg_contents(
3917 iptr->isn_arg.number, GREG_EXPR_SRC);
Bram Moolenaar4c137212021-04-19 16:48:48 +02003918 ++ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003919 break;
3920
3921 // store local variable
3922 case ISN_STORE:
Bram Moolenaar4c137212021-04-19 16:48:48 +02003923 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003924 tv = STACK_TV_VAR(iptr->isn_arg.number);
Ernie Rael9ed53752023-12-11 17:40:46 +01003925 if (check_typval_is_value(STACK_TV_BOT(0)) == FAIL)
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02003926 {
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02003927 clear_tv(STACK_TV_BOT(0));
3928 goto on_error;
3929 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003930 clear_tv(tv);
3931 *tv = *STACK_TV_BOT(0);
3932 break;
3933
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003934 // store s: variable in old script or autoload import
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01003935 case ISN_STORES:
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003936 case ISN_STOREEXPORT:
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01003937 {
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003938 int sid = iptr->isn_arg.loadstore.ls_sid;
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01003939 char_u *name = iptr->isn_arg.loadstore.ls_name;
Ernie Rael3f821d62024-04-24 20:07:50 +02003940 dictitem_T *di = NULL;
3941 // First check for a variable from an exported autoload
3942 // with an autoload_prefix; it would be in globals.
3943 if (iptr->isn_type == ISN_STOREEXPORT)
3944 di = find_var_autoload_prefix(name, sid, NULL, NULL);
3945 // Then look for a variable in the script's variables.
3946 if (di == NULL)
3947 {
3948 hashtab_T *ht = &SCRIPT_VARS(sid);
3949 di = find_var_in_ht(ht, 0, STRNCMP("s:", name, 2) == 0
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003950 ? name + 2 : name, TRUE);
Ernie Rael3f821d62024-04-24 20:07:50 +02003951 }
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01003952
Bram Moolenaar4c137212021-04-19 16:48:48 +02003953 --ectx->ec_stack.ga_len;
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003954 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar0bbf7222020-02-19 22:31:48 +01003955 if (di == NULL)
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003956 {
3957 if (iptr->isn_type == ISN_STOREEXPORT)
3958 {
3959 semsg(_(e_undefined_variable_str), name);
Bram Moolenaard1d26842022-03-31 10:13:47 +01003960 clear_tv(STACK_TV_BOT(0));
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003961 goto on_error;
3962 }
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02003963 store_var(name, STACK_TV_BOT(0));
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003964 }
Bram Moolenaar0bbf7222020-02-19 22:31:48 +01003965 else
3966 {
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003967 if (iptr->isn_type == ISN_STOREEXPORT)
3968 {
3969 int idx = get_script_item_idx(sid, name, 0,
3970 NULL, NULL);
3971
Bram Moolenaar06651632022-04-27 17:54:25 +01003972 // can this ever fail?
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003973 if (idx >= 0)
3974 {
3975 svar_T *sv = ((svar_T *)SCRIPT_ITEM(sid)
3976 ->sn_var_vals.ga_data) + idx;
3977
Bram Moolenaaraa7d0c22022-04-05 21:40:38 +01003978 if ((sv->sv_flags & SVFLAG_EXPORTED) == 0)
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003979 {
3980 semsg(_(e_item_not_exported_in_script_str),
3981 name);
Bram Moolenaard1d26842022-03-31 10:13:47 +01003982 clear_tv(STACK_TV_BOT(0));
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01003983 goto on_error;
3984 }
3985 }
3986 }
Bram Moolenaardcf29ac2021-04-02 14:44:02 +02003987 if (var_check_permission(di, name) == FAIL)
Bram Moolenaar6e50ec22021-04-03 19:32:44 +02003988 {
3989 clear_tv(STACK_TV_BOT(0));
Bram Moolenaardcf29ac2021-04-02 14:44:02 +02003990 goto on_error;
Bram Moolenaar6e50ec22021-04-03 19:32:44 +02003991 }
Bram Moolenaar0bbf7222020-02-19 22:31:48 +01003992 clear_tv(&di->di_tv);
3993 di->di_tv = *STACK_TV_BOT(0);
3994 }
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01003995 }
3996 break;
3997
3998 // store script-local variable in Vim9 script
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003999 case ISN_STORESCRIPT:
4000 {
Bram Moolenaar07a65d22020-12-26 20:09:15 +01004001 scriptref_T *sref = iptr->isn_arg.script.scriptref;
4002 svar_T *sv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004003
Bram Moolenaar6db660b2021-08-01 14:08:54 +02004004 sv = get_script_svar(sref, ectx->ec_dfunc_idx);
Bram Moolenaar07a65d22020-12-26 20:09:15 +01004005 if (sv == NULL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004006 goto theend;
Bram Moolenaar4c137212021-04-19 16:48:48 +02004007 --ectx->ec_stack.ga_len;
Bram Moolenaarf5906aa2021-04-02 14:35:15 +02004008
4009 // "const" and "final" are checked at compile time, locking
4010 // the value needs to be checked here.
4011 SOURCING_LNUM = iptr->isn_lnum;
4012 if (value_check_lock(sv->sv_tv->v_lock, sv->sv_name, FALSE))
Bram Moolenaar6e50ec22021-04-03 19:32:44 +02004013 {
4014 clear_tv(STACK_TV_BOT(0));
Bram Moolenaarf5906aa2021-04-02 14:35:15 +02004015 goto on_error;
Bram Moolenaar6e50ec22021-04-03 19:32:44 +02004016 }
Bram Moolenaarf5906aa2021-04-02 14:35:15 +02004017
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004018 clear_tv(sv->sv_tv);
4019 *sv->sv_tv = *STACK_TV_BOT(0);
4020 }
4021 break;
4022
4023 // store option
4024 case ISN_STOREOPT:
Bram Moolenaardcb53be2021-12-09 14:23:43 +00004025 case ISN_STOREFUNCOPT:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004026 {
Bram Moolenaardcb53be2021-12-09 14:23:43 +00004027 char_u *opt_name = iptr->isn_arg.storeopt.so_name;
4028 int opt_flags = iptr->isn_arg.storeopt.so_flags;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004029 long n = 0;
4030 char_u *s = NULL;
4031 char *msg;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00004032 char_u numbuf[NUMBUFLEN];
4033 char_u *tofree = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004034
Bram Moolenaar4c137212021-04-19 16:48:48 +02004035 --ectx->ec_stack.ga_len;
LemonBoy32f34612023-09-02 21:52:05 +02004036 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004037 tv = STACK_TV_BOT(0);
4038 if (tv->v_type == VAR_STRING)
Bram Moolenaar97a2af32020-01-28 22:52:48 +01004039 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004040 s = tv->vval.v_string;
Bram Moolenaar97a2af32020-01-28 22:52:48 +01004041 if (s == NULL)
4042 s = (char_u *)"";
4043 }
Bram Moolenaardcb53be2021-12-09 14:23:43 +00004044 else if (iptr->isn_type == ISN_STOREFUNCOPT)
4045 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00004046 // If the option can be set to a function reference or
4047 // a lambda and the passed value is a function
4048 // reference, then convert it to the name (string) of
4049 // the function reference.
4050 s = tv2string(tv, &tofree, numbuf, 0);
4051 if (s == NULL || *s == NUL)
Bram Moolenaardcb53be2021-12-09 14:23:43 +00004052 {
Bram Moolenaar397a87a2022-03-20 21:14:15 +00004053 // cannot happen?
Bram Moolenaardcb53be2021-12-09 14:23:43 +00004054 clear_tv(tv);
Bram Moolenaar397a87a2022-03-20 21:14:15 +00004055 vim_free(tofree);
Bram Moolenaardcb53be2021-12-09 14:23:43 +00004056 goto on_error;
4057 }
Bram Moolenaardcb53be2021-12-09 14:23:43 +00004058 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004059 else
Bram Moolenaara6e67e42020-05-15 23:36:40 +02004060 // must be VAR_NUMBER, CHECKTYPE makes sure
4061 n = tv->vval.v_number;
Bram Moolenaardcb53be2021-12-09 14:23:43 +00004062 msg = set_option_value(opt_name, n, s, opt_flags);
Bram Moolenaare75ba262020-05-16 15:43:31 +02004063 clear_tv(tv);
Bram Moolenaar2ef91562021-12-11 16:14:07 +00004064 vim_free(tofree);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004065 if (msg != NULL)
4066 {
Bram Moolenaar7517ffd2020-08-14 18:35:07 +02004067 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004068 emsg(_(msg));
Bram Moolenaare8593122020-07-18 15:17:02 +02004069 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004070 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004071 }
4072 break;
4073
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01004074 // store $ENV
4075 case ISN_STOREENV:
Bram Moolenaar4c137212021-04-19 16:48:48 +02004076 --ectx->ec_stack.ga_len;
Bram Moolenaar20431c92020-03-20 18:39:46 +01004077 tv = STACK_TV_BOT(0);
4078 vim_setenv_ext(iptr->isn_arg.string, tv_get_string(tv));
4079 clear_tv(tv);
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01004080 break;
4081
4082 // store @r
4083 case ISN_STOREREG:
4084 {
4085 int reg = iptr->isn_arg.number;
4086
Bram Moolenaar4c137212021-04-19 16:48:48 +02004087 --ectx->ec_stack.ga_len;
Bram Moolenaar401d9ff2020-02-19 18:14:44 +01004088 tv = STACK_TV_BOT(0);
Bram Moolenaar74f4a962021-06-17 21:03:07 +02004089 write_reg_contents(reg, tv_get_string(tv), -1, FALSE);
Bram Moolenaar401d9ff2020-02-19 18:14:44 +01004090 clear_tv(tv);
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01004091 }
4092 break;
4093
4094 // store v: variable
4095 case ISN_STOREV:
Bram Moolenaar4c137212021-04-19 16:48:48 +02004096 --ectx->ec_stack.ga_len;
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01004097 if (set_vim_var_tv(iptr->isn_arg.number, STACK_TV_BOT(0))
4098 == FAIL)
Bram Moolenaare8593122020-07-18 15:17:02 +02004099 // should not happen, type is checked when compiling
4100 goto on_error;
Bram Moolenaarb283a8a2020-02-02 22:24:04 +01004101 break;
4102
Bram Moolenaard3aac292020-04-19 14:32:17 +02004103 // store g:/b:/w:/t: variable
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004104 case ISN_STOREG:
Bram Moolenaard3aac292020-04-19 14:32:17 +02004105 case ISN_STOREB:
4106 case ISN_STOREW:
4107 case ISN_STORET:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004108 {
Bram Moolenaar3bdc90b2020-12-22 20:35:40 +01004109 dictitem_T *di;
4110 hashtab_T *ht;
4111 char_u *name = iptr->isn_arg.string + 2;
4112
Bram Moolenaard3aac292020-04-19 14:32:17 +02004113 switch (iptr->isn_type)
4114 {
4115 case ISN_STOREG:
4116 ht = get_globvar_ht();
4117 break;
4118 case ISN_STOREB:
4119 ht = &curbuf->b_vars->dv_hashtab;
4120 break;
4121 case ISN_STOREW:
4122 ht = &curwin->w_vars->dv_hashtab;
4123 break;
4124 case ISN_STORET:
4125 ht = &curtab->tp_vars->dv_hashtab;
4126 break;
4127 default: // Cannot reach here
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004128 goto theend;
Bram Moolenaard3aac292020-04-19 14:32:17 +02004129 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004130
Bram Moolenaar4c137212021-04-19 16:48:48 +02004131 --ectx->ec_stack.ga_len;
Bram Moolenaar3bdc90b2020-12-22 20:35:40 +01004132 di = find_var_in_ht(ht, 0, name, TRUE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004133 if (di == NULL)
Bram Moolenaar0bbf7222020-02-19 22:31:48 +01004134 store_var(iptr->isn_arg.string, STACK_TV_BOT(0));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004135 else
4136 {
Bram Moolenaar3bdc90b2020-12-22 20:35:40 +01004137 SOURCING_LNUM = iptr->isn_lnum;
4138 if (var_check_permission(di, name) == FAIL)
4139 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004140 clear_tv(&di->di_tv);
4141 di->di_tv = *STACK_TV_BOT(0);
4142 }
4143 }
4144 break;
4145
Bram Moolenaar03290b82020-12-19 16:30:44 +01004146 // store an autoload variable
4147 case ISN_STOREAUTO:
4148 SOURCING_LNUM = iptr->isn_lnum;
4149 set_var(iptr->isn_arg.string, STACK_TV_BOT(-1), TRUE);
4150 clear_tv(STACK_TV_BOT(-1));
Bram Moolenaar4c137212021-04-19 16:48:48 +02004151 --ectx->ec_stack.ga_len;
Bram Moolenaar03290b82020-12-19 16:30:44 +01004152 break;
4153
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004154 // store number in local variable
4155 case ISN_STORENR:
Bram Moolenaara471eea2020-03-04 22:20:26 +01004156 tv = STACK_TV_VAR(iptr->isn_arg.storenr.stnr_idx);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004157 clear_tv(tv);
4158 tv->v_type = VAR_NUMBER;
Bram Moolenaara471eea2020-03-04 22:20:26 +01004159 tv->vval.v_number = iptr->isn_arg.storenr.stnr_val;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004160 break;
4161
Bram Moolenaar590162c2022-12-24 21:24:06 +00004162 // Store a value in a list, dict, blob or object variable.
Bram Moolenaar4f5e3972020-12-21 17:30:50 +01004163 case ISN_STOREINDEX:
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02004164 {
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00004165 int res = execute_storeindex(iptr, ectx);
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02004166
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00004167 if (res == FAIL)
Bram Moolenaar8e4c8c82020-08-01 15:38:38 +02004168 goto on_error;
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00004169 if (res == NOTDONE)
4170 goto theend;
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02004171 }
4172 break;
4173
Bram Moolenaarea5c8982022-02-17 14:42:02 +00004174 // store value in list or blob range
Bram Moolenaar68452172021-04-12 21:21:02 +02004175 case ISN_STORERANGE:
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00004176 if (execute_storerange(iptr, ectx) == FAIL)
4177 goto on_error;
Bram Moolenaar68452172021-04-12 21:21:02 +02004178 break;
4179
Bram Moolenaard505d172022-12-18 21:42:55 +00004180 case ISN_LOAD_CLASSMEMBER:
4181 {
4182 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
4183 goto theend;
4184 classmember_T *cm = &iptr->isn_arg.classmember;
Bram Moolenaar4e2406c2023-06-24 19:22:21 +01004185 copy_tv(cm->cm_class->class_members_tv + cm->cm_idx,
4186 STACK_TV_BOT(0));
Bram Moolenaard505d172022-12-18 21:42:55 +00004187 ++ectx->ec_stack.ga_len;
4188 }
4189 break;
4190
4191 case ISN_STORE_CLASSMEMBER:
4192 {
4193 classmember_T *cm = &iptr->isn_arg.classmember;
4194 tv = &cm->cm_class->class_members_tv[cm->cm_idx];
4195 clear_tv(tv);
4196 *tv = *STACK_TV_BOT(-1);
4197 --ectx->ec_stack.ga_len;
4198 }
4199 break;
4200
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01004201 // Load or store variable or argument from outer scope.
Bram Moolenaar0186e582021-01-10 18:33:11 +01004202 case ISN_LOADOUTER:
4203 case ISN_STOREOUTER:
4204 {
4205 int depth = iptr->isn_arg.outer.outer_depth;
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02004206 outer_T *outer = ectx->ec_outer_ref == NULL ? NULL
4207 : ectx->ec_outer_ref->or_outer;
Bram Moolenaar0186e582021-01-10 18:33:11 +01004208
4209 while (depth > 1 && outer != NULL)
4210 {
4211 outer = outer->out_up;
4212 --depth;
4213 }
4214 if (outer == NULL)
4215 {
4216 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar69c76172021-12-02 16:38:52 +00004217 if (ectx->ec_frame_idx == ectx->ec_initial_frame_idx
4218 || ectx->ec_outer_ref == NULL)
4219 // Possibly :def function called from legacy
4220 // context.
4221 emsg(_(e_closure_called_from_invalid_context));
4222 else
4223 iemsg("LOADOUTER depth more than scope levels");
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004224 goto theend;
Bram Moolenaar0186e582021-01-10 18:33:11 +01004225 }
Bram Moolenaarcc341812022-09-19 15:54:34 +01004226 if (depth < 0)
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01004227 // Variable declared in loop. May be copied if the
4228 // loop block has already ended.
Bram Moolenaarcc341812022-09-19 15:54:34 +01004229 tv = ((typval_T *)outer->out_loop[-depth - 1]
4230 .stack->ga_data)
4231 + outer->out_loop[-depth - 1].var_idx
4232 + iptr->isn_arg.outer.outer_idx;
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01004233 else
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01004234 // Variable declared in a function. May be copied if
4235 // the function has already returned.
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01004236 tv = ((typval_T *)outer->out_stack->ga_data)
4237 + outer->out_frame_idx + STACK_FRAME_SIZE
4238 + iptr->isn_arg.outer.outer_idx;
Bram Moolenaar0186e582021-01-10 18:33:11 +01004239 if (iptr->isn_type == ISN_LOADOUTER)
4240 {
Christian Brabandt5dd41d42023-12-04 22:52:23 +01004241 typval_T *copy;
Bram Moolenaar35578162021-08-02 19:10:38 +02004242 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004243 goto theend;
Christian Brabandt5dd41d42023-12-04 22:52:23 +01004244 // careful: ga_grow_inner may re-alloc the stack
4245 if (depth < 0)
4246 copy = ((typval_T *)outer->out_loop[-depth - 1]
4247 .stack->ga_data)
4248 + outer->out_loop[-depth - 1].var_idx
4249 + iptr->isn_arg.outer.outer_idx;
4250 else
4251 copy = ((typval_T *)outer->out_stack->ga_data)
4252 + outer->out_frame_idx + STACK_FRAME_SIZE
4253 + iptr->isn_arg.outer.outer_idx;
4254 // memory was freed, get tv again
4255 if (copy != tv)
4256 tv = copy;
Bram Moolenaar0186e582021-01-10 18:33:11 +01004257 copy_tv(tv, STACK_TV_BOT(0));
Bram Moolenaar4c137212021-04-19 16:48:48 +02004258 ++ectx->ec_stack.ga_len;
Bram Moolenaar0186e582021-01-10 18:33:11 +01004259 }
4260 else
4261 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02004262 --ectx->ec_stack.ga_len;
Bram Moolenaar0186e582021-01-10 18:33:11 +01004263 clear_tv(tv);
4264 *tv = *STACK_TV_BOT(0);
4265 }
4266 }
4267 break;
4268
Bram Moolenaar752fc692021-01-04 21:57:11 +01004269 // unlet item in list or dict variable
4270 case ISN_UNLETINDEX:
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00004271 if (execute_unletindex(iptr, ectx) == FAIL)
4272 goto on_error;
Bram Moolenaar752fc692021-01-04 21:57:11 +01004273 break;
4274
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01004275 // unlet range of items in list variable
4276 case ISN_UNLETRANGE:
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00004277 if (execute_unletrange(iptr, ectx) == FAIL)
4278 goto on_error;
Bram Moolenaar5b5ae292021-02-20 17:04:02 +01004279 break;
4280
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004281 // push constant
4282 case ISN_PUSHNR:
4283 case ISN_PUSHBOOL:
4284 case ISN_PUSHSPEC:
4285 case ISN_PUSHF:
4286 case ISN_PUSHS:
4287 case ISN_PUSHBLOB:
Bram Moolenaar42a480b2020-02-29 23:23:47 +01004288 case ISN_PUSHFUNC:
Bram Moolenaar42a480b2020-02-29 23:23:47 +01004289 case ISN_PUSHCHANNEL:
4290 case ISN_PUSHJOB:
Bram Moolenaarc4e1b862023-02-26 18:58:23 +00004291 case ISN_PUSHOBJ:
4292 case ISN_PUSHCLASS:
Bram Moolenaar35578162021-08-02 19:10:38 +02004293 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004294 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004295 tv = STACK_TV_BOT(0);
Bram Moolenaar2f8ce0a2020-07-19 19:47:35 +02004296 tv->v_lock = 0;
Bram Moolenaar4c137212021-04-19 16:48:48 +02004297 ++ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004298 switch (iptr->isn_type)
4299 {
4300 case ISN_PUSHNR:
4301 tv->v_type = VAR_NUMBER;
4302 tv->vval.v_number = iptr->isn_arg.number;
4303 break;
4304 case ISN_PUSHBOOL:
4305 tv->v_type = VAR_BOOL;
4306 tv->vval.v_number = iptr->isn_arg.number;
4307 break;
4308 case ISN_PUSHSPEC:
4309 tv->v_type = VAR_SPECIAL;
4310 tv->vval.v_number = iptr->isn_arg.number;
4311 break;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004312 case ISN_PUSHF:
4313 tv->v_type = VAR_FLOAT;
4314 tv->vval.v_float = iptr->isn_arg.fnumber;
4315 break;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004316 case ISN_PUSHBLOB:
4317 blob_copy(iptr->isn_arg.blob, tv);
4318 break;
Bram Moolenaar42a480b2020-02-29 23:23:47 +01004319 case ISN_PUSHFUNC:
4320 tv->v_type = VAR_FUNC;
Bram Moolenaar087d2e12020-03-01 15:36:42 +01004321 if (iptr->isn_arg.string == NULL)
4322 tv->vval.v_string = NULL;
4323 else
4324 tv->vval.v_string =
4325 vim_strsave(iptr->isn_arg.string);
Bram Moolenaar42a480b2020-02-29 23:23:47 +01004326 break;
Bram Moolenaar42a480b2020-02-29 23:23:47 +01004327 case ISN_PUSHCHANNEL:
4328#ifdef FEAT_JOB_CHANNEL
4329 tv->v_type = VAR_CHANNEL;
Bram Moolenaar397a87a2022-03-20 21:14:15 +00004330 tv->vval.v_channel = NULL;
Bram Moolenaar42a480b2020-02-29 23:23:47 +01004331#endif
4332 break;
4333 case ISN_PUSHJOB:
4334#ifdef FEAT_JOB_CHANNEL
4335 tv->v_type = VAR_JOB;
Bram Moolenaar397a87a2022-03-20 21:14:15 +00004336 tv->vval.v_job = NULL;
Bram Moolenaar42a480b2020-02-29 23:23:47 +01004337#endif
4338 break;
Bram Moolenaarc4e1b862023-02-26 18:58:23 +00004339 case ISN_PUSHOBJ:
4340 tv->v_type = VAR_OBJECT;
4341 tv->vval.v_object = NULL;
4342 break;
4343 case ISN_PUSHCLASS:
4344 tv->v_type = VAR_CLASS;
Bram Moolenaar30a84472023-02-27 08:07:14 +00004345 tv->vval.v_class = iptr->isn_arg.classarg;
Bram Moolenaarc4e1b862023-02-26 18:58:23 +00004346 break;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004347 default:
4348 tv->v_type = VAR_STRING;
Bram Moolenaarf8691002022-03-10 12:20:53 +00004349 tv->vval.v_string = iptr->isn_arg.string == NULL
4350 ? NULL : vim_strsave(iptr->isn_arg.string);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004351 }
4352 break;
4353
Bram Moolenaar06b77222022-01-25 15:51:56 +00004354 case ISN_AUTOLOAD:
4355 {
4356 char_u *name = iptr->isn_arg.string;
4357
4358 (void)script_autoload(name, FALSE);
4359 if (find_func(name, TRUE))
4360 {
4361 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
4362 goto theend;
4363 tv = STACK_TV_BOT(0);
4364 tv->v_lock = 0;
4365 ++ectx->ec_stack.ga_len;
4366 tv->v_type = VAR_FUNC;
4367 tv->vval.v_string = vim_strsave(name);
4368 }
4369 else
4370 {
4371 int res = load_namespace_var(ectx, ISN_LOADG, iptr);
4372
4373 if (res == NOTDONE)
4374 goto theend;
4375 if (res == FAIL)
4376 goto on_error;
4377 }
4378 }
4379 break;
4380
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02004381 case ISN_UNLET:
4382 if (do_unlet(iptr->isn_arg.unlet.ul_name,
4383 iptr->isn_arg.unlet.ul_forceit) == FAIL)
Bram Moolenaare8593122020-07-18 15:17:02 +02004384 goto on_error;
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02004385 break;
Bram Moolenaar7bdaea62020-04-19 18:27:26 +02004386 case ISN_UNLETENV:
LemonBoy77142312022-04-15 20:50:46 +01004387 vim_unsetenv_ext(iptr->isn_arg.unlet.ul_name);
Bram Moolenaar7bdaea62020-04-19 18:27:26 +02004388 break;
Bram Moolenaard72c1bf2020-04-19 16:28:59 +02004389
Bram Moolenaaraacc9662021-08-13 19:40:51 +02004390 case ISN_LOCKUNLOCK:
4391 {
Ernie Raelee865f32023-09-29 19:53:55 +02004392#ifdef LOG_LOCKVAR
4393 ch_log(NULL, "LKVAR: execute INS_LOCKUNLOCK isn_arg %s",
4394 iptr->isn_arg.string);
4395#endif
Ernie Rael4c8da022023-10-11 21:35:11 +02004396 lval_root_T *lval_root_save = lval_root;
Bram Moolenaaraacc9662021-08-13 19:40:51 +02004397
4398 // Stack has the local variable, argument the whole :lock
4399 // or :unlock command, like ISN_EXEC.
4400 --ectx->ec_stack.ga_len;
Ernie Rael4c8da022023-10-11 21:35:11 +02004401 lval_root_T root = { .lr_tv = STACK_TV_BOT(0),
4402 .lr_cl_exec = iptr->isn_arg.lockunlock.lu_cl_exec,
4403 .lr_is_arg = iptr->isn_arg.lockunlock.lu_is_arg };
Ernie Rael64885642023-10-04 20:16:22 +02004404 lval_root = &root;
Ernie Rael4c8da022023-10-11 21:35:11 +02004405 int res = exec_command(iptr,
Ernie Rael64885642023-10-04 20:16:22 +02004406 iptr->isn_arg.lockunlock.lu_string);
4407 clear_tv(root.lr_tv);
Bram Moolenaaraacc9662021-08-13 19:40:51 +02004408 lval_root = lval_root_save;
4409 if (res == FAIL)
4410 goto on_error;
4411 }
4412 break;
4413
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +02004414 case ISN_LOCKCONST:
4415 item_lock(STACK_TV_BOT(-1), 100, TRUE, TRUE);
4416 break;
4417
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004418 // create a list from items on the stack; uses a single allocation
4419 // for the list header and the items
4420 case ISN_NEWLIST:
Bram Moolenaar4c137212021-04-19 16:48:48 +02004421 if (exe_newlist(iptr->isn_arg.number, ectx) == FAIL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004422 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004423 break;
4424
4425 // create a dict from items on the stack
4426 case ISN_NEWDICT:
4427 {
Bram Moolenaarec15b1c2022-03-27 16:29:53 +01004428 int res;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004429
Bram Moolenaarec15b1c2022-03-27 16:29:53 +01004430 SOURCING_LNUM = iptr->isn_lnum;
4431 res = exe_newdict(iptr->isn_arg.number, ectx);
4432 if (res == FAIL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004433 goto theend;
Bram Moolenaarec15b1c2022-03-27 16:29:53 +01004434 if (res == MAYBE)
4435 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004436 }
4437 break;
4438
LemonBoy372bcce2022-04-25 12:43:20 +01004439 case ISN_CONCAT:
4440 if (exe_concat(iptr->isn_arg.number, ectx) == FAIL)
4441 goto theend;
4442 break;
4443
Bram Moolenaar8acb9cc2022-03-08 13:18:55 +00004444 // create a partial with NULL value
4445 case ISN_NEWPARTIAL:
4446 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
4447 goto theend;
4448 ++ectx->ec_stack.ga_len;
4449 tv = STACK_TV_BOT(-1);
4450 tv->v_type = VAR_PARTIAL;
4451 tv->v_lock = 0;
4452 tv->vval.v_partial = NULL;
4453 break;
4454
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004455 // call a :def function
4456 case ISN_DCALL:
Bram Moolenaardfa3d552020-09-10 22:05:08 +02004457 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar2fecb532021-03-24 22:00:56 +01004458 if (call_dfunc(iptr->isn_arg.dfunc.cdf_idx,
4459 NULL,
4460 iptr->isn_arg.dfunc.cdf_argcount,
Bram Moolenaar4c137212021-04-19 16:48:48 +02004461 ectx) == FAIL)
Bram Moolenaare8593122020-07-18 15:17:02 +02004462 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004463 break;
4464
Bram Moolenaard0200c82023-01-28 15:19:40 +00004465 // call a method on an interface
4466 case ISN_METHODCALL:
4467 {
Bram Moolenaar094cf9f2023-02-10 15:52:25 +00004468 cmfunc_T *mfunc = iptr->isn_arg.mfunc;
4469
Bram Moolenaard0200c82023-01-28 15:19:40 +00004470 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar094cf9f2023-02-10 15:52:25 +00004471 tv = STACK_TV_BOT(-1 - mfunc->cmf_argcount);
Bram Moolenaard0200c82023-01-28 15:19:40 +00004472 if (tv->v_type != VAR_OBJECT)
4473 {
4474 object_required_error(tv);
4475 goto on_error;
4476 }
Ernie Raelbe828252024-07-26 18:37:02 +02004477
Bram Moolenaard0200c82023-01-28 15:19:40 +00004478 object_T *obj = tv->vval.v_object;
Ernie Raelbe828252024-07-26 18:37:02 +02004479 if (obj == NULL)
4480 {
4481 emsg(_(e_using_null_object));
4482 goto on_error;
4483 }
4484
Ernie Rael58c95792024-08-13 23:27:22 +02004485 ufunc_T *ufunc;
4486 if (mfunc->cmf_is_super)
4487 // Doing "super.Func", use the specific ufunc.
4488 ufunc = mfunc->cmf_itf->class_obj_methods[
4489 mfunc->cmf_idx];
4490 else
4491 {
4492 class_T *cl = obj->obj_class;
Bram Moolenaard0200c82023-01-28 15:19:40 +00004493
Ernie Rael58c95792024-08-13 23:27:22 +02004494 // convert the interface index to the object index
4495 int idx = object_index_from_itf_index(mfunc->cmf_itf,
4496 TRUE, mfunc->cmf_idx, cl);
4497 ufunc = cl->class_obj_methods[idx];
4498 }
Bram Moolenaard0200c82023-01-28 15:19:40 +00004499
Ernie Rael58c95792024-08-13 23:27:22 +02004500 if (call_ufunc(ufunc, NULL, mfunc->cmf_argcount, ectx,
4501 NULL, NULL) == FAIL)
Bram Moolenaard0200c82023-01-28 15:19:40 +00004502 goto on_error;
4503 }
4504 break;
4505
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004506 // call a builtin function
4507 case ISN_BCALL:
4508 SOURCING_LNUM = iptr->isn_lnum;
4509 if (call_bfunc(iptr->isn_arg.bfunc.cbf_idx,
4510 iptr->isn_arg.bfunc.cbf_argcount,
Bram Moolenaar4c137212021-04-19 16:48:48 +02004511 ectx) == FAIL)
Bram Moolenaard032f342020-07-18 18:13:02 +02004512 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004513 break;
4514
4515 // call a funcref or partial
4516 case ISN_PCALL:
4517 {
4518 cpfunc_T *pfunc = &iptr->isn_arg.pfunc;
4519 int r;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02004520 typval_T partial_tv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004521
4522 SOURCING_LNUM = iptr->isn_lnum;
4523 if (pfunc->cpf_top)
4524 {
4525 // funcref is above the arguments
4526 tv = STACK_TV_BOT(-pfunc->cpf_argcount - 1);
4527 }
4528 else
4529 {
4530 // Get the funcref from the stack.
Bram Moolenaar4c137212021-04-19 16:48:48 +02004531 --ectx->ec_stack.ga_len;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02004532 partial_tv = *STACK_TV_BOT(0);
4533 tv = &partial_tv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004534 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02004535 r = call_partial(tv, pfunc->cpf_argcount, ectx);
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02004536 if (tv == &partial_tv)
4537 clear_tv(&partial_tv);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004538 if (r == FAIL)
Bram Moolenaard032f342020-07-18 18:13:02 +02004539 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004540 }
4541 break;
4542
Bram Moolenaarbd5da372020-03-31 23:13:10 +02004543 case ISN_PCALL_END:
4544 // PCALL finished, arguments have been consumed and replaced by
4545 // the return value. Now clear the funcref from the stack,
4546 // and move the return value in its place.
Bram Moolenaar4c137212021-04-19 16:48:48 +02004547 --ectx->ec_stack.ga_len;
Bram Moolenaarbd5da372020-03-31 23:13:10 +02004548 clear_tv(STACK_TV_BOT(-1));
4549 *STACK_TV_BOT(-1) = *STACK_TV_BOT(0);
4550 break;
4551
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004552 // call a user defined function or funcref/partial
4553 case ISN_UCALL:
4554 {
4555 cufunc_T *cufunc = &iptr->isn_arg.ufunc;
4556
4557 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar2fecb532021-03-24 22:00:56 +01004558 if (call_eval_func(cufunc->cuf_name, cufunc->cuf_argcount,
Bram Moolenaar4c137212021-04-19 16:48:48 +02004559 ectx, iptr) == FAIL)
Bram Moolenaard032f342020-07-18 18:13:02 +02004560 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004561 }
4562 break;
4563
Bram Moolenaar1d84f762022-09-03 21:35:53 +01004564 // :defer func(arg)
4565 case ISN_DEFER:
Bram Moolenaar806a2732022-09-04 15:40:36 +01004566 if (defer_command(iptr->isn_arg.defer.defer_var_idx,
Bram Moolenaar1d84f762022-09-03 21:35:53 +01004567 iptr->isn_arg.defer.defer_argcount, ectx) == FAIL)
4568 goto on_error;
4569 break;
4570
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004571 // Return from a :def function call without a value.
4572 // Return from a constructor.
Bram Moolenaarf57b43c2021-06-15 22:13:27 +02004573 case ISN_RETURN_VOID:
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004574 case ISN_RETURN_OBJECT:
Bram Moolenaar35578162021-08-02 19:10:38 +02004575 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004576 goto theend;
Bram Moolenaar299f3032021-01-08 20:53:09 +01004577 tv = STACK_TV_BOT(0);
Bram Moolenaar4c137212021-04-19 16:48:48 +02004578 ++ectx->ec_stack.ga_len;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004579 if (iptr->isn_type == ISN_RETURN_VOID)
4580 {
4581 tv->v_type = VAR_VOID;
4582 tv->vval.v_number = 0;
4583 tv->v_lock = 0;
4584 }
4585 else
4586 {
4587 *tv = *STACK_TV_VAR(0);
Yegappan Lakshmanane5437c52023-12-16 14:11:19 +01004588 object_T *obj = tv->vval.v_object;
4589 ++obj->obj_refcount;
4590
4591 // Lock all the constant object variables
4592 obj_lock_const_vars(obj);
Bram Moolenaar00b28d62022-12-08 15:32:33 +00004593 }
Bram Moolenaar299f3032021-01-08 20:53:09 +01004594 // FALLTHROUGH
4595
Bram Moolenaarf57b43c2021-06-15 22:13:27 +02004596 // return from a :def function call with what is on the stack
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004597 case ISN_RETURN:
4598 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02004599 garray_T *trystack = &ectx->ec_trystack;
Bram Moolenaar20431c92020-03-20 18:39:46 +01004600 trycmd_T *trycmd = NULL;
Bram Moolenaar8cbd6df2020-01-28 22:59:45 +01004601
Ernie Raelb077b582023-12-14 20:11:44 +01004602 ///////////////////////////////////////////////////
4603 // TODO: If FAIL, line number in output not correct
4604 ///////////////////////////////////////////////////
4605 if (check_typval_is_value(STACK_TV_BOT(-1)) == FAIL)
4606 goto theend;
4607
Bram Moolenaar8cbd6df2020-01-28 22:59:45 +01004608 if (trystack->ga_len > 0)
4609 trycmd = ((trycmd_T *)trystack->ga_data)
4610 + trystack->ga_len - 1;
Bram Moolenaarbf67ea12020-05-02 17:52:42 +02004611 if (trycmd != NULL
Bram Moolenaar4c137212021-04-19 16:48:48 +02004612 && trycmd->tcd_frame_idx == ectx->ec_frame_idx)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004613 {
Bram Moolenaar9cb577a2021-02-22 22:45:10 +01004614 // jump to ":finally" or ":endtry"
4615 if (trycmd->tcd_finally_idx != 0)
Bram Moolenaar4c137212021-04-19 16:48:48 +02004616 ectx->ec_iidx = trycmd->tcd_finally_idx;
Bram Moolenaar9cb577a2021-02-22 22:45:10 +01004617 else
Bram Moolenaar4c137212021-04-19 16:48:48 +02004618 ectx->ec_iidx = trycmd->tcd_endtry_idx;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004619 trycmd->tcd_return = TRUE;
4620 }
4621 else
Bram Moolenaard032f342020-07-18 18:13:02 +02004622 goto func_return;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004623 }
4624 break;
4625
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02004626 // push a partial, a reference to a compiled function
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004627 case ISN_FUNCREF:
4628 {
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01004629 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
4630 ufunc_T *ufunc;
4631 funcref_T *funcref = &iptr->isn_arg.funcref;
4632 funcref_extra_T *extra = funcref->fr_extra;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004633
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004634 if (pt == NULL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004635 goto theend;
Bram Moolenaar35578162021-08-02 19:10:38 +02004636 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarc8cd2b32020-05-01 19:29:08 +02004637 {
Bram Moolenaarbf67ea12020-05-02 17:52:42 +02004638 vim_free(pt);
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004639 goto theend;
Bram Moolenaarbf67ea12020-05-02 17:52:42 +02004640 }
Bram Moolenaar313e4722023-02-08 20:55:27 +00004641 if (extra != NULL && extra->fre_class != NULL)
4642 {
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02004643 class_T *cl;
4644 if (extra->fre_object_method)
Bram Moolenaar313e4722023-02-08 20:55:27 +00004645 {
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02004646 tv = STACK_TV_BOT(-1);
4647 if (tv->v_type != VAR_OBJECT)
4648 {
Ernie Raelbe828252024-07-26 18:37:02 +02004649 SOURCING_LNUM = iptr->isn_lnum;
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02004650 object_required_error(tv);
4651 vim_free(pt);
4652 goto on_error;
4653 }
Bram Moolenaar313e4722023-02-08 20:55:27 +00004654
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02004655 object_T *obj = tv->vval.v_object;
Ernie Raelbe828252024-07-26 18:37:02 +02004656 if (obj == NULL)
4657 {
4658 SOURCING_LNUM = iptr->isn_lnum;
4659 emsg(_(e_using_null_object));
4660 vim_free(pt);
4661 goto on_error;
4662 }
4663
Yegappan Lakshmanan29bb67f2023-10-14 11:18:50 +02004664 cl = obj->obj_class;
4665 // drop the value from the stack
4666 clear_tv(tv);
4667 --ectx->ec_stack.ga_len;
4668
4669 pt->pt_obj = obj;
4670 ++obj->obj_refcount;
4671 }
4672 else
4673 cl = extra->fre_class;
4674
4675 if (extra->fre_object_method)
4676 {
4677 // object method
4678 // convert the interface index to the object index
4679 int idx =
4680 object_index_from_itf_index(extra->fre_class,
4681 TRUE, extra->fre_method_idx, cl);
4682 ufunc = cl->class_obj_methods[idx];
4683 }
4684 else
4685 {
4686 // class method
4687 ufunc =
4688 cl->class_class_functions[extra->fre_method_idx];
4689 }
Bram Moolenaar313e4722023-02-08 20:55:27 +00004690 }
4691 else if (extra == NULL || extra->fre_func_name == NULL)
Bram Moolenaar38453522021-11-28 22:00:12 +00004692 {
4693 dfunc_T *pt_dfunc = ((dfunc_T *)def_functions.ga_data)
4694 + funcref->fr_dfunc_idx;
4695
4696 ufunc = pt_dfunc->df_ufunc;
4697 }
4698 else
Bram Moolenaar313e4722023-02-08 20:55:27 +00004699 {
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01004700 ufunc = find_func(extra->fre_func_name, FALSE);
Bram Moolenaar313e4722023-02-08 20:55:27 +00004701 }
Bram Moolenaar56acd1f2022-02-18 13:24:52 +00004702 if (ufunc == NULL)
4703 {
4704 SOURCING_LNUM = iptr->isn_lnum;
4705 iemsg("ufunc unexpectedly NULL for FUNCREF");
Christian Brabandt915f3bf2024-04-05 20:12:19 +02004706 vim_free(pt);
Bram Moolenaar56acd1f2022-02-18 13:24:52 +00004707 goto theend;
4708 }
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01004709 if (fill_partial_and_closure(pt, ufunc,
Bram Moolenaarcc341812022-09-19 15:54:34 +01004710 extra == NULL ? NULL : &extra->fre_loopvar_info,
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01004711 ectx) == FAIL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004712 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004713 tv = STACK_TV_BOT(0);
Bram Moolenaar4c137212021-04-19 16:48:48 +02004714 ++ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004715 tv->vval.v_partial = pt;
4716 tv->v_type = VAR_PARTIAL;
Bram Moolenaar2f8ce0a2020-07-19 19:47:35 +02004717 tv->v_lock = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004718 }
4719 break;
4720
Bram Moolenaar38ddf332020-07-31 22:05:04 +02004721 // Create a global function from a lambda.
4722 case ISN_NEWFUNC:
4723 {
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01004724 newfuncarg_T *arg = iptr->isn_arg.newfunc.nf_arg;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02004725
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01004726 if (copy_lambda_to_global_func(arg->nfa_lambda,
Bram Moolenaarcc341812022-09-19 15:54:34 +01004727 arg->nfa_global, &arg->nfa_loopvar_info,
4728 ectx) == FAIL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004729 goto theend;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02004730 }
4731 break;
4732
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01004733 // List functions
4734 case ISN_DEF:
4735 if (iptr->isn_arg.string == NULL)
4736 list_functions(NULL);
4737 else
4738 {
Bram Moolenaar14336722022-01-08 16:02:59 +00004739 exarg_T ea;
4740 garray_T lines_to_free;
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01004741
4742 CLEAR_FIELD(ea);
4743 ea.cmd = ea.arg = iptr->isn_arg.string;
Bram Moolenaar14336722022-01-08 16:02:59 +00004744 ga_init2(&lines_to_free, sizeof(char_u *), 50);
Bram Moolenaard4a9b7f2023-05-23 14:48:42 +01004745 SOURCING_LNUM = iptr->isn_lnum;
h-eastb895b0f2023-09-24 15:46:31 +02004746 define_function(&ea, NULL, &lines_to_free, 0, NULL, 0);
Bram Moolenaar14336722022-01-08 16:02:59 +00004747 ga_clear_strings(&lines_to_free);
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01004748 }
4749 break;
4750
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004751 // jump if a condition is met
4752 case ISN_JUMP:
4753 {
4754 jumpwhen_T when = iptr->isn_arg.jump.jump_when;
Bram Moolenaar2bb26582020-10-03 22:52:39 +02004755 int error = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004756 int jump = TRUE;
4757
4758 if (when != JUMP_ALWAYS)
4759 {
4760 tv = STACK_TV_BOT(-1);
Bram Moolenaar2bb26582020-10-03 22:52:39 +02004761 if (when == JUMP_IF_COND_FALSE
Bram Moolenaar13106602020-10-04 16:06:05 +02004762 || when == JUMP_IF_FALSE
Bram Moolenaar2bb26582020-10-03 22:52:39 +02004763 || when == JUMP_IF_COND_TRUE)
4764 {
4765 SOURCING_LNUM = iptr->isn_lnum;
4766 jump = tv_get_bool_chk(tv, &error);
4767 if (error)
4768 goto on_error;
4769 }
4770 else
4771 jump = tv2bool(tv);
Bram Moolenaarf6ced982022-04-28 12:00:49 +01004772 if (when == JUMP_IF_FALSE || when == JUMP_IF_COND_FALSE)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004773 jump = !jump;
Bram Moolenaar777770f2020-02-06 21:27:08 +01004774 if (when == JUMP_IF_FALSE || !jump)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004775 {
4776 // drop the value from the stack
4777 clear_tv(tv);
Bram Moolenaar4c137212021-04-19 16:48:48 +02004778 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004779 }
4780 }
4781 if (jump)
Bram Moolenaar4c137212021-04-19 16:48:48 +02004782 ectx->ec_iidx = iptr->isn_arg.jump.jump_where;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004783 }
4784 break;
4785
Bram Moolenaarb46c0832022-09-15 17:19:37 +01004786 // "while": jump to end if a condition is false
4787 case ISN_WHILE:
4788 {
4789 int error = FALSE;
4790 int jump = TRUE;
4791
4792 tv = STACK_TV_BOT(-1);
4793 SOURCING_LNUM = iptr->isn_lnum;
4794 jump = !tv_get_bool_chk(tv, &error);
4795 if (error)
4796 goto on_error;
4797 // drop the value from the stack
4798 clear_tv(tv);
4799 --ectx->ec_stack.ga_len;
4800 if (jump)
4801 ectx->ec_iidx = iptr->isn_arg.whileloop.while_end;
4802
Bram Moolenaar87b4e5c2022-10-01 15:32:46 +01004803 // Store the current funcref count, may be used by
Bram Moolenaarcc341812022-09-19 15:54:34 +01004804 // ISN_ENDLOOP later
Bram Moolenaarb46c0832022-09-15 17:19:37 +01004805 tv = STACK_TV_VAR(
4806 iptr->isn_arg.whileloop.while_funcref_idx);
4807 tv->vval.v_number = ectx->ec_funcrefs.ga_len;
4808 }
4809 break;
4810
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +02004811 // Jump if an argument with a default value was already set and not
4812 // v:none.
4813 case ISN_JUMP_IF_ARG_SET:
Bram Moolenaar65b0d162022-12-13 18:43:22 +00004814 case ISN_JUMP_IF_ARG_NOT_SET:
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +02004815 tv = STACK_TV_VAR(iptr->isn_arg.jumparg.jump_arg_off);
Bram Moolenaar65b0d162022-12-13 18:43:22 +00004816 int arg_set = tv->v_type != VAR_UNKNOWN
4817 && !(tv->v_type == VAR_SPECIAL
4818 && tv->vval.v_number == VVAL_NONE);
4819 if (iptr->isn_type == ISN_JUMP_IF_ARG_SET ? arg_set : !arg_set)
Bram Moolenaar4c137212021-04-19 16:48:48 +02004820 ectx->ec_iidx = iptr->isn_arg.jumparg.jump_where;
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +02004821 break;
4822
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004823 // top of a for loop
4824 case ISN_FOR:
Bram Moolenaar058ee7c2022-01-23 20:00:42 +00004825 if (execute_for(iptr, ectx) == FAIL)
4826 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004827 break;
4828
Bram Moolenaarb46c0832022-09-15 17:19:37 +01004829 // end of a for or while loop
4830 case ISN_ENDLOOP:
4831 if (execute_endloop(iptr, ectx) == FAIL)
4832 goto theend;
4833 break;
4834
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004835 // start of ":try" block
4836 case ISN_TRY:
4837 {
Bram Moolenaar20431c92020-03-20 18:39:46 +01004838 trycmd_T *trycmd = NULL;
4839
Bram Moolenaar35578162021-08-02 19:10:38 +02004840 if (GA_GROW_FAILS(&ectx->ec_trystack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004841 goto theend;
Bram Moolenaar4c137212021-04-19 16:48:48 +02004842 trycmd = ((trycmd_T *)ectx->ec_trystack.ga_data)
4843 + ectx->ec_trystack.ga_len;
4844 ++ectx->ec_trystack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004845 ++trylevel;
Bram Moolenaar8d4be892021-02-13 18:33:02 +01004846 CLEAR_POINTER(trycmd);
Bram Moolenaar4c137212021-04-19 16:48:48 +02004847 trycmd->tcd_frame_idx = ectx->ec_frame_idx;
4848 trycmd->tcd_stack_len = ectx->ec_stack.ga_len;
Bram Moolenaara91a7132021-03-25 21:12:15 +01004849 trycmd->tcd_catch_idx =
Bram Moolenaar0d807102021-12-21 09:42:09 +00004850 iptr->isn_arg.tryref.try_ref->try_catch;
Bram Moolenaara91a7132021-03-25 21:12:15 +01004851 trycmd->tcd_finally_idx =
Bram Moolenaar0d807102021-12-21 09:42:09 +00004852 iptr->isn_arg.tryref.try_ref->try_finally;
Bram Moolenaara91a7132021-03-25 21:12:15 +01004853 trycmd->tcd_endtry_idx =
Bram Moolenaar0d807102021-12-21 09:42:09 +00004854 iptr->isn_arg.tryref.try_ref->try_endtry;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004855 }
4856 break;
4857
4858 case ISN_PUSHEXC:
4859 if (current_exception == NULL)
4860 {
Bram Moolenaar7517ffd2020-08-14 18:35:07 +02004861 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004862 iemsg("Evaluating catch while current_exception is NULL");
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004863 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004864 }
Bram Moolenaar35578162021-08-02 19:10:38 +02004865 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004866 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004867 tv = STACK_TV_BOT(0);
Bram Moolenaar4c137212021-04-19 16:48:48 +02004868 ++ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004869 tv->v_type = VAR_STRING;
Bram Moolenaar2f8ce0a2020-07-19 19:47:35 +02004870 tv->v_lock = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004871 tv->vval.v_string = vim_strsave(
4872 (char_u *)current_exception->value);
4873 break;
4874
4875 case ISN_CATCH:
4876 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02004877 garray_T *trystack = &ectx->ec_trystack;
Bram Moolenaar06651632022-04-27 17:54:25 +01004878 trycmd_T *trycmd;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004879
Bram Moolenaar4c137212021-04-19 16:48:48 +02004880 may_restore_cmdmod(&ectx->ec_funclocal);
Bram Moolenaar06651632022-04-27 17:54:25 +01004881 trycmd = ((trycmd_T *)trystack->ga_data)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004882 + trystack->ga_len - 1;
Bram Moolenaar06651632022-04-27 17:54:25 +01004883 trycmd->tcd_caught = TRUE;
4884 trycmd->tcd_did_throw = FALSE;
4885
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004886 did_emsg = got_int = did_throw = FALSE;
Bram Moolenaar1430cee2021-01-17 19:20:32 +01004887 force_abort = need_rethrow = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004888 catch_exception(current_exception);
4889 }
4890 break;
4891
Bram Moolenaarc150c092021-02-13 15:02:46 +01004892 case ISN_TRYCONT:
4893 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02004894 garray_T *trystack = &ectx->ec_trystack;
Bram Moolenaarc150c092021-02-13 15:02:46 +01004895 trycont_T *trycont = &iptr->isn_arg.trycont;
4896 int i;
4897 trycmd_T *trycmd;
4898 int iidx = trycont->tct_where;
4899
4900 if (trystack->ga_len < trycont->tct_levels)
4901 {
4902 siemsg("TRYCONT: expected %d levels, found %d",
4903 trycont->tct_levels, trystack->ga_len);
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004904 goto theend;
Bram Moolenaarc150c092021-02-13 15:02:46 +01004905 }
4906 // Make :endtry jump to any outer try block and the last
4907 // :endtry inside the loop to the loop start.
4908 for (i = trycont->tct_levels; i > 0; --i)
4909 {
4910 trycmd = ((trycmd_T *)trystack->ga_data)
4911 + trystack->ga_len - i;
Bram Moolenaar2e34c342021-03-14 12:13:33 +01004912 // Add one to tcd_cont to be able to jump to
4913 // instruction with index zero.
4914 trycmd->tcd_cont = iidx + 1;
Bram Moolenaar7e82c5f2021-02-21 21:32:45 +01004915 iidx = trycmd->tcd_finally_idx == 0
4916 ? trycmd->tcd_endtry_idx : trycmd->tcd_finally_idx;
Bram Moolenaarc150c092021-02-13 15:02:46 +01004917 }
4918 // jump to :finally or :endtry of current try statement
Bram Moolenaar4c137212021-04-19 16:48:48 +02004919 ectx->ec_iidx = iidx;
Bram Moolenaarc150c092021-02-13 15:02:46 +01004920 }
4921 break;
4922
Bram Moolenaar7e82c5f2021-02-21 21:32:45 +01004923 case ISN_FINALLY:
4924 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02004925 garray_T *trystack = &ectx->ec_trystack;
Bram Moolenaar7e82c5f2021-02-21 21:32:45 +01004926 trycmd_T *trycmd = ((trycmd_T *)trystack->ga_data)
4927 + trystack->ga_len - 1;
4928
4929 // Reset the index to avoid a return statement jumps here
4930 // again.
4931 trycmd->tcd_finally_idx = 0;
4932 break;
4933 }
4934
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004935 // end of ":try" block
4936 case ISN_ENDTRY:
4937 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02004938 garray_T *trystack = &ectx->ec_trystack;
Bram Moolenaar06651632022-04-27 17:54:25 +01004939 trycmd_T *trycmd;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004940
Bram Moolenaar06651632022-04-27 17:54:25 +01004941 --trystack->ga_len;
4942 --trylevel;
4943 trycmd = ((trycmd_T *)trystack->ga_data) + trystack->ga_len;
4944 if (trycmd->tcd_did_throw)
4945 did_throw = TRUE;
4946 if (trycmd->tcd_caught && current_exception != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004947 {
Bram Moolenaar06651632022-04-27 17:54:25 +01004948 // discard the exception
4949 if (caught_stack == current_exception)
4950 caught_stack = caught_stack->caught;
4951 discard_current_exception();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004952 }
Bram Moolenaar06651632022-04-27 17:54:25 +01004953
4954 if (trycmd->tcd_return)
4955 goto func_return;
4956
4957 while (ectx->ec_stack.ga_len > trycmd->tcd_stack_len)
4958 {
4959 --ectx->ec_stack.ga_len;
4960 clear_tv(STACK_TV_BOT(0));
4961 }
4962 if (trycmd->tcd_cont != 0)
4963 // handling :continue: jump to outer try block or
4964 // start of the loop
4965 ectx->ec_iidx = trycmd->tcd_cont - 1;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004966 }
4967 break;
4968
4969 case ISN_THROW:
Bram Moolenaar8f81b222021-01-14 21:47:06 +01004970 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02004971 garray_T *trystack = &ectx->ec_trystack;
Bram Moolenaar1e021e62020-10-16 20:25:23 +02004972
Bram Moolenaar107e9ce2021-01-24 20:52:00 +01004973 if (trystack->ga_len == 0 && trylevel == 0 && emsg_silent)
4974 {
Bram Moolenaar3ef2e412023-04-30 18:50:48 +01004975 // Throwing an exception while using "silent!" causes
Bram Moolenaar107e9ce2021-01-24 20:52:00 +01004976 // the function to abort but not display an error.
4977 tv = STACK_TV_BOT(-1);
4978 clear_tv(tv);
4979 tv->v_type = VAR_NUMBER;
4980 tv->vval.v_number = 0;
4981 goto done;
4982 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02004983 --ectx->ec_stack.ga_len;
Bram Moolenaar107e9ce2021-01-24 20:52:00 +01004984 tv = STACK_TV_BOT(0);
4985 if (tv->vval.v_string == NULL
4986 || *skipwhite(tv->vval.v_string) == NUL)
4987 {
4988 vim_free(tv->vval.v_string);
4989 SOURCING_LNUM = iptr->isn_lnum;
4990 emsg(_(e_throw_with_empty_string));
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02004991 goto theend;
Bram Moolenaar107e9ce2021-01-24 20:52:00 +01004992 }
4993
4994 // Inside a "catch" we need to first discard the caught
4995 // exception.
4996 if (trystack->ga_len > 0)
4997 {
4998 trycmd_T *trycmd = ((trycmd_T *)trystack->ga_data)
4999 + trystack->ga_len - 1;
5000 if (trycmd->tcd_caught && current_exception != NULL)
5001 {
5002 // discard the exception
5003 if (caught_stack == current_exception)
5004 caught_stack = caught_stack->caught;
5005 discard_current_exception();
5006 trycmd->tcd_caught = FALSE;
5007 }
5008 }
5009
Bram Moolenaar90a57162022-02-12 14:23:17 +00005010 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar107e9ce2021-01-24 20:52:00 +01005011 if (throw_exception(tv->vval.v_string, ET_USER, NULL)
5012 == FAIL)
5013 {
5014 vim_free(tv->vval.v_string);
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02005015 goto theend;
Bram Moolenaar107e9ce2021-01-24 20:52:00 +01005016 }
5017 did_throw = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005018 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005019 break;
5020
5021 // compare with special values
5022 case ISN_COMPAREBOOL:
5023 case ISN_COMPARESPECIAL:
5024 {
5025 typval_T *tv1 = STACK_TV_BOT(-2);
5026 typval_T *tv2 = STACK_TV_BOT(-1);
5027 varnumber_T arg1 = tv1->vval.v_number;
5028 varnumber_T arg2 = tv2->vval.v_number;
5029 int res;
5030
Bram Moolenaar06651632022-04-27 17:54:25 +01005031 if (iptr->isn_arg.op.op_type == EXPR_EQUAL)
5032 res = arg1 == arg2;
5033 else
5034 res = arg1 != arg2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005035
Bram Moolenaar4c137212021-04-19 16:48:48 +02005036 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005037 tv1->v_type = VAR_BOOL;
5038 tv1->vval.v_number = res ? VVAL_TRUE : VVAL_FALSE;
5039 }
5040 break;
5041
Bram Moolenaar7a222242022-03-01 19:23:24 +00005042 case ISN_COMPARENULL:
5043 {
5044 typval_T *tv1 = STACK_TV_BOT(-2);
5045 typval_T *tv2 = STACK_TV_BOT(-1);
5046 int res;
5047
5048 res = typval_compare_null(tv1, tv2);
5049 if (res == MAYBE)
5050 goto on_error;
5051 if (iptr->isn_arg.op.op_type == EXPR_NEQUAL)
5052 res = !res;
5053 clear_tv(tv1);
5054 clear_tv(tv2);
5055 --ectx->ec_stack.ga_len;
5056 tv1->v_type = VAR_BOOL;
5057 tv1->vval.v_number = res ? VVAL_TRUE : VVAL_FALSE;
5058 }
5059 break;
5060
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005061 // Operation with two number arguments
5062 case ISN_OPNR:
5063 case ISN_COMPARENR:
5064 {
5065 typval_T *tv1 = STACK_TV_BOT(-2);
5066 typval_T *tv2 = STACK_TV_BOT(-1);
5067 varnumber_T arg1 = tv1->vval.v_number;
5068 varnumber_T arg2 = tv2->vval.v_number;
Bram Moolenaarfbeefb12021-08-07 15:50:23 +02005069 varnumber_T res = 0;
5070 int div_zero = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005071
Yegappan Lakshmanana061f342022-05-22 19:13:49 +01005072 if (iptr->isn_arg.op.op_type == EXPR_LSHIFT
5073 || iptr->isn_arg.op.op_type == EXPR_RSHIFT)
5074 {
5075 if (arg2 < 0)
5076 {
5077 SOURCING_LNUM = iptr->isn_lnum;
dundargocc57b5bc2022-11-02 13:30:51 +00005078 emsg(_(e_bitshift_ops_must_be_positive));
Yegappan Lakshmanana061f342022-05-22 19:13:49 +01005079 goto on_error;
5080 }
5081 }
5082
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005083 switch (iptr->isn_arg.op.op_type)
5084 {
5085 case EXPR_MULT: res = arg1 * arg2; break;
Bram Moolenaarfbeefb12021-08-07 15:50:23 +02005086 case EXPR_DIV: if (arg2 == 0)
5087 div_zero = TRUE;
5088 else
5089 res = arg1 / arg2;
5090 break;
5091 case EXPR_REM: if (arg2 == 0)
5092 div_zero = TRUE;
5093 else
5094 res = arg1 % arg2;
5095 break;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005096 case EXPR_SUB: res = arg1 - arg2; break;
5097 case EXPR_ADD: res = arg1 + arg2; break;
5098
5099 case EXPR_EQUAL: res = arg1 == arg2; break;
5100 case EXPR_NEQUAL: res = arg1 != arg2; break;
5101 case EXPR_GREATER: res = arg1 > arg2; break;
5102 case EXPR_GEQUAL: res = arg1 >= arg2; break;
5103 case EXPR_SMALLER: res = arg1 < arg2; break;
5104 case EXPR_SEQUAL: res = arg1 <= arg2; break;
Yegappan Lakshmanana061f342022-05-22 19:13:49 +01005105 case EXPR_LSHIFT: if (arg2 > MAX_LSHIFT_BITS)
5106 res = 0;
5107 else
Bram Moolenaar68e64d22022-05-22 22:07:52 +01005108 res = (uvarnumber_T)arg1 << arg2;
Yegappan Lakshmanana061f342022-05-22 19:13:49 +01005109 break;
5110 case EXPR_RSHIFT: if (arg2 > MAX_LSHIFT_BITS)
5111 res = 0;
5112 else
Bram Moolenaar338bf582022-05-22 20:16:32 +01005113 res = (uvarnumber_T)arg1 >> arg2;
Yegappan Lakshmanana061f342022-05-22 19:13:49 +01005114 break;
Bram Moolenaarfbeefb12021-08-07 15:50:23 +02005115 default: break;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005116 }
5117
Bram Moolenaar4c137212021-04-19 16:48:48 +02005118 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005119 if (iptr->isn_type == ISN_COMPARENR)
5120 {
5121 tv1->v_type = VAR_BOOL;
5122 tv1->vval.v_number = res ? VVAL_TRUE : VVAL_FALSE;
5123 }
5124 else
5125 tv1->vval.v_number = res;
Bram Moolenaarfbeefb12021-08-07 15:50:23 +02005126 if (div_zero)
5127 {
5128 SOURCING_LNUM = iptr->isn_lnum;
5129 emsg(_(e_divide_by_zero));
5130 goto on_error;
5131 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005132 }
5133 break;
5134
5135 // Computation with two float arguments
5136 case ISN_OPFLOAT:
5137 case ISN_COMPAREFLOAT:
5138 {
5139 typval_T *tv1 = STACK_TV_BOT(-2);
5140 typval_T *tv2 = STACK_TV_BOT(-1);
5141 float_T arg1 = tv1->vval.v_float;
5142 float_T arg2 = tv2->vval.v_float;
5143 float_T res = 0;
5144 int cmp = FALSE;
5145
5146 switch (iptr->isn_arg.op.op_type)
5147 {
5148 case EXPR_MULT: res = arg1 * arg2; break;
5149 case EXPR_DIV: res = arg1 / arg2; break;
5150 case EXPR_SUB: res = arg1 - arg2; break;
5151 case EXPR_ADD: res = arg1 + arg2; break;
5152
5153 case EXPR_EQUAL: cmp = arg1 == arg2; break;
5154 case EXPR_NEQUAL: cmp = arg1 != arg2; break;
5155 case EXPR_GREATER: cmp = arg1 > arg2; break;
5156 case EXPR_GEQUAL: cmp = arg1 >= arg2; break;
5157 case EXPR_SMALLER: cmp = arg1 < arg2; break;
5158 case EXPR_SEQUAL: cmp = arg1 <= arg2; break;
5159 default: cmp = 0; break;
5160 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02005161 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005162 if (iptr->isn_type == ISN_COMPAREFLOAT)
5163 {
5164 tv1->v_type = VAR_BOOL;
5165 tv1->vval.v_number = cmp ? VVAL_TRUE : VVAL_FALSE;
5166 }
5167 else
5168 tv1->vval.v_float = res;
5169 }
5170 break;
5171
5172 case ISN_COMPARELIST:
Bram Moolenaar265f8112021-12-19 12:33:05 +00005173 case ISN_COMPAREDICT:
5174 case ISN_COMPAREFUNC:
5175 case ISN_COMPARESTRING:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005176 case ISN_COMPAREBLOB:
Bram Moolenaarbcf31ec2023-01-02 20:32:24 +00005177 case ISN_COMPAREOBJECT:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005178 {
5179 typval_T *tv1 = STACK_TV_BOT(-2);
5180 typval_T *tv2 = STACK_TV_BOT(-1);
Bram Moolenaar265f8112021-12-19 12:33:05 +00005181 exprtype_T exprtype = iptr->isn_arg.op.op_type;
5182 int ic = iptr->isn_arg.op.op_ic;
5183 int res = FALSE;
5184 int status = OK;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005185
Bram Moolenaar265f8112021-12-19 12:33:05 +00005186 SOURCING_LNUM = iptr->isn_lnum;
5187 if (iptr->isn_type == ISN_COMPARELIST)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005188 {
Bram Moolenaar265f8112021-12-19 12:33:05 +00005189 status = typval_compare_list(tv1, tv2,
5190 exprtype, ic, &res);
5191 }
5192 else if (iptr->isn_type == ISN_COMPAREDICT)
5193 {
5194 status = typval_compare_dict(tv1, tv2,
5195 exprtype, ic, &res);
5196 }
5197 else if (iptr->isn_type == ISN_COMPAREFUNC)
5198 {
5199 status = typval_compare_func(tv1, tv2,
5200 exprtype, ic, &res);
5201 }
5202 else if (iptr->isn_type == ISN_COMPARESTRING)
5203 {
5204 status = typval_compare_string(tv1, tv2,
5205 exprtype, ic, &res);
5206 }
Bram Moolenaarbcf31ec2023-01-02 20:32:24 +00005207 else if (iptr->isn_type == ISN_COMPAREBLOB)
Bram Moolenaar265f8112021-12-19 12:33:05 +00005208 {
5209 status = typval_compare_blob(tv1, tv2, exprtype, &res);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005210 }
Bram Moolenaarbcf31ec2023-01-02 20:32:24 +00005211 else // ISN_COMPAREOBJECT
5212 {
5213 status = typval_compare_object(tv1, tv2,
Bram Moolenaar03ff0c62023-01-02 20:38:01 +00005214 exprtype, FALSE, &res);
Bram Moolenaarbcf31ec2023-01-02 20:32:24 +00005215 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02005216 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005217 clear_tv(tv1);
5218 clear_tv(tv2);
5219 tv1->v_type = VAR_BOOL;
Bram Moolenaar265f8112021-12-19 12:33:05 +00005220 tv1->vval.v_number = res ? VVAL_TRUE : VVAL_FALSE;
5221 if (status == FAIL)
5222 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005223 }
5224 break;
5225
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005226 case ISN_COMPAREANY:
5227 {
5228 typval_T *tv1 = STACK_TV_BOT(-2);
5229 typval_T *tv2 = STACK_TV_BOT(-1);
Bram Moolenaar657137c2021-01-09 15:45:23 +01005230 exprtype_T exprtype = iptr->isn_arg.op.op_type;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005231 int ic = iptr->isn_arg.op.op_ic;
Bram Moolenaar265f8112021-12-19 12:33:05 +00005232 int status;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005233
Bram Moolenaareb26f432020-09-14 16:50:05 +02005234 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar265f8112021-12-19 12:33:05 +00005235 status = typval_compare(tv1, tv2, exprtype, ic);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005236 clear_tv(tv2);
Bram Moolenaar4c137212021-04-19 16:48:48 +02005237 --ectx->ec_stack.ga_len;
Bram Moolenaar265f8112021-12-19 12:33:05 +00005238 if (status == FAIL)
5239 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005240 }
5241 break;
5242
5243 case ISN_ADDLIST:
5244 case ISN_ADDBLOB:
5245 {
5246 typval_T *tv1 = STACK_TV_BOT(-2);
5247 typval_T *tv2 = STACK_TV_BOT(-1);
5248
Bram Moolenaar1dcae592020-10-19 19:02:42 +02005249 // add two lists or blobs
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005250 if (iptr->isn_type == ISN_ADDLIST)
Bram Moolenaar07802042021-09-09 23:01:14 +02005251 {
5252 if (iptr->isn_arg.op.op_type == EXPR_APPEND
5253 && tv1->vval.v_list != NULL)
5254 list_extend(tv1->vval.v_list, tv2->vval.v_list,
5255 NULL);
5256 else
5257 eval_addlist(tv1, tv2);
5258 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005259 else
5260 eval_addblob(tv1, tv2);
5261 clear_tv(tv2);
Bram Moolenaar4c137212021-04-19 16:48:48 +02005262 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005263 }
5264 break;
5265
Bram Moolenaar1dcae592020-10-19 19:02:42 +02005266 case ISN_LISTAPPEND:
5267 {
5268 typval_T *tv1 = STACK_TV_BOT(-2);
5269 typval_T *tv2 = STACK_TV_BOT(-1);
5270 list_T *l = tv1->vval.v_list;
5271
5272 // add an item to a list
Bram Moolenaar1f4a3452022-01-01 18:29:21 +00005273 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar1dcae592020-10-19 19:02:42 +02005274 if (l == NULL)
5275 {
Bram Moolenaar1dcae592020-10-19 19:02:42 +02005276 emsg(_(e_cannot_add_to_null_list));
5277 goto on_error;
5278 }
Bram Moolenaar1f4a3452022-01-01 18:29:21 +00005279 if (value_check_lock(l->lv_lock, NULL, FALSE))
5280 goto on_error;
Bram Moolenaar1dcae592020-10-19 19:02:42 +02005281 if (list_append_tv(l, tv2) == FAIL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02005282 goto theend;
Bram Moolenaar955347c2020-10-19 23:01:46 +02005283 clear_tv(tv2);
Bram Moolenaar4c137212021-04-19 16:48:48 +02005284 --ectx->ec_stack.ga_len;
Bram Moolenaar1dcae592020-10-19 19:02:42 +02005285 }
5286 break;
5287
Bram Moolenaar80b0e5e2020-10-19 20:45:36 +02005288 case ISN_BLOBAPPEND:
5289 {
5290 typval_T *tv1 = STACK_TV_BOT(-2);
5291 typval_T *tv2 = STACK_TV_BOT(-1);
5292 blob_T *b = tv1->vval.v_blob;
5293 int error = FALSE;
5294 varnumber_T n;
5295
5296 // add a number to a blob
5297 if (b == NULL)
5298 {
5299 SOURCING_LNUM = iptr->isn_lnum;
5300 emsg(_(e_cannot_add_to_null_blob));
5301 goto on_error;
5302 }
5303 n = tv_get_number_chk(tv2, &error);
5304 if (error)
5305 goto on_error;
5306 ga_append(&b->bv_ga, (int)n);
Bram Moolenaar4c137212021-04-19 16:48:48 +02005307 --ectx->ec_stack.ga_len;
Bram Moolenaar80b0e5e2020-10-19 20:45:36 +02005308 }
5309 break;
5310
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005311 // Computation with two arguments of unknown type
5312 case ISN_OPANY:
5313 {
5314 typval_T *tv1 = STACK_TV_BOT(-2);
5315 typval_T *tv2 = STACK_TV_BOT(-1);
5316 varnumber_T n1, n2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005317 float_T f1 = 0, f2 = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005318 int error = FALSE;
5319
5320 if (iptr->isn_arg.op.op_type == EXPR_ADD)
5321 {
5322 if (tv1->v_type == VAR_LIST && tv2->v_type == VAR_LIST)
5323 {
5324 eval_addlist(tv1, tv2);
5325 clear_tv(tv2);
Bram Moolenaar4c137212021-04-19 16:48:48 +02005326 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005327 break;
5328 }
5329 else if (tv1->v_type == VAR_BLOB
5330 && tv2->v_type == VAR_BLOB)
5331 {
5332 eval_addblob(tv1, tv2);
5333 clear_tv(tv2);
Bram Moolenaar4c137212021-04-19 16:48:48 +02005334 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005335 break;
5336 }
5337 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005338 if (tv1->v_type == VAR_FLOAT)
5339 {
5340 f1 = tv1->vval.v_float;
5341 n1 = 0;
5342 }
5343 else
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005344 {
Bram Moolenaarf665e972020-12-05 19:17:16 +01005345 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005346 n1 = tv_get_number_chk(tv1, &error);
5347 if (error)
Bram Moolenaard032f342020-07-18 18:13:02 +02005348 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005349 if (tv2->v_type == VAR_FLOAT)
5350 f1 = n1;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005351 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005352 if (tv2->v_type == VAR_FLOAT)
5353 {
5354 f2 = tv2->vval.v_float;
5355 n2 = 0;
5356 }
5357 else
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005358 {
5359 n2 = tv_get_number_chk(tv2, &error);
5360 if (error)
Bram Moolenaard032f342020-07-18 18:13:02 +02005361 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005362 if (tv1->v_type == VAR_FLOAT)
5363 f2 = n2;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005364 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005365 // if there is a float on either side the result is a float
5366 if (tv1->v_type == VAR_FLOAT || tv2->v_type == VAR_FLOAT)
5367 {
5368 switch (iptr->isn_arg.op.op_type)
5369 {
5370 case EXPR_MULT: f1 = f1 * f2; break;
5371 case EXPR_DIV: f1 = f1 / f2; break;
5372 case EXPR_SUB: f1 = f1 - f2; break;
5373 case EXPR_ADD: f1 = f1 + f2; break;
Bram Moolenaar7517ffd2020-08-14 18:35:07 +02005374 default: SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005375 emsg(_(e_cannot_use_percent_with_float));
Bram Moolenaarf0b9f432020-07-17 23:03:17 +02005376 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005377 }
5378 clear_tv(tv1);
5379 clear_tv(tv2);
5380 tv1->v_type = VAR_FLOAT;
5381 tv1->vval.v_float = f1;
Bram Moolenaar4c137212021-04-19 16:48:48 +02005382 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005383 }
5384 else
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005385 {
Bram Moolenaarb1f28572021-01-21 13:03:20 +01005386 int failed = FALSE;
5387
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005388 switch (iptr->isn_arg.op.op_type)
5389 {
5390 case EXPR_MULT: n1 = n1 * n2; break;
Bram Moolenaarb1f28572021-01-21 13:03:20 +01005391 case EXPR_DIV: n1 = num_divide(n1, n2, &failed);
5392 if (failed)
Bram Moolenaar99880f92021-01-20 21:23:14 +01005393 goto on_error;
5394 break;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005395 case EXPR_SUB: n1 = n1 - n2; break;
5396 case EXPR_ADD: n1 = n1 + n2; break;
Bram Moolenaarb1f28572021-01-21 13:03:20 +01005397 default: n1 = num_modulus(n1, n2, &failed);
5398 if (failed)
Bram Moolenaar99880f92021-01-20 21:23:14 +01005399 goto on_error;
5400 break;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005401 }
5402 clear_tv(tv1);
5403 clear_tv(tv2);
5404 tv1->v_type = VAR_NUMBER;
5405 tv1->vval.v_number = n1;
Bram Moolenaar4c137212021-04-19 16:48:48 +02005406 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005407 }
5408 }
5409 break;
5410
Bram Moolenaarbf9d8c32020-07-19 17:55:44 +02005411 case ISN_STRINDEX:
Bram Moolenaar11107ba2020-08-15 21:10:16 +02005412 case ISN_STRSLICE:
Bram Moolenaarbf9d8c32020-07-19 17:55:44 +02005413 {
Bram Moolenaar11107ba2020-08-15 21:10:16 +02005414 int is_slice = iptr->isn_type == ISN_STRSLICE;
5415 varnumber_T n1 = 0, n2;
Bram Moolenaarbf9d8c32020-07-19 17:55:44 +02005416 char_u *res;
5417
5418 // string index: string is at stack-2, index at stack-1
Bram Moolenaar11107ba2020-08-15 21:10:16 +02005419 // string slice: string is at stack-3, first index at
5420 // stack-2, second index at stack-1
Bram Moolenaar11107ba2020-08-15 21:10:16 +02005421 if (is_slice)
5422 {
5423 tv = STACK_TV_BOT(-2);
Bram Moolenaar11107ba2020-08-15 21:10:16 +02005424 n1 = tv->vval.v_number;
5425 }
5426
Bram Moolenaarbf9d8c32020-07-19 17:55:44 +02005427 tv = STACK_TV_BOT(-1);
Bram Moolenaar11107ba2020-08-15 21:10:16 +02005428 n2 = tv->vval.v_number;
Bram Moolenaarbf9d8c32020-07-19 17:55:44 +02005429
Bram Moolenaar4c137212021-04-19 16:48:48 +02005430 ectx->ec_stack.ga_len -= is_slice ? 2 : 1;
Bram Moolenaarbf9d8c32020-07-19 17:55:44 +02005431 tv = STACK_TV_BOT(-1);
Bram Moolenaar11107ba2020-08-15 21:10:16 +02005432 if (is_slice)
5433 // Slice: Select the characters from the string
Bram Moolenaar6601b622021-01-13 21:47:15 +01005434 res = string_slice(tv->vval.v_string, n1, n2, FALSE);
Bram Moolenaar11107ba2020-08-15 21:10:16 +02005435 else
5436 // Index: The resulting variable is a string of a
Bram Moolenaar0289a092021-03-14 18:40:19 +01005437 // single character (including composing characters).
5438 // If the index is too big or negative the result is
5439 // empty.
Bram Moolenaar11107ba2020-08-15 21:10:16 +02005440 res = char_from_string(tv->vval.v_string, n2);
Bram Moolenaarbf9d8c32020-07-19 17:55:44 +02005441 vim_free(tv->vval.v_string);
5442 tv->vval.v_string = res;
5443 }
5444 break;
5445
5446 case ISN_LISTINDEX:
Bram Moolenaared591872020-08-15 22:14:53 +02005447 case ISN_LISTSLICE:
Bram Moolenaarcfc30232021-04-11 20:26:34 +02005448 case ISN_BLOBINDEX:
5449 case ISN_BLOBSLICE:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005450 {
Bram Moolenaarcfc30232021-04-11 20:26:34 +02005451 int is_slice = iptr->isn_type == ISN_LISTSLICE
5452 || iptr->isn_type == ISN_BLOBSLICE;
5453 int is_blob = iptr->isn_type == ISN_BLOBINDEX
5454 || iptr->isn_type == ISN_BLOBSLICE;
Bram Moolenaared591872020-08-15 22:14:53 +02005455 varnumber_T n1, n2;
Bram Moolenaarcfc30232021-04-11 20:26:34 +02005456 typval_T *val_tv;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005457
5458 // list index: list is at stack-2, index at stack-1
Bram Moolenaared591872020-08-15 22:14:53 +02005459 // list slice: list is at stack-3, indexes at stack-2 and
5460 // stack-1
Bram Moolenaarcfc30232021-04-11 20:26:34 +02005461 // Same for blob.
5462 val_tv = is_slice ? STACK_TV_BOT(-3) : STACK_TV_BOT(-2);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005463
5464 tv = STACK_TV_BOT(-1);
Bram Moolenaared591872020-08-15 22:14:53 +02005465 n1 = n2 = tv->vval.v_number;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005466 clear_tv(tv);
Bram Moolenaared591872020-08-15 22:14:53 +02005467
5468 if (is_slice)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005469 {
Bram Moolenaared591872020-08-15 22:14:53 +02005470 tv = STACK_TV_BOT(-2);
Bram Moolenaared591872020-08-15 22:14:53 +02005471 n1 = tv->vval.v_number;
5472 clear_tv(tv);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005473 }
Bram Moolenaared591872020-08-15 22:14:53 +02005474
Bram Moolenaar4c137212021-04-19 16:48:48 +02005475 ectx->ec_stack.ga_len -= is_slice ? 2 : 1;
Bram Moolenaar435d8972020-07-05 16:42:13 +02005476 tv = STACK_TV_BOT(-1);
Bram Moolenaar1d634542020-08-18 13:41:50 +02005477 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaarcfc30232021-04-11 20:26:34 +02005478 if (is_blob)
5479 {
5480 if (blob_slice_or_index(val_tv->vval.v_blob, is_slice,
5481 n1, n2, FALSE, tv) == FAIL)
5482 goto on_error;
5483 }
5484 else
5485 {
5486 if (list_slice_or_index(val_tv->vval.v_list, is_slice,
5487 n1, n2, FALSE, tv, TRUE) == FAIL)
5488 goto on_error;
5489 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005490 }
5491 break;
5492
Bram Moolenaarcc673e72020-08-16 17:33:35 +02005493 case ISN_ANYINDEX:
5494 case ISN_ANYSLICE:
5495 {
5496 int is_slice = iptr->isn_type == ISN_ANYSLICE;
5497 typval_T *var1, *var2;
5498 int res;
5499
5500 // index: composite is at stack-2, index at stack-1
5501 // slice: composite is at stack-3, indexes at stack-2 and
5502 // stack-1
5503 tv = is_slice ? STACK_TV_BOT(-3) : STACK_TV_BOT(-2);
Bram Moolenaar3affe7a2020-08-18 20:34:13 +02005504 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaarcc673e72020-08-16 17:33:35 +02005505 if (check_can_index(tv, TRUE, TRUE) == FAIL)
5506 goto on_error;
5507 var1 = is_slice ? STACK_TV_BOT(-2) : STACK_TV_BOT(-1);
5508 var2 = is_slice ? STACK_TV_BOT(-1) : NULL;
Bram Moolenaar6601b622021-01-13 21:47:15 +01005509 res = eval_index_inner(tv, is_slice, var1, var2,
5510 FALSE, NULL, -1, TRUE);
Bram Moolenaarcc673e72020-08-16 17:33:35 +02005511 clear_tv(var1);
5512 if (is_slice)
5513 clear_tv(var2);
Bram Moolenaar4c137212021-04-19 16:48:48 +02005514 ectx->ec_stack.ga_len -= is_slice ? 2 : 1;
Bram Moolenaarcc673e72020-08-16 17:33:35 +02005515 if (res == FAIL)
5516 goto on_error;
5517 }
5518 break;
5519
Bram Moolenaar9af78762020-06-16 11:34:42 +02005520 case ISN_SLICE:
5521 {
5522 list_T *list;
5523 int count = iptr->isn_arg.number;
5524
Bram Moolenaarc5b1c202020-06-18 22:43:27 +02005525 // type will have been checked to be a list
Bram Moolenaar9af78762020-06-16 11:34:42 +02005526 tv = STACK_TV_BOT(-1);
Bram Moolenaar9af78762020-06-16 11:34:42 +02005527 list = tv->vval.v_list;
5528
5529 // no error for short list, expect it to be checked earlier
5530 if (list != NULL && list->lv_len >= count)
5531 {
5532 list_T *newlist = list_slice(list,
5533 count, list->lv_len - 1);
5534
5535 if (newlist != NULL)
5536 {
5537 list_unref(list);
5538 tv->vval.v_list = newlist;
5539 ++newlist->lv_refcount;
5540 }
5541 }
5542 }
5543 break;
5544
Bram Moolenaar47a519a2020-06-14 23:05:10 +02005545 case ISN_GETITEM:
5546 {
5547 listitem_T *li;
Bram Moolenaar035bd1c2021-06-21 19:44:11 +02005548 getitem_T *gi = &iptr->isn_arg.getitem;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02005549
Bram Moolenaarc785b9a2020-06-19 18:34:15 +02005550 // Get list item: list is at stack-1, push item.
5551 // List type and length is checked for when compiling.
Bram Moolenaar035bd1c2021-06-21 19:44:11 +02005552 tv = STACK_TV_BOT(-1 - gi->gi_with_op);
5553 li = list_find(tv->vval.v_list, gi->gi_index);
Bram Moolenaar47a519a2020-06-14 23:05:10 +02005554
Bram Moolenaar35578162021-08-02 19:10:38 +02005555 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02005556 goto theend;
Bram Moolenaar4c137212021-04-19 16:48:48 +02005557 ++ectx->ec_stack.ga_len;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02005558 copy_tv(&li->li_tv, STACK_TV_BOT(-1));
Bram Moolenaarf785aa12021-02-11 21:19:34 +01005559
5560 // Useful when used in unpack assignment. Reset at
5561 // ISN_DROP.
Bram Moolenaar035bd1c2021-06-21 19:44:11 +02005562 ectx->ec_where.wt_index = gi->gi_index + 1;
LemonBoyc5d27442023-08-19 13:02:35 +02005563 ectx->ec_where.wt_kind = WT_VARIABLE;
Bram Moolenaar47a519a2020-06-14 23:05:10 +02005564 }
5565 break;
5566
Yegappan Lakshmanan56d45f12024-11-11 19:58:55 +01005567 // dict member with string key (dict['member'])
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005568 case ISN_MEMBER:
5569 {
5570 dict_T *dict;
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02005571 char_u *key;
5572 dictitem_T *di;
5573
5574 // dict member: dict is at stack-2, key at stack-1
5575 tv = STACK_TV_BOT(-2);
Bram Moolenaar4dac32c2020-05-15 21:44:19 +02005576 // no need to check for VAR_DICT, CHECKTYPE will check.
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02005577 dict = tv->vval.v_dict;
5578
5579 tv = STACK_TV_BOT(-1);
Bram Moolenaar4dac32c2020-05-15 21:44:19 +02005580 // no need to check for VAR_STRING, 2STRING will check.
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02005581 key = tv->vval.v_string;
Bram Moolenaar086fc9a2020-10-30 18:33:02 +01005582 if (key == NULL)
5583 key = (char_u *)"";
Bram Moolenaar4dac32c2020-05-15 21:44:19 +02005584
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02005585 if ((di = dict_find(dict, key, -1)) == NULL)
5586 {
Bram Moolenaar7517ffd2020-08-14 18:35:07 +02005587 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaara9fa8c52023-01-02 18:10:04 +00005588 semsg(_(e_key_not_present_in_dictionary_str), key);
Bram Moolenaar4029cab2020-12-05 18:13:27 +01005589
5590 // If :silent! is used we will continue, make sure the
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02005591 // stack contents makes sense and the dict stack is
5592 // updated.
Bram Moolenaar4029cab2020-12-05 18:13:27 +01005593 clear_tv(tv);
Bram Moolenaar4c137212021-04-19 16:48:48 +02005594 --ectx->ec_stack.ga_len;
Bram Moolenaar4029cab2020-12-05 18:13:27 +01005595 tv = STACK_TV_BOT(-1);
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02005596 (void) dict_stack_save(tv);
Bram Moolenaar4029cab2020-12-05 18:13:27 +01005597 tv->v_type = VAR_NUMBER;
5598 tv->vval.v_number = 0;
Bram Moolenaaraf0df472020-12-02 20:51:22 +01005599 goto on_fatal_error;
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02005600 }
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02005601 clear_tv(tv);
Bram Moolenaar4c137212021-04-19 16:48:48 +02005602 --ectx->ec_stack.ga_len;
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02005603 // Put the dict used on the dict stack, it might be used by
5604 // a dict function later.
Bram Moolenaar50788ef2020-07-05 16:51:26 +02005605 tv = STACK_TV_BOT(-1);
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02005606 if (dict_stack_save(tv) == FAIL)
5607 goto on_fatal_error;
Bram Moolenaar50788ef2020-07-05 16:51:26 +02005608 copy_tv(&di->di_tv, tv);
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02005609 }
5610 break;
5611
Yegappan Lakshmanan56d45f12024-11-11 19:58:55 +01005612 // dict member with string key (dict.member)
5613 // or can be an object
Bram Moolenaar1cc2a942020-05-10 19:10:31 +02005614 case ISN_STRINGMEMBER:
5615 {
5616 dict_T *dict;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005617 dictitem_T *di;
5618
5619 tv = STACK_TV_BOT(-1);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005620
Yegappan Lakshmanan56d45f12024-11-11 19:58:55 +01005621 if (tv->v_type == VAR_OBJECT)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005622 {
Yegappan Lakshmanan56d45f12024-11-11 19:58:55 +01005623 if (dict_stack_save(tv) == FAIL)
5624 goto on_fatal_error;
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02005625
Yegappan Lakshmanan56d45f12024-11-11 19:58:55 +01005626 ufunc_T *ufunc = (((dfunc_T *)def_functions.ga_data)
5627 + ectx->ec_dfunc_idx)->df_ufunc;
5628 // Class object (not a Dict)
5629 if (any_var_get_obj_member(ufunc->uf_class, iptr, tv) == FAIL)
5630 goto on_error;
5631 }
5632 else
5633 {
5634 if (tv->v_type != VAR_DICT || tv->vval.v_dict == NULL)
5635 {
5636 SOURCING_LNUM = iptr->isn_lnum;
5637 emsg(_(e_dictionary_required));
5638 goto on_error;
5639 }
5640 dict = tv->vval.v_dict;
5641
5642 if ((di = dict_find(dict, iptr->isn_arg.string, -1))
5643 == NULL)
5644 {
5645 SOURCING_LNUM = iptr->isn_lnum;
5646 semsg(_(e_key_not_present_in_dictionary_str),
5647 iptr->isn_arg.string);
5648 goto on_error;
5649 }
5650 // Put the dict used on the dict stack, it might be
5651 // used by a dict function later.
5652 if (dict_stack_save(tv) == FAIL)
5653 goto on_fatal_error;
5654
5655 copy_tv(&di->di_tv, tv);
5656 }
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02005657 }
5658 break;
5659
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00005660 case ISN_GET_OBJ_MEMBER:
Bram Moolenaar29ac5df2023-01-16 19:43:47 +00005661 case ISN_GET_ITF_MEMBER:
Bram Moolenaarffdaca92022-12-09 21:41:48 +00005662 {
5663 tv = STACK_TV_BOT(-1);
5664 if (tv->v_type != VAR_OBJECT)
5665 {
5666 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaard0200c82023-01-28 15:19:40 +00005667 object_required_error(tv);
Bram Moolenaarffdaca92022-12-09 21:41:48 +00005668 goto on_error;
5669 }
Bram Moolenaar29ac5df2023-01-16 19:43:47 +00005670
Bram Moolenaarffdaca92022-12-09 21:41:48 +00005671 object_T *obj = tv->vval.v_object;
Bram Moolenaarc3f971f2023-03-02 17:38:33 +00005672 if (obj == NULL)
5673 {
5674 SOURCING_LNUM = iptr->isn_lnum;
5675 emsg(_(e_using_null_object));
5676 goto on_error;
5677 }
5678
Bram Moolenaar29ac5df2023-01-16 19:43:47 +00005679 int idx;
5680 if (iptr->isn_type == ISN_GET_OBJ_MEMBER)
Ernie Rael18143d32023-09-04 22:30:41 +02005681 idx = iptr->isn_arg.classmember.cm_idx;
Bram Moolenaar29ac5df2023-01-16 19:43:47 +00005682 else
5683 {
5684 idx = iptr->isn_arg.classmember.cm_idx;
5685 // convert the interface index to the object index
5686 idx = object_index_from_itf_index(
Ernie Rael18143d32023-09-04 22:30:41 +02005687 iptr->isn_arg.classmember.cm_class,
Yegappan Lakshmanan5a05d372023-09-29 19:43:11 +02005688 FALSE, idx, obj->obj_class);
Bram Moolenaar29ac5df2023-01-16 19:43:47 +00005689 }
5690
Ernie Rael18143d32023-09-04 22:30:41 +02005691 // The members are located right after the object struct.
Yegappan Lakshmanan5a05d372023-09-29 19:43:11 +02005692 typval_T *mtv = ((typval_T *)(obj + 1)) + idx;
Bram Moolenaar590162c2022-12-24 21:24:06 +00005693 copy_tv(mtv, tv);
Bram Moolenaarffdaca92022-12-09 21:41:48 +00005694
5695 // Unreference the object after getting the member, it may
5696 // be freed.
5697 object_unref(obj);
5698 }
5699 break;
5700
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00005701 case ISN_STORE_THIS:
5702 {
5703 int idx = iptr->isn_arg.number;
5704 object_T *obj = STACK_TV_VAR(0)->vval.v_object;
5705 // the members are located right after the object struct
5706 typval_T *mtv = ((typval_T *)(obj + 1)) + idx;
5707 clear_tv(mtv);
5708 *mtv = *STACK_TV_BOT(-1);
5709 --ectx->ec_stack.ga_len;
5710 }
5711 break;
5712
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02005713 case ISN_CLEARDICT:
5714 dict_stack_drop();
5715 break;
5716
5717 case ISN_USEDICT:
5718 {
5719 typval_T *dict_tv = dict_stack_get_tv();
5720
5721 // Turn "dict.Func" into a partial for "Func" bound to
5722 // "dict". Don't do this when "Func" is already a partial
5723 // that was bound explicitly (pt_auto is FALSE).
5724 tv = STACK_TV_BOT(-1);
5725 if (dict_tv != NULL
5726 && dict_tv->v_type == VAR_DICT
5727 && dict_tv->vval.v_dict != NULL
5728 && (tv->v_type == VAR_FUNC
5729 || (tv->v_type == VAR_PARTIAL
5730 && (tv->vval.v_partial->pt_auto
5731 || tv->vval.v_partial->pt_dict == NULL))))
5732 dict_tv->vval.v_dict =
5733 make_partial(dict_tv->vval.v_dict, tv);
5734 dict_stack_drop();
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005735 }
5736 break;
5737
5738 case ISN_NEGATENR:
5739 tv = STACK_TV_BOT(-1);
Bram Moolenaar0c7f2612022-02-17 19:44:07 +00005740 // CHECKTYPE should have checked the variable type
Bram Moolenaarc58164c2020-03-29 18:40:30 +02005741 if (tv->v_type == VAR_FLOAT)
5742 tv->vval.v_float = -tv->vval.v_float;
5743 else
Bram Moolenaarc58164c2020-03-29 18:40:30 +02005744 tv->vval.v_number = -tv->vval.v_number;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005745 break;
5746
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005747 case ISN_CHECKTYPE:
5748 {
5749 checktype_T *ct = &iptr->isn_arg.type;
Bram Moolenaarb1040dc2022-05-18 11:00:48 +01005750 int r;
LemonBoyc5d27442023-08-19 13:02:35 +02005751 where_T where = WHERE_INIT;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005752
Bram Moolenaarb3005ce2021-01-22 17:51:06 +01005753 tv = STACK_TV_BOT((int)ct->ct_off);
Bram Moolenaar5e654232020-09-16 15:22:00 +02005754 SOURCING_LNUM = iptr->isn_lnum;
LemonBoyc5d27442023-08-19 13:02:35 +02005755 if (ct->ct_arg_idx > 0)
5756 {
5757 where.wt_index = ct->ct_arg_idx;
5758 where.wt_kind = ct->ct_is_var ? WT_VARIABLE : WT_ARGUMENT;
LemonBoyc5d27442023-08-19 13:02:35 +02005759 }
LemonBoyf244b2f2023-08-19 16:02:04 +02005760 where.wt_func_name = ectx->ec_where.wt_func_name;
LemonBoyc5d27442023-08-19 13:02:35 +02005761 r = check_typval_type(ct->ct_type, tv, where);
Bram Moolenaarb1040dc2022-05-18 11:00:48 +01005762 if (r == FAIL)
5763 goto on_error;
Bram Moolenaar5e654232020-09-16 15:22:00 +02005764
5765 // number 0 is FALSE, number 1 is TRUE
5766 if (tv->v_type == VAR_NUMBER
5767 && ct->ct_type->tt_type == VAR_BOOL
5768 && (tv->vval.v_number == 0
5769 || tv->vval.v_number == 1))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005770 {
Bram Moolenaar5e654232020-09-16 15:22:00 +02005771 tv->v_type = VAR_BOOL;
5772 tv->vval.v_number = tv->vval.v_number
Bram Moolenaardadaddd2020-09-12 19:11:23 +02005773 ? VVAL_TRUE : VVAL_FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005774 }
5775 }
5776 break;
5777
Bram Moolenaar9af78762020-06-16 11:34:42 +02005778 case ISN_CHECKLEN:
5779 {
5780 int min_len = iptr->isn_arg.checklen.cl_min_len;
5781 list_T *list = NULL;
5782
5783 tv = STACK_TV_BOT(-1);
5784 if (tv->v_type == VAR_LIST)
5785 list = tv->vval.v_list;
5786 if (list == NULL || list->lv_len < min_len
5787 || (list->lv_len > min_len
5788 && !iptr->isn_arg.checklen.cl_more_OK))
5789 {
Bram Moolenaar7517ffd2020-08-14 18:35:07 +02005790 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar451c2e32020-08-15 16:33:28 +02005791 semsg(_(e_expected_nr_items_but_got_nr),
Bram Moolenaar9af78762020-06-16 11:34:42 +02005792 min_len, list == NULL ? 0 : list->lv_len);
Bram Moolenaarf0b9f432020-07-17 23:03:17 +02005793 goto on_error;
Bram Moolenaar9af78762020-06-16 11:34:42 +02005794 }
5795 }
5796 break;
5797
Bram Moolenaaraa210a32021-01-02 15:41:03 +01005798 case ISN_SETTYPE:
Bram Moolenaar381692b2022-02-02 20:01:27 +00005799 set_tv_type(STACK_TV_BOT(-1), iptr->isn_arg.type.ct_type);
Bram Moolenaaraa210a32021-01-02 15:41:03 +01005800 break;
5801
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005802 case ISN_2BOOL:
Bram Moolenaar2bb26582020-10-03 22:52:39 +02005803 case ISN_COND2BOOL:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005804 {
5805 int n;
Bram Moolenaar2bb26582020-10-03 22:52:39 +02005806 int error = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005807
Bram Moolenaar2bb26582020-10-03 22:52:39 +02005808 if (iptr->isn_type == ISN_2BOOL)
5809 {
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02005810 tv = STACK_TV_BOT(iptr->isn_arg.tobool.offset);
Bram Moolenaar2bb26582020-10-03 22:52:39 +02005811 n = tv2bool(tv);
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02005812 if (iptr->isn_arg.tobool.invert)
Bram Moolenaar2bb26582020-10-03 22:52:39 +02005813 n = !n;
5814 }
5815 else
5816 {
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02005817 tv = STACK_TV_BOT(-1);
Bram Moolenaar2bb26582020-10-03 22:52:39 +02005818 SOURCING_LNUM = iptr->isn_lnum;
5819 n = tv_get_bool_chk(tv, &error);
5820 if (error)
5821 goto on_error;
5822 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005823 clear_tv(tv);
5824 tv->v_type = VAR_BOOL;
5825 tv->vval.v_number = n ? VVAL_TRUE : VVAL_FALSE;
5826 }
5827 break;
5828
5829 case ISN_2STRING:
Bram Moolenaar418f1df2020-08-12 21:34:49 +02005830 case ISN_2STRING_ANY:
Bram Moolenaar0acbf5a2021-01-05 20:58:25 +01005831 SOURCING_LNUM = iptr->isn_lnum;
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02005832 if (do_2string(STACK_TV_BOT(iptr->isn_arg.tostring.offset),
5833 iptr->isn_type == ISN_2STRING_ANY,
Yegappan Lakshmananbce51d92024-04-15 19:19:52 +02005834 iptr->isn_arg.tostring.flags) == FAIL)
Bram Moolenaar4f5e3972020-12-21 17:30:50 +01005835 goto on_error;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005836 break;
5837
Bram Moolenaar08597872020-12-10 19:43:40 +01005838 case ISN_RANGE:
5839 {
5840 exarg_T ea;
5841 char *errormsg;
5842
Bram Moolenaarece0b872021-01-08 20:40:45 +01005843 ea.line2 = 0;
Bram Moolenaard1510ee2021-01-04 16:15:58 +01005844 ea.addr_count = 0;
Bram Moolenaar08597872020-12-10 19:43:40 +01005845 ea.addr_type = ADDR_LINES;
5846 ea.cmd = iptr->isn_arg.string;
Bram Moolenaarece0b872021-01-08 20:40:45 +01005847 ea.skip = FALSE;
Bram Moolenaar08597872020-12-10 19:43:40 +01005848 if (parse_cmd_address(&ea, &errormsg, FALSE) == FAIL)
Bram Moolenaarece0b872021-01-08 20:40:45 +01005849 goto on_error;
Bram Moolenaara28639e2021-01-19 22:48:09 +01005850
Bram Moolenaar35578162021-08-02 19:10:38 +02005851 if (GA_GROW_FAILS(&ectx->ec_stack, 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02005852 goto theend;
Bram Moolenaar4c137212021-04-19 16:48:48 +02005853 ++ectx->ec_stack.ga_len;
Bram Moolenaara28639e2021-01-19 22:48:09 +01005854 tv = STACK_TV_BOT(-1);
5855 tv->v_type = VAR_NUMBER;
5856 tv->v_lock = 0;
Bram Moolenaar06651632022-04-27 17:54:25 +01005857 tv->vval.v_number = ea.line2;
Bram Moolenaar08597872020-12-10 19:43:40 +01005858 }
5859 break;
5860
Bram Moolenaarc3516f72020-09-08 22:45:35 +02005861 case ISN_PUT:
5862 {
5863 int regname = iptr->isn_arg.put.put_regname;
5864 linenr_T lnum = iptr->isn_arg.put.put_lnum;
5865 char_u *expr = NULL;
5866 int dir = FORWARD;
5867
Bram Moolenaar08597872020-12-10 19:43:40 +01005868 if (lnum < -2)
5869 {
5870 // line number was put on the stack by ISN_RANGE
5871 tv = STACK_TV_BOT(-1);
5872 curwin->w_cursor.lnum = tv->vval.v_number;
5873 if (lnum == LNUM_VARIABLE_RANGE_ABOVE)
5874 dir = BACKWARD;
Bram Moolenaar4c137212021-04-19 16:48:48 +02005875 --ectx->ec_stack.ga_len;
Bram Moolenaar08597872020-12-10 19:43:40 +01005876 }
5877 else if (lnum == -2)
Bram Moolenaarc3516f72020-09-08 22:45:35 +02005878 // :put! above cursor
5879 dir = BACKWARD;
5880 else if (lnum >= 0)
Bram Moolenaar4e713ba2022-02-07 15:31:37 +00005881 {
5882 curwin->w_cursor.lnum = lnum;
5883 if (lnum == 0)
5884 // check_cursor() below will move to line 1
5885 dir = BACKWARD;
5886 }
Bram Moolenaara28639e2021-01-19 22:48:09 +01005887
5888 if (regname == '=')
5889 {
5890 tv = STACK_TV_BOT(-1);
5891 if (tv->v_type == VAR_STRING)
5892 expr = tv->vval.v_string;
5893 else
5894 {
5895 expr = typval2string(tv, TRUE); // allocates value
5896 clear_tv(tv);
5897 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02005898 --ectx->ec_stack.ga_len;
Bram Moolenaara28639e2021-01-19 22:48:09 +01005899 }
Bram Moolenaarc3516f72020-09-08 22:45:35 +02005900 check_cursor();
5901 do_put(regname, expr, dir, 1L, PUT_LINE|PUT_CURSLINE);
5902 vim_free(expr);
5903 }
5904 break;
5905
Bram Moolenaar02194d22020-10-24 23:08:38 +02005906 case ISN_CMDMOD:
Bram Moolenaar4c137212021-04-19 16:48:48 +02005907 ectx->ec_funclocal.floc_save_cmdmod = cmdmod;
5908 ectx->ec_funclocal.floc_restore_cmdmod = TRUE;
5909 ectx->ec_funclocal.floc_restore_cmdmod_stacklen =
5910 ectx->ec_stack.ga_len;
Bram Moolenaar02194d22020-10-24 23:08:38 +02005911 cmdmod = *iptr->isn_arg.cmdmod.cf_cmdmod;
5912 apply_cmdmod(&cmdmod);
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +02005913 break;
5914
Bram Moolenaar02194d22020-10-24 23:08:38 +02005915 case ISN_CMDMOD_REV:
5916 // filter regprog is owned by the instruction, don't free it
5917 cmdmod.cmod_filter_regmatch.regprog = NULL;
5918 undo_cmdmod(&cmdmod);
Bram Moolenaar4c137212021-04-19 16:48:48 +02005919 cmdmod = ectx->ec_funclocal.floc_save_cmdmod;
5920 ectx->ec_funclocal.floc_restore_cmdmod = FALSE;
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +02005921 break;
5922
Bram Moolenaar792f7862020-11-23 08:31:18 +01005923 case ISN_UNPACK:
5924 {
5925 int count = iptr->isn_arg.unpack.unp_count;
5926 int semicolon = iptr->isn_arg.unpack.unp_semicolon;
5927 list_T *l;
5928 listitem_T *li;
5929 int i;
5930
5931 // Check there is a valid list to unpack.
5932 tv = STACK_TV_BOT(-1);
5933 if (tv->v_type != VAR_LIST)
5934 {
5935 SOURCING_LNUM = iptr->isn_lnum;
5936 emsg(_(e_for_argument_must_be_sequence_of_lists));
5937 goto on_error;
5938 }
5939 l = tv->vval.v_list;
5940 if (l == NULL
5941 || l->lv_len < (semicolon ? count - 1 : count))
5942 {
5943 SOURCING_LNUM = iptr->isn_lnum;
5944 emsg(_(e_list_value_does_not_have_enough_items));
5945 goto on_error;
5946 }
5947 else if (!semicolon && l->lv_len > count)
5948 {
5949 SOURCING_LNUM = iptr->isn_lnum;
5950 emsg(_(e_list_value_has_more_items_than_targets));
5951 goto on_error;
5952 }
5953
5954 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar35578162021-08-02 19:10:38 +02005955 if (GA_GROW_FAILS(&ectx->ec_stack, count - 1))
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02005956 goto theend;
Bram Moolenaar4c137212021-04-19 16:48:48 +02005957 ectx->ec_stack.ga_len += count - 1;
Bram Moolenaar792f7862020-11-23 08:31:18 +01005958
5959 // Variable after semicolon gets a list with the remaining
5960 // items.
5961 if (semicolon)
5962 {
5963 list_T *rem_list =
5964 list_alloc_with_items(l->lv_len - count + 1);
5965
5966 if (rem_list == NULL)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02005967 goto theend;
Bram Moolenaar792f7862020-11-23 08:31:18 +01005968 tv = STACK_TV_BOT(-count);
5969 tv->vval.v_list = rem_list;
5970 ++rem_list->lv_refcount;
5971 tv->v_lock = 0;
5972 li = l->lv_first;
5973 for (i = 0; i < count - 1; ++i)
5974 li = li->li_next;
5975 for (i = 0; li != NULL; ++i)
5976 {
Bram Moolenaar61efa162022-03-18 13:10:48 +00005977 typval_T tvcopy;
5978
5979 copy_tv(&li->li_tv, &tvcopy);
5980 list_set_item(rem_list, i, &tvcopy);
Bram Moolenaar792f7862020-11-23 08:31:18 +01005981 li = li->li_next;
5982 }
5983 --count;
5984 }
5985
5986 // Produce the values in reverse order, first item last.
5987 li = l->lv_first;
5988 for (i = 0; i < count; ++i)
5989 {
5990 tv = STACK_TV_BOT(-i - 1);
5991 copy_tv(&li->li_tv, tv);
5992 li = li->li_next;
5993 }
5994
5995 list_unref(l);
5996 }
5997 break;
5998
Bram Moolenaarb2049902021-01-24 12:53:53 +01005999 case ISN_PROF_START:
6000 case ISN_PROF_END:
6001 {
Bram Moolenaarf002a412021-01-24 13:34:18 +01006002#ifdef FEAT_PROFILE
Bram Moolenaarca16c602022-09-06 18:57:08 +01006003 funccall_T cookie;
6004 ufunc_T *cur_ufunc =
Bram Moolenaarb2049902021-01-24 12:53:53 +01006005 (((dfunc_T *)def_functions.ga_data)
Bram Moolenaarb69c6fb2021-06-14 20:40:37 +02006006 + ectx->ec_dfunc_idx)->df_ufunc;
Bram Moolenaarb2049902021-01-24 12:53:53 +01006007
Bram Moolenaarca16c602022-09-06 18:57:08 +01006008 cookie.fc_func = cur_ufunc;
Bram Moolenaarb2049902021-01-24 12:53:53 +01006009 if (iptr->isn_type == ISN_PROF_START)
6010 {
6011 func_line_start(&cookie, iptr->isn_lnum);
6012 // if we get here the instruction is executed
6013 func_line_exec(&cookie);
6014 }
6015 else
6016 func_line_end(&cookie);
Bram Moolenaarf002a412021-01-24 13:34:18 +01006017#endif
Bram Moolenaarb2049902021-01-24 12:53:53 +01006018 }
6019 break;
6020
Bram Moolenaare99d4222021-06-13 14:01:26 +02006021 case ISN_DEBUG:
Bram Moolenaar4f8f5422021-06-20 19:28:14 +02006022 handle_debug(iptr, ectx);
Bram Moolenaare99d4222021-06-13 14:01:26 +02006023 break;
6024
Bram Moolenaar389df252020-07-09 21:20:47 +02006025 case ISN_SHUFFLE:
6026 {
Bram Moolenaar792f7862020-11-23 08:31:18 +01006027 typval_T tmp_tv;
6028 int item = iptr->isn_arg.shuffle.shfl_item;
6029 int up = iptr->isn_arg.shuffle.shfl_up;
Bram Moolenaar389df252020-07-09 21:20:47 +02006030
6031 tmp_tv = *STACK_TV_BOT(-item);
6032 for ( ; up > 0 && item > 1; --up)
6033 {
6034 *STACK_TV_BOT(-item) = *STACK_TV_BOT(-item + 1);
6035 --item;
6036 }
6037 *STACK_TV_BOT(-item) = tmp_tv;
6038 }
6039 break;
6040
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006041 case ISN_DROP:
Bram Moolenaar4c137212021-04-19 16:48:48 +02006042 --ectx->ec_stack.ga_len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006043 clear_tv(STACK_TV_BOT(0));
LemonBoyc5d27442023-08-19 13:02:35 +02006044 ectx->ec_where = (where_T)WHERE_INIT;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006045 break;
6046 }
Bram Moolenaarf0b9f432020-07-17 23:03:17 +02006047 continue;
6048
Bram Moolenaard032f342020-07-18 18:13:02 +02006049func_return:
Bram Moolenaar7cbfaa52020-09-18 21:25:32 +02006050 // Restore previous function. If the frame pointer is where we started
6051 // then there is none and we are done.
Bram Moolenaar4c137212021-04-19 16:48:48 +02006052 if (ectx->ec_frame_idx == ectx->ec_initial_frame_idx)
Bram Moolenaard032f342020-07-18 18:13:02 +02006053 goto done;
Bram Moolenaar7cbfaa52020-09-18 21:25:32 +02006054
Bram Moolenaar4c137212021-04-19 16:48:48 +02006055 if (func_return(ectx) == FAIL)
Bram Moolenaard032f342020-07-18 18:13:02 +02006056 // only fails when out of memory
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02006057 goto theend;
Bram Moolenaarc7db5772020-07-21 20:55:50 +02006058 continue;
Bram Moolenaard032f342020-07-18 18:13:02 +02006059
Bram Moolenaarf0b9f432020-07-17 23:03:17 +02006060on_error:
Bram Moolenaaraf0df472020-12-02 20:51:22 +01006061 // Jump here for an error that does not require aborting execution.
Bram Moolenaar56602ba2020-12-05 21:22:08 +01006062 // If "emsg_silent" is set then ignore the error, unless it was set
6063 // when calling the function.
Bram Moolenaar4c137212021-04-19 16:48:48 +02006064 if (did_emsg_cumul + did_emsg == ectx->ec_did_emsg_before
Bram Moolenaar56602ba2020-12-05 21:22:08 +01006065 && emsg_silent && did_emsg_def == 0)
Bram Moolenaarf9041332021-01-21 19:41:16 +01006066 {
6067 // If a sequence of instructions causes an error while ":silent!"
6068 // was used, restore the stack length and jump ahead to restoring
6069 // the cmdmod.
Bram Moolenaar4c137212021-04-19 16:48:48 +02006070 if (ectx->ec_funclocal.floc_restore_cmdmod)
Bram Moolenaarf9041332021-01-21 19:41:16 +01006071 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02006072 while (ectx->ec_stack.ga_len
6073 > ectx->ec_funclocal.floc_restore_cmdmod_stacklen)
Bram Moolenaarf9041332021-01-21 19:41:16 +01006074 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02006075 --ectx->ec_stack.ga_len;
Bram Moolenaarf9041332021-01-21 19:41:16 +01006076 clear_tv(STACK_TV_BOT(0));
6077 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02006078 while (ectx->ec_instr[ectx->ec_iidx].isn_type != ISN_CMDMOD_REV)
6079 ++ectx->ec_iidx;
Bram Moolenaarf9041332021-01-21 19:41:16 +01006080 }
Bram Moolenaarcd030c42020-10-30 21:49:40 +01006081 continue;
Bram Moolenaarf9041332021-01-21 19:41:16 +01006082 }
Bram Moolenaaraf0df472020-12-02 20:51:22 +01006083on_fatal_error:
6084 // Jump here for an error that messes up the stack.
Bram Moolenaar171fb922020-10-28 16:54:47 +01006085 // If we are not inside a try-catch started here, abort execution.
Bram Moolenaar4c137212021-04-19 16:48:48 +02006086 if (trylevel <= ectx->ec_trylevel_at_start)
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02006087 goto theend;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006088 }
6089
6090done:
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02006091 ret = OK;
6092theend:
Bram Moolenaar58779852022-09-06 18:31:14 +01006093 may_invoke_defer_funcs(ectx);
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006094
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02006095 dict_stack_clear(dict_stack_len_at_start);
Bram Moolenaarcbe178e2021-05-18 17:49:59 +02006096 ectx->ec_trylevel_at_start = save_trylevel_at_start;
6097 return ret;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006098}
6099
6100/*
Bram Moolenaar806a2732022-09-04 15:40:36 +01006101 * Execute the instructions from a VAR_INSTR typval and put the result in
Bram Moolenaarf18332f2021-05-07 17:55:55 +02006102 * "rettv".
6103 * Return OK or FAIL.
6104 */
6105 int
6106exe_typval_instr(typval_T *tv, typval_T *rettv)
6107{
6108 ectx_T *ectx = tv->vval.v_instr->instr_ectx;
6109 isn_T *save_instr = ectx->ec_instr;
6110 int save_iidx = ectx->ec_iidx;
6111 int res;
6112
LemonBoyf3b48952022-05-05 13:53:03 +01006113 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
6114 // even when the compilation fails.
6115 rettv->v_type = VAR_UNKNOWN;
6116
Bram Moolenaarf18332f2021-05-07 17:55:55 +02006117 ectx->ec_instr = tv->vval.v_instr->instr_instr;
6118 res = exec_instructions(ectx);
6119 if (res == OK)
6120 {
6121 *rettv = *STACK_TV_BOT(-1);
6122 --ectx->ec_stack.ga_len;
6123 }
6124
6125 ectx->ec_instr = save_instr;
6126 ectx->ec_iidx = save_iidx;
6127
6128 return res;
6129}
6130
6131/*
Bram Moolenaar4c137212021-04-19 16:48:48 +02006132 * Execute the instructions from an ISN_SUBSTITUTE command, which are in
6133 * "substitute_instr".
6134 */
6135 char_u *
6136exe_substitute_instr(void)
6137{
6138 ectx_T *ectx = substitute_instr->subs_ectx;
6139 isn_T *save_instr = ectx->ec_instr;
6140 int save_iidx = ectx->ec_iidx;
6141 char_u *res;
6142
6143 ectx->ec_instr = substitute_instr->subs_instr;
6144 if (exec_instructions(ectx) == OK)
Bram Moolenaar90193e62021-04-04 20:49:50 +02006145 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02006146 typval_T *tv = STACK_TV_BOT(-1);
6147
Bram Moolenaar27523602021-06-05 21:36:19 +02006148 res = typval2string(tv, TRUE);
Bram Moolenaar4c137212021-04-19 16:48:48 +02006149 --ectx->ec_stack.ga_len;
6150 clear_tv(tv);
Bram Moolenaar90193e62021-04-04 20:49:50 +02006151 }
6152 else
6153 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02006154 substitute_instr->subs_status = FAIL;
6155 res = vim_strsave((char_u *)"");
Bram Moolenaar90193e62021-04-04 20:49:50 +02006156 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006157
Bram Moolenaar4c137212021-04-19 16:48:48 +02006158 ectx->ec_instr = save_instr;
6159 ectx->ec_iidx = save_iidx;
6160
6161 return res;
6162}
6163
6164/*
6165 * Call a "def" function from old Vim script.
6166 * Return OK or FAIL.
6167 */
6168 int
6169call_def_function(
6170 ufunc_T *ufunc,
6171 int argc_arg, // nr of arguments
6172 typval_T *argv, // arguments
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01006173 int flags, // DEF_ flags
Bram Moolenaar4c137212021-04-19 16:48:48 +02006174 partial_T *partial, // optional partial for context
Bram Moolenaarffdaca92022-12-09 21:41:48 +00006175 object_T *object, // object, e.g. for this.Func()
Bram Moolenaar58779852022-09-06 18:31:14 +01006176 funccall_T *funccal,
Bram Moolenaar4c137212021-04-19 16:48:48 +02006177 typval_T *rettv) // return value
6178{
6179 ectx_T ectx; // execution context
6180 int argc = argc_arg;
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01006181 int partial_argc = partial == NULL
6182 || (flags & DEF_USE_PT_ARGV) == 0
6183 ? 0 : partial->pt_argc;
6184 int total_argc = argc + partial_argc;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006185 typval_T *tv;
6186 int idx;
6187 int ret = FAIL;
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01006188 int defcount = ufunc->uf_args.ga_len - total_argc;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006189 sctx_T save_current_sctx = current_sctx;
6190 int did_emsg_before = did_emsg_cumul + did_emsg;
6191 int save_suppress_errthrow = suppress_errthrow;
6192 msglist_T **saved_msg_list = NULL;
6193 msglist_T *private_msg_list = NULL;
6194 int save_emsg_silent_def = emsg_silent_def;
6195 int save_did_emsg_def = did_emsg_def;
6196 int orig_funcdepth;
Bram Moolenaare99d4222021-06-13 14:01:26 +02006197 int orig_nesting_level = ex_nesting_level;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006198
6199// Get pointer to item in the stack.
6200#undef STACK_TV
6201#define STACK_TV(idx) (((typval_T *)ectx.ec_stack.ga_data) + idx)
6202
6203// Get pointer to item at the bottom of the stack, -1 is the bottom.
6204#undef STACK_TV_BOT
6205#define STACK_TV_BOT(idx) (((typval_T *)ectx.ec_stack.ga_data) + ectx.ec_stack.ga_len + idx)
6206
6207// Get pointer to a local variable on the stack. Negative for arguments.
6208#undef STACK_TV_VAR
6209#define STACK_TV_VAR(idx) (((typval_T *)ectx.ec_stack.ga_data) + ectx.ec_frame_idx + STACK_FRAME_SIZE + idx)
6210
6211 if (ufunc->uf_def_status == UF_NOT_COMPILED
6212 || ufunc->uf_def_status == UF_COMPILE_ERROR
Bram Moolenaar139575d2022-03-15 19:29:30 +00006213 || (func_needs_compiling(ufunc, get_compile_type(ufunc))
6214 && compile_def_function(ufunc, FALSE,
6215 get_compile_type(ufunc), NULL) == FAIL))
Bram Moolenaar4c137212021-04-19 16:48:48 +02006216 {
6217 if (did_emsg_cumul + did_emsg == did_emsg_before)
6218 semsg(_(e_function_is_not_compiled_str),
6219 printable_func_name(ufunc));
6220 return FAIL;
6221 }
6222
6223 {
6224 // Check the function was really compiled.
6225 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
6226 + ufunc->uf_dfunc_idx;
Bram Moolenaarcc341812022-09-19 15:54:34 +01006227 if (dfunc->df_ufunc == NULL)
6228 {
6229 semsg(_(e_function_was_deleted_str), printable_func_name(ufunc));
6230 return FAIL;
6231 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02006232 if (INSTRUCTIONS(dfunc) == NULL)
6233 {
6234 iemsg("using call_def_function() on not compiled function");
6235 return FAIL;
6236 }
6237 }
6238
6239 // If depth of calling is getting too high, don't execute the function.
6240 orig_funcdepth = funcdepth_get();
6241 if (funcdepth_increment() == FAIL)
6242 return FAIL;
6243
6244 CLEAR_FIELD(ectx);
6245 ectx.ec_dfunc_idx = ufunc->uf_dfunc_idx;
6246 ga_init2(&ectx.ec_stack, sizeof(typval_T), 500);
Bram Moolenaar35578162021-08-02 19:10:38 +02006247 if (GA_GROW_FAILS(&ectx.ec_stack, 20))
Bram Moolenaar4c137212021-04-19 16:48:48 +02006248 {
6249 funcdepth_decrement();
6250 return FAIL;
6251 }
6252 ga_init2(&ectx.ec_trystack, sizeof(trycmd_T), 10);
6253 ga_init2(&ectx.ec_funcrefs, sizeof(partial_T *), 10);
6254 ectx.ec_did_emsg_before = did_emsg_before;
Bram Moolenaare99d4222021-06-13 14:01:26 +02006255 ++ex_nesting_level;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006256
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01006257 idx = total_argc - ufunc->uf_args.ga_len;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006258 if (idx > 0 && ufunc->uf_va_name == NULL)
6259 {
Matvey Tarasovd14bb1a2022-06-29 13:18:27 +01006260 semsg(NGETTEXT(e_one_argument_too_many, e_nr_arguments_too_many,
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01006261 idx), idx);
Bram Moolenaar4c137212021-04-19 16:48:48 +02006262 goto failed_early;
6263 }
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01006264 idx = total_argc - ufunc->uf_args.ga_len + ufunc->uf_def_args.ga_len;
Bram Moolenaarc6d71532021-06-05 18:49:38 +02006265 if (idx < 0)
Bram Moolenaar8da6d6d2021-06-05 18:15:09 +02006266 {
Matvey Tarasovd14bb1a2022-06-29 13:18:27 +01006267 semsg(NGETTEXT(e_one_argument_too_few, e_nr_arguments_too_few,
Bram Moolenaar98aff652022-09-06 21:02:35 +01006268 -idx), -idx);
Bram Moolenaar8da6d6d2021-06-05 18:15:09 +02006269 goto failed_early;
6270 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02006271
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01006272 // Put values from the partial and arguments on the stack, but no more than
6273 // what the function expects. A lambda can be called with more arguments
6274 // than it uses.
6275 for (idx = 0; idx < total_argc
Bram Moolenaar4c137212021-04-19 16:48:48 +02006276 && (ufunc->uf_va_name != NULL || idx < ufunc->uf_args.ga_len);
6277 ++idx)
6278 {
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01006279 int argv_idx = idx - partial_argc;
6280
6281 tv = idx < partial_argc ? partial->pt_argv + idx : argv + argv_idx;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006282 if (idx >= ufunc->uf_args.ga_len - ufunc->uf_def_args.ga_len
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01006283 && tv->v_type == VAR_SPECIAL
6284 && tv->vval.v_number == VVAL_NONE)
Bram Moolenaar4c137212021-04-19 16:48:48 +02006285 {
6286 // Use the default value.
6287 STACK_TV_BOT(0)->v_type = VAR_UNKNOWN;
6288 }
6289 else
6290 {
Bram Moolenaar47bba532023-01-20 18:49:46 +00006291 int done = FALSE;
6292 if (ufunc->uf_arg_types != NULL && idx < ufunc->uf_args.ga_len)
6293 {
6294 type_T *expected = ufunc->uf_arg_types[idx];
6295 if (expected->tt_type == VAR_FLOAT && tv->v_type == VAR_NUMBER)
6296 {
6297 // When a float is expected and a number was given, convert
6298 // the value.
6299 STACK_TV_BOT(0)->v_type = VAR_FLOAT;
6300 STACK_TV_BOT(0)->v_lock = 0;
6301 STACK_TV_BOT(0)->vval.v_float = tv->vval.v_number;
6302 done = TRUE;
6303 }
6304 else if (check_typval_arg_type(expected, tv,
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01006305 NULL, argv_idx + 1) == FAIL)
Bram Moolenaar47bba532023-01-20 18:49:46 +00006306 goto failed_early;
6307 }
6308 if (!done)
6309 copy_tv(tv, STACK_TV_BOT(0));
Bram Moolenaar4c137212021-04-19 16:48:48 +02006310 }
6311 ++ectx.ec_stack.ga_len;
6312 }
6313
6314 // Turn varargs into a list. Empty list if no args.
6315 if (ufunc->uf_va_name != NULL)
6316 {
6317 int vararg_count = argc - ufunc->uf_args.ga_len;
6318
6319 if (vararg_count < 0)
6320 vararg_count = 0;
6321 else
6322 argc -= vararg_count;
6323 if (exe_newlist(vararg_count, &ectx) == FAIL)
6324 goto failed_early;
6325
6326 // Check the type of the list items.
6327 tv = STACK_TV_BOT(-1);
6328 if (ufunc->uf_va_type != NULL
6329 && ufunc->uf_va_type != &t_list_any
6330 && ufunc->uf_va_type->tt_member != &t_any
6331 && tv->vval.v_list != NULL)
6332 {
6333 type_T *expected = ufunc->uf_va_type->tt_member;
6334 listitem_T *li = tv->vval.v_list->lv_first;
6335
6336 for (idx = 0; idx < vararg_count; ++idx)
6337 {
6338 if (check_typval_arg_type(expected, &li->li_tv,
Bram Moolenaar7a3fe3e2021-07-22 14:58:47 +02006339 NULL, argc + idx + 1) == FAIL)
Bram Moolenaar4c137212021-04-19 16:48:48 +02006340 goto failed_early;
6341 li = li->li_next;
6342 }
6343 }
6344
6345 if (defcount > 0)
6346 // Move varargs list to below missing default arguments.
6347 *STACK_TV_BOT(defcount - 1) = *STACK_TV_BOT(-1);
6348 --ectx.ec_stack.ga_len;
6349 }
6350
6351 // Make space for omitted arguments, will store default value below.
6352 // Any varargs list goes after them.
6353 if (defcount > 0)
6354 for (idx = 0; idx < defcount; ++idx)
6355 {
6356 STACK_TV_BOT(0)->v_type = VAR_UNKNOWN;
6357 ++ectx.ec_stack.ga_len;
6358 }
6359 if (ufunc->uf_va_name != NULL)
6360 ++ectx.ec_stack.ga_len;
6361
6362 // Frame pointer points to just after arguments.
6363 ectx.ec_frame_idx = ectx.ec_stack.ga_len;
6364 ectx.ec_initial_frame_idx = ectx.ec_frame_idx;
6365
6366 {
6367 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
6368 + ufunc->uf_dfunc_idx;
6369 ufunc_T *base_ufunc = dfunc->df_ufunc;
6370
6371 // "uf_partial" is on the ufunc that "df_ufunc" points to, as is done
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01006372 // by copy_lambda_to_global_func().
Bram Moolenaar4c137212021-04-19 16:48:48 +02006373 if (partial != NULL || base_ufunc->uf_partial != NULL)
6374 {
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02006375 ectx.ec_outer_ref = ALLOC_CLEAR_ONE(outer_ref_T);
6376 if (ectx.ec_outer_ref == NULL)
Bram Moolenaar4c137212021-04-19 16:48:48 +02006377 goto failed_early;
6378 if (partial != NULL)
6379 {
Bram Moolenaar7aca5ca2022-02-07 19:56:43 +00006380 outer_T *outer = get_pt_outer(partial);
6381
Bram Moolenaar6d313be2022-09-22 16:36:25 +01006382 if (outer->out_stack == NULL && outer->out_loop_size == 0)
Bram Moolenaar4c137212021-04-19 16:48:48 +02006383 {
Bram Moolenaar6d313be2022-09-22 16:36:25 +01006384 // no stack was set
Bram Moolenaarfe1bfc92022-02-06 13:55:03 +00006385 if (current_ectx != NULL)
6386 {
6387 if (current_ectx->ec_outer_ref != NULL
6388 && current_ectx->ec_outer_ref->or_outer != NULL)
6389 ectx.ec_outer_ref->or_outer =
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02006390 current_ectx->ec_outer_ref->or_outer;
Bram Moolenaarfe1bfc92022-02-06 13:55:03 +00006391 }
Bram Moolenaar0cdfb7c2022-09-17 15:44:52 +01006392 // else: should there be an error here?
Bram Moolenaar4c137212021-04-19 16:48:48 +02006393 }
6394 else
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02006395 {
Bram Moolenaar7aca5ca2022-02-07 19:56:43 +00006396 ectx.ec_outer_ref->or_outer = outer;
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02006397 ++partial->pt_refcount;
6398 ectx.ec_outer_ref->or_partial = partial;
6399 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02006400 }
6401 else
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02006402 {
6403 ectx.ec_outer_ref->or_outer = &base_ufunc->uf_partial->pt_outer;
6404 ++base_ufunc->uf_partial->pt_refcount;
6405 ectx.ec_outer_ref->or_partial = base_ufunc->uf_partial;
6406 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02006407 }
6408 }
6409
6410 // dummy frame entries
6411 for (idx = 0; idx < STACK_FRAME_SIZE; ++idx)
6412 {
6413 STACK_TV(ectx.ec_stack.ga_len)->v_type = VAR_UNKNOWN;
6414 ++ectx.ec_stack.ga_len;
6415 }
6416
6417 {
6418 // Reserve space for local variables and any closure reference count.
6419 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data)
6420 + ufunc->uf_dfunc_idx;
6421
Bram Moolenaar5cd64792021-12-25 18:23:24 +00006422 // Initialize variables to zero. That avoids having to generate
6423 // initializing instructions for "var nr: number", "var x: any", etc.
Bram Moolenaar4c137212021-04-19 16:48:48 +02006424 for (idx = 0; idx < dfunc->df_varcount; ++idx)
Bram Moolenaar5cd64792021-12-25 18:23:24 +00006425 {
6426 STACK_TV_VAR(idx)->v_type = VAR_NUMBER;
6427 STACK_TV_VAR(idx)->vval.v_number = 0;
6428 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02006429 ectx.ec_stack.ga_len += dfunc->df_varcount;
Bram Moolenaarffdaca92022-12-09 21:41:48 +00006430
6431 if (object != NULL)
6432 {
6433 // the object is always the variable at index zero
6434 tv = STACK_TV_VAR(0);
6435 tv->v_type = VAR_OBJECT;
6436 tv->vval.v_object = object;
6437 }
6438
Bram Moolenaar4c137212021-04-19 16:48:48 +02006439 if (dfunc->df_has_closure)
6440 {
Bram Moolenaarcc341812022-09-19 15:54:34 +01006441 // Initialize the variable that counts how many closures were
6442 // created. This is used in handle_closure_in_use().
Bram Moolenaar4c137212021-04-19 16:48:48 +02006443 STACK_TV_VAR(idx)->v_type = VAR_NUMBER;
6444 STACK_TV_VAR(idx)->vval.v_number = 0;
6445 ++ectx.ec_stack.ga_len;
6446 }
6447
6448 ectx.ec_instr = INSTRUCTIONS(dfunc);
6449 }
6450
Bram Moolenaar58779852022-09-06 18:31:14 +01006451 // Store the execution context in funccal, used by invoke_all_defer().
6452 if (funccal != NULL)
6453 funccal->fc_ectx = &ectx;
6454
Bram Moolenaar4c137212021-04-19 16:48:48 +02006455 // Following errors are in the function, not the caller.
6456 // Commands behave like vim9script.
6457 estack_push_ufunc(ufunc, 1);
6458 current_sctx = ufunc->uf_script_ctx;
6459 current_sctx.sc_version = SCRIPT_VERSION_VIM9;
6460
6461 // Use a specific location for storing error messages to be converted to an
6462 // exception.
6463 saved_msg_list = msg_list;
6464 msg_list = &private_msg_list;
6465
6466 // Do turn errors into exceptions.
6467 suppress_errthrow = FALSE;
6468
6469 // Do not delete the function while executing it.
6470 ++ufunc->uf_calls;
6471
6472 // When ":silent!" was used before calling then we still abort the
6473 // function. If ":silent!" is used in the function then we don't.
6474 emsg_silent_def = emsg_silent;
6475 did_emsg_def = 0;
6476
LemonBoyc5d27442023-08-19 13:02:35 +02006477 ectx.ec_where = (where_T)WHERE_INIT;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006478
Bram Moolenaar5800c792022-09-22 17:34:01 +01006479 /*
6480 * Execute the instructions until done.
6481 */
Bram Moolenaar4c137212021-04-19 16:48:48 +02006482 ret = exec_instructions(&ectx);
6483 if (ret == OK)
6484 {
6485 // function finished, get result from the stack.
6486 if (ufunc->uf_ret_type == &t_void)
6487 {
6488 rettv->v_type = VAR_VOID;
6489 }
6490 else
6491 {
6492 tv = STACK_TV_BOT(-1);
6493 *rettv = *tv;
6494 tv->v_type = VAR_UNKNOWN;
6495 }
6496 }
6497
Bram Moolenaar7eeefd42020-02-26 21:24:23 +01006498 // When failed need to unwind the call stack.
Bram Moolenaar58779852022-09-06 18:31:14 +01006499 unwind_def_callstack(&ectx);
Bram Moolenaarbf67ea12020-05-02 17:52:42 +02006500
Bram Moolenaarc70bdab2020-09-26 19:59:38 +02006501 // Deal with any remaining closures, they may be in use somewhere.
6502 if (ectx.ec_funcrefs.ga_len > 0)
Bram Moolenaarf112f302020-12-20 17:47:52 +01006503 {
Bram Moolenaarc70bdab2020-09-26 19:59:38 +02006504 handle_closure_in_use(&ectx, FALSE);
Bram Moolenaardc7c3662021-12-20 15:04:29 +00006505 ga_clear(&ectx.ec_funcrefs);
Bram Moolenaarf112f302020-12-20 17:47:52 +01006506 }
Bram Moolenaarc70bdab2020-09-26 19:59:38 +02006507
Bram Moolenaaree8580e2020-08-28 17:19:07 +02006508 estack_pop();
6509 current_sctx = save_current_sctx;
6510
Bram Moolenaar2336c372021-12-06 15:06:54 +00006511 if (--ufunc->uf_calls <= 0 && ufunc->uf_refcount <= 0)
6512 // Function was unreferenced while being used, free it now.
6513 func_clear_free(ufunc, FALSE);
Bram Moolenaarc970e422021-03-17 15:03:04 +01006514
Bram Moolenaar352134b2020-10-17 22:04:08 +02006515 if (*msg_list != NULL && saved_msg_list != NULL)
6516 {
6517 msglist_T **plist = saved_msg_list;
6518
6519 // Append entries from the current msg_list (uncaught exceptions) to
6520 // the saved msg_list.
6521 while (*plist != NULL)
6522 plist = &(*plist)->next;
6523
6524 *plist = *msg_list;
6525 }
6526 msg_list = saved_msg_list;
6527
Bram Moolenaar4c137212021-04-19 16:48:48 +02006528 if (ectx.ec_funclocal.floc_restore_cmdmod)
Bram Moolenaar02194d22020-10-24 23:08:38 +02006529 {
6530 cmdmod.cmod_filter_regmatch.regprog = NULL;
6531 undo_cmdmod(&cmdmod);
Bram Moolenaar4c137212021-04-19 16:48:48 +02006532 cmdmod = ectx.ec_funclocal.floc_save_cmdmod;
Bram Moolenaar02194d22020-10-24 23:08:38 +02006533 }
Bram Moolenaar56602ba2020-12-05 21:22:08 +01006534 emsg_silent_def = save_emsg_silent_def;
6535 did_emsg_def += save_did_emsg_def;
Bram Moolenaarf4c6e1e2020-10-23 18:02:32 +02006536
Bram Moolenaaree8580e2020-08-28 17:19:07 +02006537failed_early:
Bram Moolenaar0d1f55c2022-04-05 17:30:29 +01006538 // Free all arguments and local variables.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006539 for (idx = 0; idx < ectx.ec_stack.ga_len; ++idx)
Bram Moolenaar1936c762022-09-28 15:19:10 +01006540 {
6541 tv = STACK_TV(idx);
6542 if (tv->v_type != VAR_NUMBER && tv->v_type != VAR_UNKNOWN)
6543 clear_tv(tv);
6544 }
Bram Moolenaare99d4222021-06-13 14:01:26 +02006545 ex_nesting_level = orig_nesting_level;
Bram Moolenaarbf67ea12020-05-02 17:52:42 +02006546
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006547 vim_free(ectx.ec_stack.ga_data);
Bram Moolenaar20431c92020-03-20 18:39:46 +01006548 vim_free(ectx.ec_trystack.ga_data);
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02006549 if (ectx.ec_outer_ref != NULL)
Bram Moolenaar0186e582021-01-10 18:33:11 +01006550 {
Bram Moolenaarc04f2a42021-06-09 19:30:03 +02006551 if (ectx.ec_outer_ref->or_outer_allocated)
6552 vim_free(ectx.ec_outer_ref->or_outer);
6553 partial_unref(ectx.ec_outer_ref->or_partial);
6554 vim_free(ectx.ec_outer_ref);
Bram Moolenaar0186e582021-01-10 18:33:11 +01006555 }
6556
Bram Moolenaar77e5dcc2020-09-17 21:29:03 +02006557 // Not sure if this is necessary.
6558 suppress_errthrow = save_suppress_errthrow;
6559
Bram Moolenaarb5841b92021-07-15 18:09:53 +02006560 if (ret != OK && did_emsg_cumul + did_emsg == did_emsg_before
6561 && !need_rethrow)
Bram Moolenaar451c2e32020-08-15 16:33:28 +02006562 semsg(_(e_unknown_error_while_executing_str),
Bram Moolenaar682d0a12020-07-19 20:48:59 +02006563 printable_func_name(ufunc));
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01006564 funcdepth_restore(orig_funcdepth);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006565 return ret;
6566}
6567
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006568/*
Bram Moolenaar58779852022-09-06 18:31:14 +01006569 * Called when a def function has finished (possibly failed).
6570 * Invoke all the function returns to clean up and invoke deferred functions,
6571 * except the toplevel one.
6572 */
6573 void
6574unwind_def_callstack(ectx_T *ectx)
6575{
6576 while (ectx->ec_frame_idx != ectx->ec_initial_frame_idx)
6577 func_return(ectx);
6578}
6579
6580/*
dundargocc57b5bc2022-11-02 13:30:51 +00006581 * Invoke any deferred functions for the top function in "ectx".
Bram Moolenaar58779852022-09-06 18:31:14 +01006582 */
6583 void
6584may_invoke_defer_funcs(ectx_T *ectx)
6585{
6586 dfunc_T *dfunc = ((dfunc_T *)def_functions.ga_data) + ectx->ec_dfunc_idx;
6587
6588 if (dfunc->df_defer_var_idx > 0)
6589 invoke_defer_funcs(ectx);
6590}
6591
6592/*
Bram Moolenaarcc341812022-09-19 15:54:34 +01006593 * Return loopvarinfo in a printable form in allocated memory.
6594 */
6595 static char_u *
6596printable_loopvarinfo(loopvarinfo_T *lvi)
6597{
6598 garray_T ga;
6599 int depth;
6600
6601 ga_init2(&ga, 1, 100);
6602 for (depth = 0; depth < lvi->lvi_depth; ++depth)
6603 {
6604 if (ga_grow(&ga, 50) == FAIL)
6605 break;
6606 if (lvi->lvi_loop[depth].var_idx == 0)
Bram Moolenaarc9e4a6f2022-09-19 16:08:04 +01006607 STRCPY((char *)ga.ga_data + ga.ga_len, " -");
Bram Moolenaarcc341812022-09-19 15:54:34 +01006608 else
Bram Moolenaarc9e4a6f2022-09-19 16:08:04 +01006609 vim_snprintf((char *)ga.ga_data + ga.ga_len, 50, " $%d-$%d",
Bram Moolenaarcc341812022-09-19 15:54:34 +01006610 lvi->lvi_loop[depth].var_idx,
6611 lvi->lvi_loop[depth].var_idx
6612 + lvi->lvi_loop[depth].var_count - 1);
Bram Moolenaarc9e4a6f2022-09-19 16:08:04 +01006613 ga.ga_len = (int)STRLEN(ga.ga_data);
Bram Moolenaarcc341812022-09-19 15:54:34 +01006614 }
6615 return ga.ga_data;
6616}
6617
6618/*
Bram Moolenaar4c137212021-04-19 16:48:48 +02006619 * List instructions "instr" up to "instr_count" or until ISN_FINISH.
6620 * "ufunc" has the source lines, NULL for the instructions of ISN_SUBSTITUTE.
6621 * "pfx" is prefixed to every line.
6622 */
6623 static void
6624list_instructions(char *pfx, isn_T *instr, int instr_count, ufunc_T *ufunc)
6625{
6626 int line_idx = 0;
6627 int prev_current = 0;
6628 int current;
Bram Moolenaar9ce47ec2021-04-20 22:16:39 +02006629 int def_arg_idx = 0;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006630
6631 for (current = 0; current < instr_count; ++current)
6632 {
6633 isn_T *iptr = &instr[current];
6634 char *line;
6635
6636 if (ufunc != NULL)
Bram Moolenaar9ce47ec2021-04-20 22:16:39 +02006637 {
Bram Moolenaar4c137212021-04-19 16:48:48 +02006638 while (line_idx < iptr->isn_lnum
6639 && line_idx < ufunc->uf_lines.ga_len)
6640 {
6641 if (current > prev_current)
6642 {
6643 msg_puts("\n\n");
6644 prev_current = current;
6645 }
6646 line = ((char **)ufunc->uf_lines.ga_data)[line_idx++];
6647 if (line != NULL)
6648 msg(line);
6649 }
Bram Moolenaar9ce47ec2021-04-20 22:16:39 +02006650 if (iptr->isn_type == ISN_JUMP_IF_ARG_SET)
6651 {
6652 int first_def_arg = ufunc->uf_args.ga_len
6653 - ufunc->uf_def_args.ga_len;
6654
6655 if (def_arg_idx > 0)
6656 msg_puts("\n\n");
6657 msg_start();
6658 msg_puts(" ");
6659 msg_puts(((char **)(ufunc->uf_args.ga_data))[
6660 first_def_arg + def_arg_idx]);
6661 msg_puts(" = ");
6662 msg_puts(((char **)(ufunc->uf_def_args.ga_data))[def_arg_idx++]);
6663 msg_clr_eos();
6664 msg_end();
6665 }
6666 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02006667
6668 switch (iptr->isn_type)
6669 {
Bram Moolenaar00b28d62022-12-08 15:32:33 +00006670 case ISN_CONSTRUCT:
6671 smsg("%s%4d NEW %s size %d", pfx, current,
6672 iptr->isn_arg.construct.construct_class->class_name,
6673 (int)iptr->isn_arg.construct.construct_size);
6674 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006675 case ISN_EXEC:
6676 smsg("%s%4d EXEC %s", pfx, current, iptr->isn_arg.string);
6677 break;
Bram Moolenaar20677332021-06-06 17:02:53 +02006678 case ISN_EXEC_SPLIT:
6679 smsg("%s%4d EXEC_SPLIT %s", pfx, current, iptr->isn_arg.string);
6680 break;
Bram Moolenaare4eed8c2021-12-01 15:22:56 +00006681 case ISN_EXECRANGE:
6682 smsg("%s%4d EXECRANGE %s", pfx, current, iptr->isn_arg.string);
6683 break;
Bram Moolenaar3b1373b2021-05-17 00:01:42 +02006684 case ISN_LEGACY_EVAL:
6685 smsg("%s%4d EVAL legacy %s", pfx, current,
6686 iptr->isn_arg.string);
6687 break;
Bram Moolenaar2d1c57e2021-04-19 20:50:03 +02006688 case ISN_REDIRSTART:
6689 smsg("%s%4d REDIR", pfx, current);
6690 break;
6691 case ISN_REDIREND:
6692 smsg("%s%4d REDIR END%s", pfx, current,
6693 iptr->isn_arg.number ? " append" : "");
6694 break;
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02006695 case ISN_CEXPR_AUCMD:
Bram Moolenaarb7c97812021-05-05 22:51:39 +02006696#ifdef FEAT_QUICKFIX
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02006697 smsg("%s%4d CEXPR pre %s", pfx, current,
6698 cexpr_get_auname(iptr->isn_arg.number));
Bram Moolenaarb7c97812021-05-05 22:51:39 +02006699#endif
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02006700 break;
6701 case ISN_CEXPR_CORE:
Bram Moolenaarb7c97812021-05-05 22:51:39 +02006702#ifdef FEAT_QUICKFIX
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02006703 {
6704 cexprref_T *cer = iptr->isn_arg.cexpr.cexpr_ref;
6705
6706 smsg("%s%4d CEXPR core %s%s \"%s\"", pfx, current,
6707 cexpr_get_auname(cer->cer_cmdidx),
6708 cer->cer_forceit ? "!" : "",
6709 cer->cer_cmdline);
6710 }
Bram Moolenaarb7c97812021-05-05 22:51:39 +02006711#endif
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02006712 break;
Bram Moolenaarf18332f2021-05-07 17:55:55 +02006713 case ISN_INSTR:
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01006714 smsg("%s%4d INSTR", pfx, current);
6715 list_instructions(" ", iptr->isn_arg.instr, INT_MAX, NULL);
6716 msg(" -------------");
6717 break;
6718 case ISN_SOURCE:
Bram Moolenaarf18332f2021-05-07 17:55:55 +02006719 {
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01006720 scriptitem_T *si = SCRIPT_ITEM(iptr->isn_arg.number);
6721
6722 smsg("%s%4d SOURCE %s", pfx, current, si->sn_name);
Bram Moolenaarf18332f2021-05-07 17:55:55 +02006723 }
6724 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006725 case ISN_SUBSTITUTE:
6726 {
6727 subs_T *subs = &iptr->isn_arg.subs;
6728
6729 smsg("%s%4d SUBSTITUTE %s", pfx, current, subs->subs_cmd);
6730 list_instructions(" ", subs->subs_instr, INT_MAX, NULL);
6731 msg(" -------------");
6732 }
6733 break;
6734 case ISN_EXECCONCAT:
6735 smsg("%s%4d EXECCONCAT %lld", pfx, current,
6736 (varnumber_T)iptr->isn_arg.number);
6737 break;
6738 case ISN_ECHO:
6739 {
6740 echo_T *echo = &iptr->isn_arg.echo;
6741
6742 smsg("%s%4d %s %d", pfx, current,
6743 echo->echo_with_white ? "ECHO" : "ECHON",
6744 echo->echo_count);
6745 }
6746 break;
6747 case ISN_EXECUTE:
6748 smsg("%s%4d EXECUTE %lld", pfx, current,
Bram Moolenaar7de62622021-08-07 15:05:47 +02006749 (varnumber_T)(iptr->isn_arg.number));
Bram Moolenaar4c137212021-04-19 16:48:48 +02006750 break;
6751 case ISN_ECHOMSG:
6752 smsg("%s%4d ECHOMSG %lld", pfx, current,
Bram Moolenaar7de62622021-08-07 15:05:47 +02006753 (varnumber_T)(iptr->isn_arg.number));
6754 break;
Bram Moolenaar7d7ad7b2022-09-01 16:00:53 +01006755 case ISN_ECHOWINDOW:
Bram Moolenaarbdc09a12022-10-07 14:31:45 +01006756 if (iptr->isn_arg.echowin.ewin_time > 0)
6757 smsg("%s%4d ECHOWINDOW %d (%ld sec)", pfx, current,
6758 iptr->isn_arg.echowin.ewin_count,
6759 iptr->isn_arg.echowin.ewin_time);
6760 else
6761 smsg("%s%4d ECHOWINDOW %d", pfx, current,
6762 iptr->isn_arg.echowin.ewin_count);
Bram Moolenaar7d7ad7b2022-09-01 16:00:53 +01006763 break;
Bram Moolenaar7de62622021-08-07 15:05:47 +02006764 case ISN_ECHOCONSOLE:
6765 smsg("%s%4d ECHOCONSOLE %lld", pfx, current,
6766 (varnumber_T)(iptr->isn_arg.number));
Bram Moolenaar4c137212021-04-19 16:48:48 +02006767 break;
6768 case ISN_ECHOERR:
6769 smsg("%s%4d ECHOERR %lld", pfx, current,
Bram Moolenaar7de62622021-08-07 15:05:47 +02006770 (varnumber_T)(iptr->isn_arg.number));
Bram Moolenaar4c137212021-04-19 16:48:48 +02006771 break;
6772 case ISN_LOAD:
6773 {
6774 if (iptr->isn_arg.number < 0)
6775 smsg("%s%4d LOAD arg[%lld]", pfx, current,
6776 (varnumber_T)(iptr->isn_arg.number
6777 + STACK_FRAME_SIZE));
6778 else
6779 smsg("%s%4d LOAD $%lld", pfx, current,
6780 (varnumber_T)(iptr->isn_arg.number));
6781 }
6782 break;
6783 case ISN_LOADOUTER:
6784 {
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01006785 isn_outer_T *outer = &iptr->isn_arg.outer;
6786
6787 if (outer->outer_idx < 0)
Bram Moolenaar4c137212021-04-19 16:48:48 +02006788 smsg("%s%4d LOADOUTER level %d arg[%d]", pfx, current,
Bram Moolenaarcc341812022-09-19 15:54:34 +01006789 outer->outer_depth,
6790 outer->outer_idx + STACK_FRAME_SIZE);
6791 else if (outer->outer_depth < 0)
6792 smsg("%s%4d LOADOUTER $%d in loop level %d",
6793 pfx, current,
6794 outer->outer_idx,
6795 -outer->outer_depth);
Bram Moolenaar4c137212021-04-19 16:48:48 +02006796 else
6797 smsg("%s%4d LOADOUTER level %d $%d", pfx, current,
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01006798 outer->outer_depth,
6799 outer->outer_idx);
Bram Moolenaar4c137212021-04-19 16:48:48 +02006800 }
6801 break;
6802 case ISN_LOADV:
6803 smsg("%s%4d LOADV v:%s", pfx, current,
6804 get_vim_var_name(iptr->isn_arg.number));
6805 break;
6806 case ISN_LOADSCRIPT:
6807 {
Bram Moolenaar6db660b2021-08-01 14:08:54 +02006808 scriptref_T *sref = iptr->isn_arg.script.scriptref;
6809 scriptitem_T *si = SCRIPT_ITEM(sref->sref_sid);
6810 svar_T *sv;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006811
Bram Moolenaar6db660b2021-08-01 14:08:54 +02006812 sv = get_script_svar(sref, -1);
6813 if (sv == NULL)
6814 smsg("%s%4d LOADSCRIPT [deleted] from %s",
6815 pfx, current, si->sn_name);
6816 else
6817 smsg("%s%4d LOADSCRIPT %s-%d from %s", pfx, current,
Bram Moolenaar4c137212021-04-19 16:48:48 +02006818 sv->sv_name,
6819 sref->sref_idx,
6820 si->sn_name);
6821 }
6822 break;
6823 case ISN_LOADS:
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01006824 case ISN_LOADEXPORT:
Bram Moolenaar4c137212021-04-19 16:48:48 +02006825 {
6826 scriptitem_T *si = SCRIPT_ITEM(
6827 iptr->isn_arg.loadstore.ls_sid);
6828
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01006829 smsg("%s%4d %s s:%s from %s", pfx, current,
6830 iptr->isn_type == ISN_LOADS ? "LOADS"
6831 : "LOADEXPORT",
6832 iptr->isn_arg.loadstore.ls_name, si->sn_name);
Bram Moolenaar4c137212021-04-19 16:48:48 +02006833 }
6834 break;
6835 case ISN_LOADAUTO:
6836 smsg("%s%4d LOADAUTO %s", pfx, current, iptr->isn_arg.string);
6837 break;
6838 case ISN_LOADG:
6839 smsg("%s%4d LOADG g:%s", pfx, current, iptr->isn_arg.string);
6840 break;
6841 case ISN_LOADB:
6842 smsg("%s%4d LOADB b:%s", pfx, current, iptr->isn_arg.string);
6843 break;
6844 case ISN_LOADW:
6845 smsg("%s%4d LOADW w:%s", pfx, current, iptr->isn_arg.string);
6846 break;
6847 case ISN_LOADT:
6848 smsg("%s%4d LOADT t:%s", pfx, current, iptr->isn_arg.string);
6849 break;
6850 case ISN_LOADGDICT:
6851 smsg("%s%4d LOAD g:", pfx, current);
6852 break;
6853 case ISN_LOADBDICT:
6854 smsg("%s%4d LOAD b:", pfx, current);
6855 break;
6856 case ISN_LOADWDICT:
6857 smsg("%s%4d LOAD w:", pfx, current);
6858 break;
6859 case ISN_LOADTDICT:
6860 smsg("%s%4d LOAD t:", pfx, current);
6861 break;
6862 case ISN_LOADOPT:
6863 smsg("%s%4d LOADOPT %s", pfx, current, iptr->isn_arg.string);
6864 break;
6865 case ISN_LOADENV:
6866 smsg("%s%4d LOADENV %s", pfx, current, iptr->isn_arg.string);
6867 break;
6868 case ISN_LOADREG:
Bram Moolenaar6db660b2021-08-01 14:08:54 +02006869 smsg("%s%4d LOADREG @%c", pfx, current,
6870 (int)(iptr->isn_arg.number));
Bram Moolenaar4c137212021-04-19 16:48:48 +02006871 break;
6872
6873 case ISN_STORE:
6874 if (iptr->isn_arg.number < 0)
6875 smsg("%s%4d STORE arg[%lld]", pfx, current,
6876 iptr->isn_arg.number + STACK_FRAME_SIZE);
6877 else
Bram Moolenaar6db660b2021-08-01 14:08:54 +02006878 smsg("%s%4d STORE $%lld", pfx, current,
6879 iptr->isn_arg.number);
Bram Moolenaar4c137212021-04-19 16:48:48 +02006880 break;
6881 case ISN_STOREOUTER:
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01006882 {
6883 isn_outer_T *outer = &iptr->isn_arg.outer;
6884
6885 if (outer->outer_depth == OUTER_LOOP_DEPTH)
6886 smsg("%s%4d STOREOUTER level 1 $%d in loop",
6887 pfx, current, outer->outer_idx);
6888 else
6889 smsg("%s%4d STOREOUTER level %d $%d", pfx, current,
6890 outer->outer_depth, outer->outer_idx);
6891 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02006892 break;
6893 case ISN_STOREV:
6894 smsg("%s%4d STOREV v:%s", pfx, current,
6895 get_vim_var_name(iptr->isn_arg.number));
6896 break;
6897 case ISN_STOREAUTO:
6898 smsg("%s%4d STOREAUTO %s", pfx, current, iptr->isn_arg.string);
6899 break;
6900 case ISN_STOREG:
6901 smsg("%s%4d STOREG %s", pfx, current, iptr->isn_arg.string);
6902 break;
6903 case ISN_STOREB:
6904 smsg("%s%4d STOREB %s", pfx, current, iptr->isn_arg.string);
6905 break;
6906 case ISN_STOREW:
6907 smsg("%s%4d STOREW %s", pfx, current, iptr->isn_arg.string);
6908 break;
6909 case ISN_STORET:
6910 smsg("%s%4d STORET %s", pfx, current, iptr->isn_arg.string);
6911 break;
6912 case ISN_STORES:
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01006913 case ISN_STOREEXPORT:
Bram Moolenaar4c137212021-04-19 16:48:48 +02006914 {
6915 scriptitem_T *si = SCRIPT_ITEM(
6916 iptr->isn_arg.loadstore.ls_sid);
6917
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01006918 smsg("%s%4d %s %s in %s", pfx, current,
6919 iptr->isn_type == ISN_STORES
6920 ? "STORES" : "STOREEXPORT",
Bram Moolenaar4c137212021-04-19 16:48:48 +02006921 iptr->isn_arg.loadstore.ls_name, si->sn_name);
6922 }
6923 break;
6924 case ISN_STORESCRIPT:
6925 {
Bram Moolenaar6db660b2021-08-01 14:08:54 +02006926 scriptref_T *sref = iptr->isn_arg.script.scriptref;
6927 scriptitem_T *si = SCRIPT_ITEM(sref->sref_sid);
6928 svar_T *sv;
Bram Moolenaar4c137212021-04-19 16:48:48 +02006929
Bram Moolenaar6db660b2021-08-01 14:08:54 +02006930 sv = get_script_svar(sref, -1);
6931 if (sv == NULL)
6932 smsg("%s%4d STORESCRIPT [deleted] in %s",
6933 pfx, current, si->sn_name);
6934 else
6935 smsg("%s%4d STORESCRIPT %s-%d in %s", pfx, current,
Bram Moolenaar4c137212021-04-19 16:48:48 +02006936 sv->sv_name,
6937 sref->sref_idx,
6938 si->sn_name);
6939 }
6940 break;
6941 case ISN_STOREOPT:
Bram Moolenaardcb53be2021-12-09 14:23:43 +00006942 case ISN_STOREFUNCOPT:
6943 smsg("%s%4d %s &%s", pfx, current,
6944 iptr->isn_type == ISN_STOREOPT ? "STOREOPT" : "STOREFUNCOPT",
Bram Moolenaar4c137212021-04-19 16:48:48 +02006945 iptr->isn_arg.storeopt.so_name);
6946 break;
6947 case ISN_STOREENV:
6948 smsg("%s%4d STOREENV $%s", pfx, current, iptr->isn_arg.string);
6949 break;
6950 case ISN_STOREREG:
Bram Moolenaar6db660b2021-08-01 14:08:54 +02006951 smsg("%s%4d STOREREG @%c", pfx, current,
6952 (int)iptr->isn_arg.number);
Bram Moolenaar4c137212021-04-19 16:48:48 +02006953 break;
6954 case ISN_STORENR:
6955 smsg("%s%4d STORE %lld in $%d", pfx, current,
6956 iptr->isn_arg.storenr.stnr_val,
6957 iptr->isn_arg.storenr.stnr_idx);
6958 break;
6959
6960 case ISN_STOREINDEX:
6961 smsg("%s%4d STOREINDEX %s", pfx, current,
Bram Moolenaarf7d1c6e2023-01-16 20:47:57 +00006962 vartype_name(iptr->isn_arg.storeindex.si_vartype));
Bram Moolenaar4c137212021-04-19 16:48:48 +02006963 break;
6964
6965 case ISN_STORERANGE:
6966 smsg("%s%4d STORERANGE", pfx, current);
6967 break;
6968
Bram Moolenaard505d172022-12-18 21:42:55 +00006969 case ISN_LOAD_CLASSMEMBER:
6970 case ISN_STORE_CLASSMEMBER:
6971 {
6972 class_T *cl = iptr->isn_arg.classmember.cm_class;
6973 int idx = iptr->isn_arg.classmember.cm_idx;
6974 ocmember_T *ocm = &cl->class_class_members[idx];
6975 smsg("%s%4d %s CLASSMEMBER %s.%s", pfx, current,
6976 iptr->isn_type == ISN_LOAD_CLASSMEMBER
6977 ? "LOAD" : "STORE",
6978 cl->class_name, ocm->ocm_name);
6979 }
6980 break;
6981
Bram Moolenaar4c137212021-04-19 16:48:48 +02006982 // constants
6983 case ISN_PUSHNR:
6984 smsg("%s%4d PUSHNR %lld", pfx, current,
6985 (varnumber_T)(iptr->isn_arg.number));
6986 break;
6987 case ISN_PUSHBOOL:
6988 case ISN_PUSHSPEC:
6989 smsg("%s%4d PUSH %s", pfx, current,
6990 get_var_special_name(iptr->isn_arg.number));
6991 break;
6992 case ISN_PUSHF:
Bram Moolenaar4c137212021-04-19 16:48:48 +02006993 smsg("%s%4d PUSHF %g", pfx, current, iptr->isn_arg.fnumber);
Bram Moolenaar4c137212021-04-19 16:48:48 +02006994 break;
6995 case ISN_PUSHS:
6996 smsg("%s%4d PUSHS \"%s\"", pfx, current, iptr->isn_arg.string);
6997 break;
6998 case ISN_PUSHBLOB:
6999 {
7000 char_u *r;
7001 char_u numbuf[NUMBUFLEN];
7002 char_u *tofree;
7003
7004 r = blob2string(iptr->isn_arg.blob, &tofree, numbuf);
7005 smsg("%s%4d PUSHBLOB %s", pfx, current, r);
7006 vim_free(tofree);
7007 }
7008 break;
7009 case ISN_PUSHFUNC:
7010 {
7011 char *name = (char *)iptr->isn_arg.string;
7012
7013 smsg("%s%4d PUSHFUNC \"%s\"", pfx, current,
7014 name == NULL ? "[none]" : name);
7015 }
7016 break;
7017 case ISN_PUSHCHANNEL:
7018#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar397a87a2022-03-20 21:14:15 +00007019 smsg("%s%4d PUSHCHANNEL 0", pfx, current);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007020#endif
7021 break;
7022 case ISN_PUSHJOB:
7023#ifdef FEAT_JOB_CHANNEL
Bram Moolenaar397a87a2022-03-20 21:14:15 +00007024 smsg("%s%4d PUSHJOB \"no process\"", pfx, current);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007025#endif
7026 break;
Bram Moolenaarc4e1b862023-02-26 18:58:23 +00007027 case ISN_PUSHOBJ:
7028 smsg("%s%4d PUSHOBJ null", pfx, current);
7029 break;
7030 case ISN_PUSHCLASS:
7031 smsg("%s%4d PUSHCLASS %s", pfx, current,
Bram Moolenaar30a84472023-02-27 08:07:14 +00007032 iptr->isn_arg.classarg == NULL ? "null"
7033 : (char *)iptr->isn_arg.classarg->class_name);
Bram Moolenaarc4e1b862023-02-26 18:58:23 +00007034 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007035 case ISN_PUSHEXC:
7036 smsg("%s%4d PUSH v:exception", pfx, current);
7037 break;
Bram Moolenaar06b77222022-01-25 15:51:56 +00007038 case ISN_AUTOLOAD:
7039 smsg("%s%4d AUTOLOAD %s", pfx, current, iptr->isn_arg.string);
7040 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007041 case ISN_UNLET:
7042 smsg("%s%4d UNLET%s %s", pfx, current,
7043 iptr->isn_arg.unlet.ul_forceit ? "!" : "",
7044 iptr->isn_arg.unlet.ul_name);
7045 break;
7046 case ISN_UNLETENV:
7047 smsg("%s%4d UNLETENV%s $%s", pfx, current,
7048 iptr->isn_arg.unlet.ul_forceit ? "!" : "",
7049 iptr->isn_arg.unlet.ul_name);
7050 break;
7051 case ISN_UNLETINDEX:
7052 smsg("%s%4d UNLETINDEX", pfx, current);
7053 break;
7054 case ISN_UNLETRANGE:
7055 smsg("%s%4d UNLETRANGE", pfx, current);
7056 break;
Bram Moolenaaraacc9662021-08-13 19:40:51 +02007057 case ISN_LOCKUNLOCK:
7058 smsg("%s%4d LOCKUNLOCK %s", pfx, current, iptr->isn_arg.string);
7059 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007060 case ISN_LOCKCONST:
7061 smsg("%s%4d LOCKCONST", pfx, current);
7062 break;
7063 case ISN_NEWLIST:
7064 smsg("%s%4d NEWLIST size %lld", pfx, current,
Bram Moolenaar1936c762022-09-28 15:19:10 +01007065 (varnumber_T)(iptr->isn_arg.number));
Bram Moolenaar4c137212021-04-19 16:48:48 +02007066 break;
7067 case ISN_NEWDICT:
7068 smsg("%s%4d NEWDICT size %lld", pfx, current,
Bram Moolenaar1936c762022-09-28 15:19:10 +01007069 (varnumber_T)(iptr->isn_arg.number));
Bram Moolenaar4c137212021-04-19 16:48:48 +02007070 break;
Bram Moolenaar8acb9cc2022-03-08 13:18:55 +00007071 case ISN_NEWPARTIAL:
7072 smsg("%s%4d NEWPARTIAL", pfx, current);
7073 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007074
7075 // function call
7076 case ISN_BCALL:
7077 {
7078 cbfunc_T *cbfunc = &iptr->isn_arg.bfunc;
7079
7080 smsg("%s%4d BCALL %s(argc %d)", pfx, current,
7081 internal_func_name(cbfunc->cbf_idx),
7082 cbfunc->cbf_argcount);
7083 }
7084 break;
7085 case ISN_DCALL:
7086 {
7087 cdfunc_T *cdfunc = &iptr->isn_arg.dfunc;
7088 dfunc_T *df = ((dfunc_T *)def_functions.ga_data)
7089 + cdfunc->cdf_idx;
7090
7091 smsg("%s%4d DCALL %s(argc %d)", pfx, current,
Bram Moolenaar6db660b2021-08-01 14:08:54 +02007092 printable_func_name(df->df_ufunc),
7093 cdfunc->cdf_argcount);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007094 }
7095 break;
Bram Moolenaard0200c82023-01-28 15:19:40 +00007096 case ISN_METHODCALL:
7097 {
7098 cmfunc_T *mfunc = iptr->isn_arg.mfunc;
7099
7100 smsg("%s%4d METHODCALL %s.%s(argc %d)", pfx, current,
7101 mfunc->cmf_itf->class_name,
7102 mfunc->cmf_itf->class_obj_methods[
7103 mfunc->cmf_idx]->uf_name,
7104 mfunc->cmf_argcount);
7105 }
7106 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007107 case ISN_UCALL:
7108 {
7109 cufunc_T *cufunc = &iptr->isn_arg.ufunc;
7110
7111 smsg("%s%4d UCALL %s(argc %d)", pfx, current,
7112 cufunc->cuf_name, cufunc->cuf_argcount);
7113 }
7114 break;
7115 case ISN_PCALL:
7116 {
7117 cpfunc_T *cpfunc = &iptr->isn_arg.pfunc;
7118
7119 smsg("%s%4d PCALL%s (argc %d)", pfx, current,
7120 cpfunc->cpf_top ? " top" : "", cpfunc->cpf_argcount);
7121 }
7122 break;
7123 case ISN_PCALL_END:
7124 smsg("%s%4d PCALL end", pfx, current);
7125 break;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01007126 case ISN_DEFER:
Yegappan Lakshmananf3eac692023-10-17 11:00:45 +02007127 smsg("%s%4d DEFER %d args", pfx, current,
Bram Moolenaar1d84f762022-09-03 21:35:53 +01007128 (int)iptr->isn_arg.defer.defer_argcount);
7129 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007130 case ISN_RETURN:
7131 smsg("%s%4d RETURN", pfx, current);
7132 break;
Bram Moolenaarf57b43c2021-06-15 22:13:27 +02007133 case ISN_RETURN_VOID:
7134 smsg("%s%4d RETURN void", pfx, current);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007135 break;
Bram Moolenaar00b28d62022-12-08 15:32:33 +00007136 case ISN_RETURN_OBJECT:
7137 smsg("%s%4d RETURN object", pfx, current);
7138 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007139 case ISN_FUNCREF:
7140 {
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01007141 funcref_T *funcref = &iptr->isn_arg.funcref;
7142 funcref_extra_T *extra = funcref->fr_extra;
7143 char_u *name;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007144
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01007145 if (extra == NULL || extra->fre_func_name == NULL)
Bram Moolenaar38453522021-11-28 22:00:12 +00007146 {
7147 dfunc_T *df = ((dfunc_T *)def_functions.ga_data)
7148 + funcref->fr_dfunc_idx;
7149 name = df->df_ufunc->uf_name;
7150 }
7151 else
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01007152 name = extra->fre_func_name;
Bram Moolenaar313e4722023-02-08 20:55:27 +00007153 if (extra != NULL && extra->fre_class != NULL)
7154 {
7155 smsg("%s%4d FUNCREF %s.%s", pfx, current,
7156 extra->fre_class->class_name, name);
7157 }
7158 else if (extra == NULL
7159 || extra->fre_loopvar_info.lvi_depth == 0)
7160 {
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01007161 smsg("%s%4d FUNCREF %s", pfx, current, name);
Bram Moolenaar313e4722023-02-08 20:55:27 +00007162 }
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01007163 else
Bram Moolenaarcc341812022-09-19 15:54:34 +01007164 {
7165 char_u *info = printable_loopvarinfo(
7166 &extra->fre_loopvar_info);
7167
7168 smsg("%s%4d FUNCREF %s vars %s", pfx, current,
7169 name, info);
7170 vim_free(info);
7171 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02007172 }
7173 break;
7174
7175 case ISN_NEWFUNC:
7176 {
Bram Moolenaarcc341812022-09-19 15:54:34 +01007177 newfuncarg_T *arg = iptr->isn_arg.newfunc.nf_arg;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007178
Bram Moolenaarcc341812022-09-19 15:54:34 +01007179 if (arg->nfa_loopvar_info.lvi_depth == 0)
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01007180 smsg("%s%4d NEWFUNC %s %s", pfx, current,
7181 arg->nfa_lambda, arg->nfa_global);
7182 else
Bram Moolenaarcc341812022-09-19 15:54:34 +01007183 {
7184 char_u *info = printable_loopvarinfo(
7185 &arg->nfa_loopvar_info);
7186
7187 smsg("%s%4d NEWFUNC %s %s vars %s", pfx, current,
7188 arg->nfa_lambda, arg->nfa_global, info);
7189 vim_free(info);
7190 }
Bram Moolenaar4c137212021-04-19 16:48:48 +02007191 }
7192 break;
7193
7194 case ISN_DEF:
7195 {
7196 char_u *name = iptr->isn_arg.string;
7197
7198 smsg("%s%4d DEF %s", pfx, current,
7199 name == NULL ? (char_u *)"" : name);
7200 }
7201 break;
7202
7203 case ISN_JUMP:
7204 {
7205 char *when = "?";
7206
7207 switch (iptr->isn_arg.jump.jump_when)
7208 {
7209 case JUMP_ALWAYS:
7210 when = "JUMP";
7211 break;
Bram Moolenaar1a7ee4d2021-09-16 16:15:07 +02007212 case JUMP_NEVER:
7213 iemsg("JUMP_NEVER should not be used");
7214 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007215 case JUMP_AND_KEEP_IF_TRUE:
7216 when = "JUMP_AND_KEEP_IF_TRUE";
7217 break;
7218 case JUMP_IF_FALSE:
7219 when = "JUMP_IF_FALSE";
7220 break;
Bram Moolenaarb46c0832022-09-15 17:19:37 +01007221 case JUMP_WHILE_FALSE:
7222 when = "JUMP_WHILE_FALSE"; // unused
7223 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007224 case JUMP_IF_COND_FALSE:
7225 when = "JUMP_IF_COND_FALSE";
7226 break;
7227 case JUMP_IF_COND_TRUE:
7228 when = "JUMP_IF_COND_TRUE";
7229 break;
7230 }
7231 smsg("%s%4d %s -> %d", pfx, current, when,
7232 iptr->isn_arg.jump.jump_where);
7233 }
7234 break;
7235
7236 case ISN_JUMP_IF_ARG_SET:
7237 smsg("%s%4d JUMP_IF_ARG_SET arg[%d] -> %d", pfx, current,
7238 iptr->isn_arg.jumparg.jump_arg_off + STACK_FRAME_SIZE,
7239 iptr->isn_arg.jump.jump_where);
7240 break;
7241
Bram Moolenaar65b0d162022-12-13 18:43:22 +00007242 case ISN_JUMP_IF_ARG_NOT_SET:
7243 smsg("%s%4d JUMP_IF_ARG_NOT_SET arg[%d] -> %d", pfx, current,
7244 iptr->isn_arg.jumparg.jump_arg_off + STACK_FRAME_SIZE,
7245 iptr->isn_arg.jump.jump_where);
7246 break;
7247
Bram Moolenaar4c137212021-04-19 16:48:48 +02007248 case ISN_FOR:
7249 {
7250 forloop_T *forloop = &iptr->isn_arg.forloop;
7251
7252 smsg("%s%4d FOR $%d -> %d", pfx, current,
Bram Moolenaarcc341812022-09-19 15:54:34 +01007253 forloop->for_loop_idx, forloop->for_end);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007254 }
7255 break;
7256
Bram Moolenaarb46c0832022-09-15 17:19:37 +01007257 case ISN_ENDLOOP:
7258 {
7259 endloop_T *endloop = &iptr->isn_arg.endloop;
7260
Bram Moolenaarcc341812022-09-19 15:54:34 +01007261 smsg("%s%4d ENDLOOP ref $%d save $%d-$%d depth %d",
7262 pfx, current,
Bram Moolenaarb46c0832022-09-15 17:19:37 +01007263 endloop->end_funcref_idx,
7264 endloop->end_var_idx,
Bram Moolenaarcc341812022-09-19 15:54:34 +01007265 endloop->end_var_idx + endloop->end_var_count - 1,
7266 endloop->end_depth);
Bram Moolenaarb46c0832022-09-15 17:19:37 +01007267 }
7268 break;
7269
7270 case ISN_WHILE:
7271 {
7272 whileloop_T *whileloop = &iptr->isn_arg.whileloop;
7273
7274 smsg("%s%4d WHILE $%d -> %d", pfx, current,
7275 whileloop->while_funcref_idx,
7276 whileloop->while_end);
7277 }
7278 break;
7279
Bram Moolenaar4c137212021-04-19 16:48:48 +02007280 case ISN_TRY:
7281 {
Bram Moolenaar0d807102021-12-21 09:42:09 +00007282 try_T *try = &iptr->isn_arg.tryref;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007283
7284 if (try->try_ref->try_finally == 0)
7285 smsg("%s%4d TRY catch -> %d, endtry -> %d",
7286 pfx, current,
7287 try->try_ref->try_catch,
7288 try->try_ref->try_endtry);
7289 else
7290 smsg("%s%4d TRY catch -> %d, finally -> %d, endtry -> %d",
7291 pfx, current,
7292 try->try_ref->try_catch,
7293 try->try_ref->try_finally,
7294 try->try_ref->try_endtry);
7295 }
7296 break;
7297 case ISN_CATCH:
Bram Moolenaar4c137212021-04-19 16:48:48 +02007298 smsg("%s%4d CATCH", pfx, current);
7299 break;
7300 case ISN_TRYCONT:
7301 {
7302 trycont_T *trycont = &iptr->isn_arg.trycont;
7303
7304 smsg("%s%4d TRY-CONTINUE %d level%s -> %d", pfx, current,
7305 trycont->tct_levels,
7306 trycont->tct_levels == 1 ? "" : "s",
7307 trycont->tct_where);
7308 }
7309 break;
7310 case ISN_FINALLY:
7311 smsg("%s%4d FINALLY", pfx, current);
7312 break;
7313 case ISN_ENDTRY:
7314 smsg("%s%4d ENDTRY", pfx, current);
7315 break;
7316 case ISN_THROW:
7317 smsg("%s%4d THROW", pfx, current);
7318 break;
7319
7320 // expression operations on number
7321 case ISN_OPNR:
7322 case ISN_OPFLOAT:
7323 case ISN_OPANY:
7324 {
7325 char *what;
7326 char *ins;
7327
7328 switch (iptr->isn_arg.op.op_type)
7329 {
7330 case EXPR_MULT: what = "*"; break;
7331 case EXPR_DIV: what = "/"; break;
7332 case EXPR_REM: what = "%"; break;
7333 case EXPR_SUB: what = "-"; break;
7334 case EXPR_ADD: what = "+"; break;
Yegappan Lakshmanana061f342022-05-22 19:13:49 +01007335 case EXPR_LSHIFT: what = "<<"; break;
7336 case EXPR_RSHIFT: what = ">>"; break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007337 default: what = "???"; break;
7338 }
7339 switch (iptr->isn_type)
7340 {
7341 case ISN_OPNR: ins = "OPNR"; break;
7342 case ISN_OPFLOAT: ins = "OPFLOAT"; break;
7343 case ISN_OPANY: ins = "OPANY"; break;
7344 default: ins = "???"; break;
7345 }
7346 smsg("%s%4d %s %s", pfx, current, ins, what);
7347 }
7348 break;
7349
7350 case ISN_COMPAREBOOL:
7351 case ISN_COMPARESPECIAL:
Bram Moolenaar7a222242022-03-01 19:23:24 +00007352 case ISN_COMPARENULL:
Bram Moolenaar4c137212021-04-19 16:48:48 +02007353 case ISN_COMPARENR:
7354 case ISN_COMPAREFLOAT:
7355 case ISN_COMPARESTRING:
7356 case ISN_COMPAREBLOB:
7357 case ISN_COMPARELIST:
7358 case ISN_COMPAREDICT:
7359 case ISN_COMPAREFUNC:
Bram Moolenaarbcf31ec2023-01-02 20:32:24 +00007360 case ISN_COMPAREOBJECT:
Bram Moolenaar4c137212021-04-19 16:48:48 +02007361 case ISN_COMPAREANY:
7362 {
7363 char *p;
7364 char buf[10];
7365 char *type;
7366
7367 switch (iptr->isn_arg.op.op_type)
7368 {
7369 case EXPR_EQUAL: p = "=="; break;
7370 case EXPR_NEQUAL: p = "!="; break;
7371 case EXPR_GREATER: p = ">"; break;
7372 case EXPR_GEQUAL: p = ">="; break;
7373 case EXPR_SMALLER: p = "<"; break;
7374 case EXPR_SEQUAL: p = "<="; break;
7375 case EXPR_MATCH: p = "=~"; break;
7376 case EXPR_IS: p = "is"; break;
7377 case EXPR_ISNOT: p = "isnot"; break;
7378 case EXPR_NOMATCH: p = "!~"; break;
7379 default: p = "???"; break;
7380 }
7381 STRCPY(buf, p);
7382 if (iptr->isn_arg.op.op_ic == TRUE)
7383 strcat(buf, "?");
7384 switch(iptr->isn_type)
7385 {
7386 case ISN_COMPAREBOOL: type = "COMPAREBOOL"; break;
7387 case ISN_COMPARESPECIAL:
7388 type = "COMPARESPECIAL"; break;
Bram Moolenaar7a222242022-03-01 19:23:24 +00007389 case ISN_COMPARENULL: type = "COMPARENULL"; break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007390 case ISN_COMPARENR: type = "COMPARENR"; break;
7391 case ISN_COMPAREFLOAT: type = "COMPAREFLOAT"; break;
7392 case ISN_COMPARESTRING:
7393 type = "COMPARESTRING"; break;
7394 case ISN_COMPAREBLOB: type = "COMPAREBLOB"; break;
7395 case ISN_COMPARELIST: type = "COMPARELIST"; break;
7396 case ISN_COMPAREDICT: type = "COMPAREDICT"; break;
7397 case ISN_COMPAREFUNC: type = "COMPAREFUNC"; break;
Bram Moolenaarbcf31ec2023-01-02 20:32:24 +00007398 case ISN_COMPAREOBJECT:
7399 type = "COMPAREOBJECT"; break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007400 case ISN_COMPAREANY: type = "COMPAREANY"; break;
7401 default: type = "???"; break;
7402 }
7403
7404 smsg("%s%4d %s %s", pfx, current, type, buf);
7405 }
7406 break;
7407
7408 case ISN_ADDLIST: smsg("%s%4d ADDLIST", pfx, current); break;
7409 case ISN_ADDBLOB: smsg("%s%4d ADDBLOB", pfx, current); break;
7410
7411 // expression operations
LemonBoy372bcce2022-04-25 12:43:20 +01007412 case ISN_CONCAT:
7413 smsg("%s%4d CONCAT size %lld", pfx, current,
7414 (varnumber_T)(iptr->isn_arg.number));
7415 break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007416 case ISN_STRINDEX: smsg("%s%4d STRINDEX", pfx, current); break;
7417 case ISN_STRSLICE: smsg("%s%4d STRSLICE", pfx, current); break;
7418 case ISN_BLOBINDEX: smsg("%s%4d BLOBINDEX", pfx, current); break;
7419 case ISN_BLOBSLICE: smsg("%s%4d BLOBSLICE", pfx, current); break;
7420 case ISN_LISTAPPEND: smsg("%s%4d LISTAPPEND", pfx, current); break;
7421 case ISN_BLOBAPPEND: smsg("%s%4d BLOBAPPEND", pfx, current); break;
7422 case ISN_LISTINDEX: smsg("%s%4d LISTINDEX", pfx, current); break;
7423 case ISN_LISTSLICE: smsg("%s%4d LISTSLICE", pfx, current); break;
7424 case ISN_ANYINDEX: smsg("%s%4d ANYINDEX", pfx, current); break;
7425 case ISN_ANYSLICE: smsg("%s%4d ANYSLICE", pfx, current); break;
7426 case ISN_SLICE: smsg("%s%4d SLICE %lld",
Bram Moolenaar4f0884d2021-08-11 21:49:23 +02007427 pfx, current, iptr->isn_arg.number); break;
Bram Moolenaar035bd1c2021-06-21 19:44:11 +02007428 case ISN_GETITEM: smsg("%s%4d ITEM %lld%s", pfx, current,
7429 iptr->isn_arg.getitem.gi_index,
7430 iptr->isn_arg.getitem.gi_with_op ?
7431 " with op" : ""); break;
Bram Moolenaar4c137212021-04-19 16:48:48 +02007432 case ISN_MEMBER: smsg("%s%4d MEMBER", pfx, current); break;
7433 case ISN_STRINGMEMBER: smsg("%s%4d MEMBER %s", pfx, current,
7434 iptr->isn_arg.string); break;
Yegappan Lakshmanan5a05d372023-09-29 19:43:11 +02007435 case ISN_GET_OBJ_MEMBER: smsg("%s%4d OBJ_MEMBER %d", pfx, current,
7436 (int)iptr->isn_arg.classmember.cm_idx);
Ernie Rael00df69e2023-09-05 07:38:09 +02007437 break;
Yegappan Lakshmanan5a05d372023-09-29 19:43:11 +02007438 case ISN_GET_ITF_MEMBER: smsg("%s%4d ITF_MEMBER %d on %s",
Bram Moolenaar29ac5df2023-01-16 19:43:47 +00007439 pfx, current,
7440 (int)iptr->isn_arg.classmember.cm_idx,
Yegappan Lakshmanan5a05d372023-09-29 19:43:11 +02007441 iptr->isn_arg.classmember.cm_class->class_name);
Bram Moolenaar29ac5df2023-01-16 19:43:47 +00007442 break;
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +00007443 case ISN_STORE_THIS: smsg("%s%4d STORE_THIS %d", pfx, current,
Bram Moolenaarffdaca92022-12-09 21:41:48 +00007444 (int)iptr->isn_arg.number); break;
Bram Moolenaarb1b6f4d2021-09-13 18:25:54 +02007445 case ISN_CLEARDICT: smsg("%s%4d CLEARDICT", pfx, current); break;
7446 case ISN_USEDICT: smsg("%s%4d USEDICT", pfx, current); break;
7447
Bram Moolenaar4c137212021-04-19 16:48:48 +02007448 case ISN_NEGATENR: smsg("%s%4d NEGATENR", pfx, current); break;
7449
Bram Moolenaar4c137212021-04-19 16:48:48 +02007450 case ISN_CHECKTYPE:
7451 {
Bram Moolenaarbd3a9d22022-05-17 16:12:39 +01007452 checktype_T *ct = &iptr->isn_arg.type;
Bram Moolenaarc6951a72022-12-29 20:56:24 +00007453 char *tofree = NULL;
7454 char *typename;
7455
7456 if (ct->ct_type->tt_type == VAR_FLOAT
7457 && (ct->ct_type->tt_flags & TTFLAG_NUMBER_OK))
7458 typename = "float|number";
7459 else
7460 typename = type_name(ct->ct_type, &tofree);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007461
7462 if (ct->ct_arg_idx == 0)
7463 smsg("%s%4d CHECKTYPE %s stack[%d]", pfx, current,
Bram Moolenaarc6951a72022-12-29 20:56:24 +00007464 typename,
Bram Moolenaar4c137212021-04-19 16:48:48 +02007465 (int)ct->ct_off);
7466 else
Bram Moolenaarbd3a9d22022-05-17 16:12:39 +01007467 smsg("%s%4d CHECKTYPE %s stack[%d] %s %d",
Bram Moolenaar4f0884d2021-08-11 21:49:23 +02007468 pfx, current,
Bram Moolenaarc6951a72022-12-29 20:56:24 +00007469 typename,
Bram Moolenaar4c137212021-04-19 16:48:48 +02007470 (int)ct->ct_off,
Bram Moolenaarbd3a9d22022-05-17 16:12:39 +01007471 ct->ct_is_var ? "var": "arg",
Bram Moolenaar4c137212021-04-19 16:48:48 +02007472 (int)ct->ct_arg_idx);
7473 vim_free(tofree);
7474 break;
7475 }
7476 case ISN_CHECKLEN: smsg("%s%4d CHECKLEN %s%d", pfx, current,
7477 iptr->isn_arg.checklen.cl_more_OK ? ">= " : "",
7478 iptr->isn_arg.checklen.cl_min_len);
7479 break;
7480 case ISN_SETTYPE:
7481 {
7482 char *tofree;
7483
7484 smsg("%s%4d SETTYPE %s", pfx, current,
7485 type_name(iptr->isn_arg.type.ct_type, &tofree));
7486 vim_free(tofree);
7487 break;
7488 }
7489 case ISN_COND2BOOL: smsg("%s%4d COND2BOOL", pfx, current); break;
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02007490 case ISN_2BOOL: if (iptr->isn_arg.tobool.invert)
7491 smsg("%s%4d INVERT %d (!val)", pfx, current,
7492 iptr->isn_arg.tobool.offset);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007493 else
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02007494 smsg("%s%4d 2BOOL %d (!!val)", pfx, current,
7495 iptr->isn_arg.tobool.offset);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007496 break;
7497 case ISN_2STRING: smsg("%s%4d 2STRING stack[%lld]", pfx, current,
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02007498 (varnumber_T)(iptr->isn_arg.tostring.offset));
Bram Moolenaar4c137212021-04-19 16:48:48 +02007499 break;
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02007500 case ISN_2STRING_ANY: smsg("%s%4d 2STRING_ANY stack[%lld]",
7501 pfx, current,
7502 (varnumber_T)(iptr->isn_arg.tostring.offset));
Bram Moolenaar4c137212021-04-19 16:48:48 +02007503 break;
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02007504 case ISN_RANGE: smsg("%s%4d RANGE %s", pfx, current,
7505 iptr->isn_arg.string);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007506 break;
7507 case ISN_PUT:
Bram Moolenaar6ed545e2022-05-09 20:09:23 +01007508 if (iptr->isn_arg.put.put_lnum == LNUM_VARIABLE_RANGE_ABOVE)
Bram Moolenaar4c137212021-04-19 16:48:48 +02007509 smsg("%s%4d PUT %c above range",
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02007510 pfx, current, iptr->isn_arg.put.put_regname);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007511 else if (iptr->isn_arg.put.put_lnum == LNUM_VARIABLE_RANGE)
7512 smsg("%s%4d PUT %c range",
Bram Moolenaar5fa9b242021-06-04 21:00:32 +02007513 pfx, current, iptr->isn_arg.put.put_regname);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007514 else
7515 smsg("%s%4d PUT %c %ld", pfx, current,
7516 iptr->isn_arg.put.put_regname,
7517 (long)iptr->isn_arg.put.put_lnum);
7518 break;
7519
Bram Moolenaar4c137212021-04-19 16:48:48 +02007520 case ISN_CMDMOD:
7521 {
7522 char_u *buf;
7523 size_t len = produce_cmdmods(
7524 NULL, iptr->isn_arg.cmdmod.cf_cmdmod, FALSE);
7525
7526 buf = alloc(len + 1);
Dominique Pelle5a9e5842021-07-24 19:32:12 +02007527 if (likely(buf != NULL))
Bram Moolenaar4c137212021-04-19 16:48:48 +02007528 {
7529 (void)produce_cmdmods(
7530 buf, iptr->isn_arg.cmdmod.cf_cmdmod, FALSE);
7531 smsg("%s%4d CMDMOD %s", pfx, current, buf);
7532 vim_free(buf);
7533 }
7534 break;
7535 }
7536 case ISN_CMDMOD_REV: smsg("%s%4d CMDMOD_REV", pfx, current); break;
7537
7538 case ISN_PROF_START:
Bram Moolenaare99d4222021-06-13 14:01:26 +02007539 smsg("%s%4d PROFILE START line %d", pfx, current,
7540 iptr->isn_lnum);
Bram Moolenaar4c137212021-04-19 16:48:48 +02007541 break;
7542
7543 case ISN_PROF_END:
7544 smsg("%s%4d PROFILE END", pfx, current);
7545 break;
7546
Bram Moolenaare99d4222021-06-13 14:01:26 +02007547 case ISN_DEBUG:
Bram Moolenaar8cec9272021-06-23 20:20:53 +02007548 smsg("%s%4d DEBUG line %d-%d varcount %lld", pfx, current,
7549 iptr->isn_arg.debug.dbg_break_lnum + 1,
7550 iptr->isn_lnum,
7551 iptr->isn_arg.debug.dbg_var_names_len);
Bram Moolenaare99d4222021-06-13 14:01:26 +02007552 break;
7553
Bram Moolenaar4c137212021-04-19 16:48:48 +02007554 case ISN_UNPACK: smsg("%s%4d UNPACK %d%s", pfx, current,
7555 iptr->isn_arg.unpack.unp_count,
7556 iptr->isn_arg.unpack.unp_semicolon ? " semicolon" : "");
7557 break;
7558 case ISN_SHUFFLE: smsg("%s%4d SHUFFLE %d up %d", pfx, current,
7559 iptr->isn_arg.shuffle.shfl_item,
7560 iptr->isn_arg.shuffle.shfl_up);
7561 break;
7562 case ISN_DROP: smsg("%s%4d DROP", pfx, current); break;
7563
7564 case ISN_FINISH: // End of list of instructions for ISN_SUBSTITUTE.
7565 return;
7566 }
7567
7568 out_flush(); // output one line at a time
7569 ui_breakcheck();
7570 if (got_int)
7571 break;
7572 }
7573}
7574
7575/*
Bram Moolenaar4ee9d8e2021-06-13 18:38:48 +02007576 * Handle command line completion for the :disassemble command.
7577 */
7578 void
7579set_context_in_disassemble_cmd(expand_T *xp, char_u *arg)
7580{
7581 char_u *p;
7582
7583 // Default: expand user functions, "debug" and "profile"
7584 xp->xp_context = EXPAND_DISASSEMBLE;
7585 xp->xp_pattern = arg;
7586
7587 // first argument already typed: only user function names
7588 if (*arg != NUL && *(p = skiptowhite(arg)) != NUL)
7589 {
7590 xp->xp_context = EXPAND_USER_FUNC;
7591 xp->xp_pattern = skipwhite(p);
7592 }
7593}
7594
7595/*
7596 * Function given to ExpandGeneric() to obtain the list of :disassemble
7597 * arguments.
7598 */
7599 char_u *
7600get_disassemble_argument(expand_T *xp, int idx)
7601{
7602 if (idx == 0)
7603 return (char_u *)"debug";
7604 if (idx == 1)
7605 return (char_u *)"profile";
7606 return get_user_func_name(xp, idx - 2);
7607}
7608
7609/*
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01007610 * ":disassemble".
Bram Moolenaar777770f2020-02-06 21:27:08 +01007611 * We don't really need this at runtime, but we do have tests that require it,
7612 * so always include this.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007613 */
7614 void
7615ex_disassemble(exarg_T *eap)
7616{
Bram Moolenaar21456cd2020-02-13 21:29:32 +01007617 char_u *arg = eap->arg;
Bram Moolenaar0f18b6d2020-02-02 17:22:27 +01007618 ufunc_T *ufunc;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007619 dfunc_T *dfunc;
Bram Moolenaardafef512022-05-21 21:55:55 +01007620 isn_T *instr = NULL; // init to shut up gcc warning
7621 int instr_count = 0; // init to shut up gcc warning
Bram Moolenaar5a01caa2022-05-21 18:56:58 +01007622 compiletype_T compile_type = CT_NONE;
Bram Moolenaare99d4222021-06-13 14:01:26 +02007623
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01007624 ufunc = find_func_by_name(arg, &compile_type);
Bram Moolenaara26b9702020-04-18 19:53:28 +02007625 if (ufunc == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007626 return;
Bram Moolenaare99d4222021-06-13 14:01:26 +02007627 if (func_needs_compiling(ufunc, compile_type)
7628 && compile_def_function(ufunc, FALSE, compile_type, NULL) == FAIL)
Bram Moolenaar822ba242020-05-24 23:00:18 +02007629 return;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02007630 if (ufunc->uf_def_status != UF_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007631 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02007632 semsg(_(e_function_is_not_compiled_str), eap->arg);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007633 return;
7634 }
Bram Moolenaar6db660b2021-08-01 14:08:54 +02007635 msg((char *)printable_func_name(ufunc));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007636
7637 dfunc = ((dfunc_T *)def_functions.ga_data) + ufunc->uf_dfunc_idx;
Bram Moolenaare99d4222021-06-13 14:01:26 +02007638 switch (compile_type)
7639 {
7640 case CT_PROFILE:
Bram Moolenaarf002a412021-01-24 13:34:18 +01007641#ifdef FEAT_PROFILE
Bram Moolenaare99d4222021-06-13 14:01:26 +02007642 instr = dfunc->df_instr_prof;
7643 instr_count = dfunc->df_instr_prof_count;
7644 break;
Bram Moolenaarf002a412021-01-24 13:34:18 +01007645#endif
Bram Moolenaare99d4222021-06-13 14:01:26 +02007646 // FALLTHROUGH
7647 case CT_NONE:
7648 instr = dfunc->df_instr;
7649 instr_count = dfunc->df_instr_count;
7650 break;
7651 case CT_DEBUG:
7652 instr = dfunc->df_instr_debug;
7653 instr_count = dfunc->df_instr_debug_count;
7654 break;
7655 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007656
Bram Moolenaar4c137212021-04-19 16:48:48 +02007657 list_instructions("", instr, instr_count, ufunc);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007658}
7659
7660/*
Bram Moolenaar13106602020-10-04 16:06:05 +02007661 * Return TRUE when "tv" is not falsy: non-zero, non-empty string, non-empty
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007662 * list, etc. Mostly like what JavaScript does, except that empty list and
7663 * empty dictionary are FALSE.
7664 */
7665 int
7666tv2bool(typval_T *tv)
7667{
7668 switch (tv->v_type)
7669 {
7670 case VAR_NUMBER:
7671 return tv->vval.v_number != 0;
7672 case VAR_FLOAT:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007673 return tv->vval.v_float != 0.0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007674 case VAR_PARTIAL:
7675 return tv->vval.v_partial != NULL;
7676 case VAR_FUNC:
7677 case VAR_STRING:
7678 return tv->vval.v_string != NULL && *tv->vval.v_string != NUL;
7679 case VAR_LIST:
7680 return tv->vval.v_list != NULL && tv->vval.v_list->lv_len > 0;
7681 case VAR_DICT:
7682 return tv->vval.v_dict != NULL
7683 && tv->vval.v_dict->dv_hashtab.ht_used > 0;
7684 case VAR_BOOL:
7685 case VAR_SPECIAL:
7686 return tv->vval.v_number == VVAL_TRUE ? TRUE : FALSE;
7687 case VAR_JOB:
7688#ifdef FEAT_JOB_CHANNEL
7689 return tv->vval.v_job != NULL;
7690#else
7691 break;
7692#endif
7693 case VAR_CHANNEL:
7694#ifdef FEAT_JOB_CHANNEL
7695 return tv->vval.v_channel != NULL;
7696#else
7697 break;
7698#endif
7699 case VAR_BLOB:
7700 return tv->vval.v_blob != NULL && tv->vval.v_blob->bv_ga.ga_len > 0;
7701 case VAR_UNKNOWN:
Bram Moolenaar4c683752020-04-05 21:38:23 +02007702 case VAR_ANY:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007703 case VAR_VOID:
Bram Moolenaarf18332f2021-05-07 17:55:55 +02007704 case VAR_INSTR:
Bram Moolenaar00b28d62022-12-08 15:32:33 +00007705 case VAR_CLASS:
7706 case VAR_OBJECT:
Yegappan Lakshmananec3cebb2023-10-27 19:35:26 +02007707 case VAR_TYPEALIAS:
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007708 break;
7709 }
7710 return FALSE;
7711}
7712
Bram Moolenaarea2d4072020-11-12 12:08:51 +01007713 void
7714emsg_using_string_as(typval_T *tv, int as_number)
7715{
7716 semsg(_(as_number ? e_using_string_as_number_str
7717 : e_using_string_as_bool_str),
7718 tv->vval.v_string == NULL
7719 ? (char_u *)"" : tv->vval.v_string);
7720}
7721
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007722/*
7723 * If "tv" is a string give an error and return FAIL.
7724 */
7725 int
7726check_not_string(typval_T *tv)
7727{
7728 if (tv->v_type == VAR_STRING)
7729 {
Bram Moolenaarea2d4072020-11-12 12:08:51 +01007730 emsg_using_string_as(tv, TRUE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007731 clear_tv(tv);
7732 return FAIL;
7733 }
7734 return OK;
7735}
7736
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01007737
7738#endif // FEAT_EVAL