1 /* 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 * userfunc.c: User defined function support
12 */
13
14 #include "vim.h"
15
16 #if defined(FEAT_EVAL) || defined(PROTO)
17 /*
18 * All user-defined functions are found in this hashtable.
19 */
20 static hashtab_T func_hashtab;
21
22 // Used by get_func_tv()
23 static garray_T funcargs = GA_EMPTY;
24
25 // pointer to funccal for currently active function
26 static funccall_T *current_funccal = NULL;
27
28 // Pointer to list of previously used funccal, still around because some
29 // item in it is still being used.
30 static funccall_T *previous_funccal = NULL;
31
32 static char *e_funcexts = N_("E122: Function %s already exists, add ! to replace it");
33 static char *e_funcdict = N_("E717: Dictionary entry already exists");
34 static char *e_funcref = N_("E718: Funcref required");
35 static char *e_nofunc = N_("E130: Unknown function: %s");
36
37 static void funccal_unref(funccall_T *fc, ufunc_T *fp, int force);
38 static void func_clear(ufunc_T *fp, int force);
39 static int func_free(ufunc_T *fp, int force);
40
41 void
func_init()42 func_init()
43 {
44 hash_init(&func_hashtab);
45 }
46
47 /*
48 * Return the function hash table
49 */
50 hashtab_T *
func_tbl_get(void)51 func_tbl_get(void)
52 {
53 return &func_hashtab;
54 }
55
56 /*
57 * Get one function argument.
58 * If "argtypes" is not NULL also get the type: "arg: type" (:def function).
59 * If "types_optional" is TRUE a missing type is OK, use "any".
60 * If "evalarg" is not NULL use it to check for an already declared name.
61 * Return a pointer to after the type.
62 * When something is wrong return "arg".
63 */
64 static char_u *
one_function_arg(char_u * arg,garray_T * newargs,garray_T * argtypes,int types_optional,evalarg_T * evalarg,int is_vararg,int skip)65 one_function_arg(
66 char_u *arg,
67 garray_T *newargs,
68 garray_T *argtypes,
69 int types_optional,
70 evalarg_T *evalarg,
71 int is_vararg,
72 int skip)
73 {
74 char_u *p = arg;
75 char_u *arg_copy = NULL;
76 int is_underscore = FALSE;
77
78 while (ASCII_ISALNUM(*p) || *p == '_')
79 ++p;
80 if (arg == p || isdigit(*arg)
81 || (argtypes == NULL
82 && ((p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
83 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))))
84 {
85 if (!skip)
86 semsg(_("E125: Illegal argument: %s"), arg);
87 return arg;
88 }
89
90 // Vim9 script: cannot use script var name for argument. In function: also
91 // check local vars and arguments.
92 if (!skip && argtypes != NULL && check_defined(arg, p - arg,
93 evalarg == NULL ? NULL : evalarg->eval_cctx, TRUE) == FAIL)
94 return arg;
95
96 if (newargs != NULL && ga_grow(newargs, 1) == FAIL)
97 return arg;
98 if (newargs != NULL)
99 {
100 int c;
101 int i;
102
103 c = *p;
104 *p = NUL;
105 arg_copy = vim_strsave(arg);
106 if (arg_copy == NULL)
107 {
108 *p = c;
109 return arg;
110 }
111 is_underscore = arg_copy[0] == '_' && arg_copy[1] == NUL;
112 if (argtypes == NULL || !is_underscore)
113 // Check for duplicate argument name.
114 for (i = 0; i < newargs->ga_len; ++i)
115 if (STRCMP(((char_u **)(newargs->ga_data))[i], arg_copy) == 0)
116 {
117 semsg(_("E853: Duplicate argument name: %s"), arg_copy);
118 vim_free(arg_copy);
119 return arg;
120 }
121 ((char_u **)(newargs->ga_data))[newargs->ga_len] = arg_copy;
122 newargs->ga_len++;
123
124 *p = c;
125 }
126
127 // get any type from "arg: type"
128 if (argtypes != NULL && (skip || ga_grow(argtypes, 1) == OK))
129 {
130 char_u *type = NULL;
131
132 if (VIM_ISWHITE(*p) && *skipwhite(p) == ':')
133 {
134 semsg(_(e_no_white_space_allowed_before_colon_str),
135 arg_copy == NULL ? arg : arg_copy);
136 p = skipwhite(p);
137 }
138 if (*p == ':')
139 {
140 ++p;
141 if (!skip && !VIM_ISWHITE(*p))
142 {
143 semsg(_(e_white_space_required_after_str_str), ":", p - 1);
144 return arg;
145 }
146 type = skipwhite(p);
147 p = skip_type(type, TRUE);
148 if (!skip)
149 type = vim_strnsave(type, p - type);
150 }
151 else if (*skipwhite(p) != '=' && !types_optional && !is_underscore)
152 {
153 semsg(_(e_missing_argument_type_for_str),
154 arg_copy == NULL ? arg : arg_copy);
155 return arg;
156 }
157 if (!skip)
158 {
159 if (type == NULL && types_optional)
160 // lambda arguments default to "any" type
161 type = vim_strsave((char_u *)
162 (is_vararg ? "list<any>" : "any"));
163 ((char_u **)argtypes->ga_data)[argtypes->ga_len++] = type;
164 }
165 }
166
167 return p;
168 }
169
170 /*
171 * Get function arguments.
172 * "argp" should point to just after the "(", possibly to white space.
173 * "argp" is advanced just after "endchar".
174 */
175 static int
get_function_args(char_u ** argp,char_u endchar,garray_T * newargs,garray_T * argtypes,int types_optional,evalarg_T * evalarg,int * varargs,garray_T * default_args,int skip,exarg_T * eap,char_u ** line_to_free)176 get_function_args(
177 char_u **argp,
178 char_u endchar,
179 garray_T *newargs,
180 garray_T *argtypes, // NULL unless using :def
181 int types_optional, // types optional if "argtypes" is not NULL
182 evalarg_T *evalarg, // context or NULL
183 int *varargs,
184 garray_T *default_args,
185 int skip,
186 exarg_T *eap,
187 char_u **line_to_free)
188 {
189 int mustend = FALSE;
190 char_u *arg;
191 char_u *p;
192 int c;
193 int any_default = FALSE;
194 char_u *expr;
195 char_u *whitep = *argp;
196
197 if (newargs != NULL)
198 ga_init2(newargs, (int)sizeof(char_u *), 3);
199 if (argtypes != NULL)
200 ga_init2(argtypes, (int)sizeof(char_u *), 3);
201 if (!skip && default_args != NULL)
202 ga_init2(default_args, (int)sizeof(char_u *), 3);
203
204 if (varargs != NULL)
205 *varargs = FALSE;
206
207 /*
208 * Isolate the arguments: "arg1, arg2, ...)"
209 */
210 arg = skipwhite(*argp);
211 p = arg;
212 while (*p != endchar)
213 {
214 while (eap != NULL && eap->getline != NULL
215 && (*p == NUL || (VIM_ISWHITE(*whitep) && *p == '#')))
216 {
217 char_u *theline;
218
219 // End of the line, get the next one.
220 theline = eap->getline(':', eap->cookie, 0, TRUE);
221 if (theline == NULL)
222 break;
223 vim_free(*line_to_free);
224 *line_to_free = theline;
225 whitep = (char_u *)" ";
226 p = skipwhite(theline);
227 }
228
229 if (mustend && *p != endchar)
230 {
231 if (!skip)
232 semsg(_(e_invarg2), *argp);
233 goto err_ret;
234 }
235 if (*p == endchar)
236 break;
237
238 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
239 {
240 if (varargs != NULL)
241 *varargs = TRUE;
242 p += 3;
243 mustend = TRUE;
244
245 if (argtypes != NULL)
246 {
247 // ...name: list<type>
248 if (!eval_isnamec1(*p))
249 {
250 if (!skip)
251 emsg(_(e_missing_name_after_dots));
252 goto err_ret;
253 }
254
255 arg = p;
256 p = one_function_arg(p, newargs, argtypes, types_optional,
257 evalarg, TRUE, skip);
258 if (p == arg)
259 break;
260 if (*skipwhite(p) == '=')
261 {
262 emsg(_(e_cannot_use_default_for_variable_arguments));
263 break;
264 }
265 }
266 }
267 else
268 {
269 char_u *np;
270
271 arg = p;
272 p = one_function_arg(p, newargs, argtypes, types_optional,
273 evalarg, FALSE, skip);
274 if (p == arg)
275 break;
276
277 // Recognize " = expr" but not " == expr". A lambda can have
278 // "(a = expr" but "(a == expr" and "(a =~ expr" are not a lambda.
279 np = skipwhite(p);
280 if (*np == '=' && np[1] != '=' && np[1] != '~'
281 && default_args != NULL)
282 {
283 typval_T rettv;
284
285 // find the end of the expression (doesn't evaluate it)
286 any_default = TRUE;
287 p = skipwhite(p) + 1;
288 whitep = p;
289 p = skipwhite(p);
290 expr = p;
291 if (eval1(&p, &rettv, NULL) != FAIL)
292 {
293 if (!skip)
294 {
295 if (ga_grow(default_args, 1) == FAIL)
296 goto err_ret;
297
298 // trim trailing whitespace
299 while (p > expr && VIM_ISWHITE(p[-1]))
300 p--;
301 c = *p;
302 *p = NUL;
303 expr = vim_strsave(expr);
304 if (expr == NULL)
305 {
306 *p = c;
307 goto err_ret;
308 }
309 ((char_u **)(default_args->ga_data))
310 [default_args->ga_len] = expr;
311 default_args->ga_len++;
312 *p = c;
313 }
314 }
315 else
316 mustend = TRUE;
317 }
318 else if (any_default)
319 {
320 emsg(_("E989: Non-default argument follows default argument"));
321 goto err_ret;
322 }
323
324 if (VIM_ISWHITE(*p) && *skipwhite(p) == ',')
325 {
326 // Be tolerant when skipping
327 if (!skip)
328 {
329 semsg(_(e_no_white_space_allowed_before_str_str), ",", p);
330 goto err_ret;
331 }
332 p = skipwhite(p);
333 }
334 if (*p == ',')
335 {
336 ++p;
337 // Don't give this error when skipping, it makes the "->" not
338 // found in "{k,v -> x}" and give a confusing error.
339 // Allow missing space after comma in legacy functions.
340 if (!skip && argtypes != NULL
341 && !IS_WHITE_OR_NUL(*p) && *p != endchar)
342 {
343 semsg(_(e_white_space_required_after_str_str), ",", p - 1);
344 goto err_ret;
345 }
346 }
347 else
348 mustend = TRUE;
349 }
350 whitep = p;
351 p = skipwhite(p);
352 }
353
354 if (*p != endchar)
355 goto err_ret;
356 ++p; // skip "endchar"
357
358 *argp = p;
359 return OK;
360
361 err_ret:
362 if (newargs != NULL)
363 ga_clear_strings(newargs);
364 if (!skip && default_args != NULL)
365 ga_clear_strings(default_args);
366 return FAIL;
367 }
368
369 /*
370 * Parse the argument types, filling "fp->uf_arg_types".
371 * Return OK or FAIL.
372 */
373 static int
parse_argument_types(ufunc_T * fp,garray_T * argtypes,int varargs)374 parse_argument_types(ufunc_T *fp, garray_T *argtypes, int varargs)
375 {
376 int len = 0;
377
378 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
379 if (argtypes->ga_len > 0)
380 {
381 // When "varargs" is set the last name/type goes into uf_va_name
382 // and uf_va_type.
383 len = argtypes->ga_len - (varargs ? 1 : 0);
384
385 if (len > 0)
386 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
387 if (fp->uf_arg_types != NULL)
388 {
389 int i;
390 type_T *type;
391
392 for (i = 0; i < len; ++ i)
393 {
394 char_u *p = ((char_u **)argtypes->ga_data)[i];
395
396 if (p == NULL)
397 // will get the type from the default value
398 type = &t_unknown;
399 else
400 type = parse_type(&p, &fp->uf_type_list, TRUE);
401 if (type == NULL)
402 return FAIL;
403 fp->uf_arg_types[i] = type;
404 }
405 }
406 }
407
408 if (varargs)
409 {
410 char_u *p;
411
412 // Move the last argument "...name: type" to uf_va_name and
413 // uf_va_type.
414 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
415 [fp->uf_args.ga_len - 1];
416 --fp->uf_args.ga_len;
417 p = ((char_u **)argtypes->ga_data)[len];
418 if (p == NULL)
419 // TODO: get type from default value
420 fp->uf_va_type = &t_list_any;
421 else
422 {
423 fp->uf_va_type = parse_type(&p, &fp->uf_type_list, TRUE);
424 if (fp->uf_va_type != NULL && fp->uf_va_type->tt_type != VAR_LIST)
425 {
426 semsg(_(e_variable_arguments_type_must_be_list_str),
427 ((char_u **)argtypes->ga_data)[len]);
428 return FAIL;
429 }
430 }
431 if (fp->uf_va_type == NULL)
432 return FAIL;
433 }
434
435 return OK;
436 }
437
438 static int
parse_return_type(ufunc_T * fp,char_u * ret_type)439 parse_return_type(ufunc_T *fp, char_u *ret_type)
440 {
441 if (ret_type == NULL)
442 fp->uf_ret_type = &t_void;
443 else
444 {
445 char_u *p = ret_type;
446
447 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list, TRUE);
448 if (fp->uf_ret_type == NULL)
449 {
450 fp->uf_ret_type = &t_void;
451 return FAIL;
452 }
453 }
454 return OK;
455 }
456
457 /*
458 * Register function "fp" as using "current_funccal" as its scope.
459 */
460 static int
register_closure(ufunc_T * fp)461 register_closure(ufunc_T *fp)
462 {
463 if (fp->uf_scoped == current_funccal)
464 // no change
465 return OK;
466 funccal_unref(fp->uf_scoped, fp, FALSE);
467 fp->uf_scoped = current_funccal;
468 current_funccal->fc_refcount++;
469
470 if (ga_grow(¤t_funccal->fc_funcs, 1) == FAIL)
471 return FAIL;
472 ((ufunc_T **)current_funccal->fc_funcs.ga_data)
473 [current_funccal->fc_funcs.ga_len++] = fp;
474 return OK;
475 }
476
477 static void
set_ufunc_name(ufunc_T * fp,char_u * name)478 set_ufunc_name(ufunc_T *fp, char_u *name)
479 {
480 // Add a type cast to avoid a warning for an overflow, the uf_name[] array
481 // actually extends beyond the struct.
482 STRCPY((void *)fp->uf_name, name);
483
484 if (name[0] == K_SPECIAL)
485 {
486 fp->uf_name_exp = alloc(STRLEN(name) + 3);
487 if (fp->uf_name_exp != NULL)
488 {
489 STRCPY(fp->uf_name_exp, "<SNR>");
490 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
491 }
492 }
493 }
494
495 /*
496 * Get a name for a lambda. Returned in static memory.
497 */
498 char_u *
get_lambda_name(void)499 get_lambda_name(void)
500 {
501 static char_u name[30];
502 static int lambda_no = 0;
503
504 sprintf((char*)name, "<lambda>%d", ++lambda_no);
505 return name;
506 }
507
508 #if defined(FEAT_LUA) || defined(PROTO)
509 /*
510 * Registers a native C callback which can be called from Vim script.
511 * Returns the name of the Vim script function.
512 */
513 char_u *
register_cfunc(cfunc_T cb,cfunc_free_T cb_free,void * state)514 register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
515 {
516 char_u *name = get_lambda_name();
517 ufunc_T *fp;
518
519 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
520 if (fp == NULL)
521 return NULL;
522
523 fp->uf_def_status = UF_NOT_COMPILED;
524 fp->uf_refcount = 1;
525 fp->uf_varargs = TRUE;
526 fp->uf_flags = FC_CFUNC;
527 fp->uf_calls = 0;
528 fp->uf_script_ctx = current_sctx;
529 fp->uf_cb = cb;
530 fp->uf_cb_free = cb_free;
531 fp->uf_cb_state = state;
532
533 set_ufunc_name(fp, name);
534 hash_add(&func_hashtab, UF2HIKEY(fp));
535
536 return name;
537 }
538 #endif
539
540 /*
541 * Skip over "->" or "=>" after the arguments of a lambda.
542 * If ": type" is found make "ret_type" point to "type".
543 * If "white_error" is not NULL check for correct use of white space and set
544 * "white_error" to TRUE if there is an error.
545 * Return NULL if no valid arrow found.
546 */
547 static char_u *
skip_arrow(char_u * start,int equal_arrow,char_u ** ret_type,int * white_error)548 skip_arrow(
549 char_u *start,
550 int equal_arrow,
551 char_u **ret_type,
552 int *white_error)
553 {
554 char_u *s = start;
555 char_u *bef = start - 2; // "start" points to > of ->
556
557 if (equal_arrow)
558 {
559 if (*s == ':')
560 {
561 if (white_error != NULL && !VIM_ISWHITE(s[1]))
562 {
563 *white_error = TRUE;
564 semsg(_(e_white_space_required_after_str_str), ":", s);
565 return NULL;
566 }
567 s = skipwhite(s + 1);
568 *ret_type = s;
569 s = skip_type(s, TRUE);
570 if (s == *ret_type)
571 {
572 emsg(_(e_missing_return_type));
573 return NULL;
574 }
575 }
576 bef = s;
577 s = skipwhite(s);
578 if (*s != '=')
579 return NULL;
580 ++s;
581 }
582 if (*s != '>')
583 return NULL;
584 if (white_error != NULL && ((!VIM_ISWHITE(*bef) && *bef != '{')
585 || !IS_WHITE_OR_NUL(s[1])))
586 {
587 *white_error = TRUE;
588 semsg(_(e_white_space_required_before_and_after_str_at_str),
589 equal_arrow ? "=>" : "->", bef);
590 return NULL;
591 }
592 return skipwhite(s + 1);
593 }
594
595 /*
596 * Check if "*cmd" points to a function command and if so advance "*cmd" and
597 * return TRUE.
598 * Otherwise return FALSE;
599 * Do not consider "function(" to be a command.
600 */
601 static int
is_function_cmd(char_u ** cmd)602 is_function_cmd(char_u **cmd)
603 {
604 char_u *p = *cmd;
605
606 if (checkforcmd(&p, "function", 2))
607 {
608 if (*p == '(')
609 return FALSE;
610 *cmd = p;
611 return TRUE;
612 }
613 return FALSE;
614 }
615
616 /*
617 * Called when defining a function: The context may be needed for script
618 * variables declared in a block that is visible now but not when the function
619 * is compiled or called later.
620 */
621 static void
function_using_block_scopes(ufunc_T * fp,cstack_T * cstack)622 function_using_block_scopes(ufunc_T *fp, cstack_T *cstack)
623 {
624 if (cstack != NULL && cstack->cs_idx >= 0)
625 {
626 int count = cstack->cs_idx + 1;
627 int i;
628
629 fp->uf_block_ids = ALLOC_MULT(int, count);
630 if (fp->uf_block_ids != NULL)
631 {
632 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
633 sizeof(int) * count);
634 fp->uf_block_depth = count;
635 }
636
637 // Set flag in each block to indicate a function was defined. This
638 // is used to keep the variable when leaving the block, see
639 // hide_script_var().
640 for (i = 0; i <= cstack->cs_idx; ++i)
641 cstack->cs_flags[i] |= CSF_FUNC_DEF;
642 }
643 }
644
645 /*
646 * Read the body of a function, put every line in "newlines".
647 * This stops at "}", "endfunction" or "enddef".
648 * "newlines" must already have been initialized.
649 * "eap->cmdidx" is CMD_function, CMD_def or CMD_block;
650 */
651 static int
get_function_body(exarg_T * eap,garray_T * newlines,char_u * line_arg_in,char_u ** line_to_free)652 get_function_body(
653 exarg_T *eap,
654 garray_T *newlines,
655 char_u *line_arg_in,
656 char_u **line_to_free)
657 {
658 linenr_T sourcing_lnum_top = SOURCING_LNUM;
659 linenr_T sourcing_lnum_off;
660 int saved_wait_return = need_wait_return;
661 char_u *line_arg = line_arg_in;
662 int vim9_function = eap->cmdidx == CMD_def
663 || eap->cmdidx == CMD_block;
664 #define MAX_FUNC_NESTING 50
665 char nesting_def[MAX_FUNC_NESTING];
666 char nesting_inline[MAX_FUNC_NESTING];
667 int nesting = 0;
668 getline_opt_T getline_options;
669 int indent = 2;
670 char_u *skip_until = NULL;
671 int ret = FAIL;
672 int is_heredoc = FALSE;
673 int heredoc_concat_len = 0;
674 garray_T heredoc_ga;
675 char_u *heredoc_trimmed = NULL;
676
677 ga_init2(&heredoc_ga, 1, 500);
678
679 // Detect having skipped over comment lines to find the return
680 // type. Add NULL lines to keep the line count correct.
681 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
682 if (SOURCING_LNUM < sourcing_lnum_off)
683 {
684 sourcing_lnum_off -= SOURCING_LNUM;
685 if (ga_grow(newlines, sourcing_lnum_off) == FAIL)
686 goto theend;
687 while (sourcing_lnum_off-- > 0)
688 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
689 }
690
691 nesting_def[0] = vim9_function;
692 nesting_inline[0] = eap->cmdidx == CMD_block;
693 getline_options = vim9_function
694 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
695 for (;;)
696 {
697 char_u *theline;
698 char_u *p;
699 char_u *arg;
700
701 if (KeyTyped)
702 {
703 msg_scroll = TRUE;
704 saved_wait_return = FALSE;
705 }
706 need_wait_return = FALSE;
707
708 if (line_arg != NULL)
709 {
710 // Use eap->arg, split up in parts by line breaks.
711 theline = line_arg;
712 p = vim_strchr(theline, '\n');
713 if (p == NULL)
714 line_arg += STRLEN(line_arg);
715 else
716 {
717 *p = NUL;
718 line_arg = p + 1;
719 }
720 }
721 else
722 {
723 vim_free(*line_to_free);
724 if (eap->getline == NULL)
725 theline = getcmdline(':', 0L, indent, getline_options);
726 else
727 theline = eap->getline(':', eap->cookie, indent,
728 getline_options);
729 *line_to_free = theline;
730 }
731 if (KeyTyped)
732 lines_left = Rows - 1;
733 if (theline == NULL)
734 {
735 // Use the start of the function for the line number.
736 SOURCING_LNUM = sourcing_lnum_top;
737 if (skip_until != NULL)
738 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
739 else if (nesting_inline[nesting])
740 emsg(_(e_missing_end_block));
741 else if (eap->cmdidx == CMD_def)
742 emsg(_(e_missing_enddef));
743 else
744 emsg(_("E126: Missing :endfunction"));
745 goto theend;
746 }
747
748 // Detect line continuation: SOURCING_LNUM increased more than one.
749 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
750 if (SOURCING_LNUM < sourcing_lnum_off)
751 sourcing_lnum_off -= SOURCING_LNUM;
752 else
753 sourcing_lnum_off = 0;
754
755 if (skip_until != NULL)
756 {
757 // Don't check for ":endfunc"/":enddef" between
758 // * ":append" and "."
759 // * ":python <<EOF" and "EOF"
760 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
761 if (heredoc_trimmed == NULL
762 || (is_heredoc && skipwhite(theline) == theline)
763 || STRNCMP(theline, heredoc_trimmed,
764 STRLEN(heredoc_trimmed)) == 0)
765 {
766 if (heredoc_trimmed == NULL)
767 p = theline;
768 else if (is_heredoc)
769 p = skipwhite(theline) == theline
770 ? theline : theline + STRLEN(heredoc_trimmed);
771 else
772 p = theline + STRLEN(heredoc_trimmed);
773 if (STRCMP(p, skip_until) == 0)
774 {
775 VIM_CLEAR(skip_until);
776 VIM_CLEAR(heredoc_trimmed);
777 getline_options = vim9_function
778 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
779 is_heredoc = FALSE;
780
781 if (heredoc_concat_len > 0)
782 {
783 // Replace the starting line with all the concatenated
784 // lines.
785 ga_concat(&heredoc_ga, theline);
786 vim_free(((char_u **)(newlines->ga_data))[
787 heredoc_concat_len - 1]);
788 ((char_u **)(newlines->ga_data))[
789 heredoc_concat_len - 1] = heredoc_ga.ga_data;
790 ga_init(&heredoc_ga);
791 heredoc_concat_len = 0;
792 theline += STRLEN(theline); // skip the "EOF"
793 }
794 }
795 }
796 }
797 else
798 {
799 int c;
800 char_u *end;
801
802 // skip ':' and blanks
803 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
804 ;
805
806 // Check for "endfunction", "enddef" or "}".
807 // When a ":" follows it must be a dict key; "enddef: value,"
808 if (nesting_inline[nesting]
809 ? *p == '}'
810 : (checkforcmd(&p, nesting_def[nesting]
811 ? "enddef" : "endfunction", 4)
812 && *p != ':'))
813 {
814 if (nesting-- == 0)
815 {
816 char_u *nextcmd = NULL;
817
818 if (*p == '|' || *p == '}')
819 nextcmd = p + 1;
820 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
821 nextcmd = line_arg;
822 else if (*p != NUL && *p != (vim9_function ? '#' : '"')
823 && (vim9_function || p_verbose > 0))
824 {
825 SOURCING_LNUM = sourcing_lnum_top
826 + newlines->ga_len + 1;
827 if (eap->cmdidx == CMD_def)
828 semsg(_(e_text_found_after_enddef_str), p);
829 else
830 give_warning2((char_u *)
831 _("W22: Text found after :endfunction: %s"),
832 p, TRUE);
833 }
834 if (nextcmd != NULL && *skipwhite(nextcmd) != NUL)
835 {
836 // Another command follows. If the line came from "eap"
837 // we can simply point into it, otherwise we need to
838 // change "eap->cmdlinep".
839 eap->nextcmd = nextcmd;
840 if (*line_to_free != NULL)
841 {
842 vim_free(*eap->cmdlinep);
843 *eap->cmdlinep = *line_to_free;
844 *line_to_free = NULL;
845 }
846 }
847 break;
848 }
849 }
850
851 // Check for mismatched "endfunc" or "enddef".
852 // We don't check for "def" inside "func" thus we also can't check
853 // for "enddef".
854 // We continue to find the end of the function, although we might
855 // not find it.
856 else if (nesting_def[nesting])
857 {
858 if (checkforcmd(&p, "endfunction", 4) && *p != ':')
859 emsg(_(e_mismatched_endfunction));
860 }
861 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
862 emsg(_(e_mismatched_enddef));
863
864 // Increase indent inside "if", "while", "for" and "try", decrease
865 // at "end".
866 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
867 indent -= 2;
868 else if (STRNCMP(p, "if", 2) == 0
869 || STRNCMP(p, "wh", 2) == 0
870 || STRNCMP(p, "for", 3) == 0
871 || STRNCMP(p, "try", 3) == 0)
872 indent += 2;
873
874 // Check for defining a function inside this function.
875 // Only recognize "def" inside "def", not inside "function",
876 // For backwards compatibility, see Test_function_python().
877 c = *p;
878 if (is_function_cmd(&p)
879 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
880 {
881 if (*p == '!')
882 p = skipwhite(p + 1);
883 p += eval_fname_script(p);
884 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
885 NULL, NULL));
886 if (*skipwhite(p) == '(')
887 {
888 if (nesting == MAX_FUNC_NESTING - 1)
889 emsg(_(e_function_nesting_too_deep));
890 else
891 {
892 ++nesting;
893 nesting_def[nesting] = (c == 'd');
894 nesting_inline[nesting] = FALSE;
895 indent += 2;
896 }
897 }
898 }
899
900 if (nesting_def[nesting] ? *p != '#' : *p != '"')
901 {
902 // Not a comment line: check for nested inline function.
903 end = p + STRLEN(p) - 1;
904 while (end > p && VIM_ISWHITE(*end))
905 --end;
906 if (end > p + 1 && *end == '{' && VIM_ISWHITE(end[-1]))
907 {
908 int is_block;
909
910 // check for trailing "=> {": start of an inline function
911 --end;
912 while (end > p && VIM_ISWHITE(*end))
913 --end;
914 is_block = end > p + 2 && end[-1] == '=' && end[0] == '>';
915 if (!is_block)
916 {
917 char_u *s = p;
918
919 // check for line starting with "au" for :autocmd or
920 // "com" for :command, these can use a {} block
921 is_block = checkforcmd_noparen(&s, "autocmd", 2)
922 || checkforcmd_noparen(&s, "command", 3);
923 }
924
925 if (is_block)
926 {
927 if (nesting == MAX_FUNC_NESTING - 1)
928 emsg(_(e_function_nesting_too_deep));
929 else
930 {
931 ++nesting;
932 nesting_def[nesting] = TRUE;
933 nesting_inline[nesting] = TRUE;
934 indent += 2;
935 }
936 }
937 }
938 }
939
940 // Check for ":append", ":change", ":insert". Not for :def.
941 p = skip_range(p, FALSE, NULL);
942 if (!vim9_function
943 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
944 || (p[0] == 'c'
945 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
946 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
947 && (STRNCMP(&p[3], "nge", 3) != 0
948 || !ASCII_ISALPHA(p[6])))))))
949 || (p[0] == 'i'
950 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
951 && (!ASCII_ISALPHA(p[2])
952 || (p[2] == 's'
953 && (!ASCII_ISALPHA(p[3])
954 || p[3] == 'e'))))))))
955 skip_until = vim_strsave((char_u *)".");
956
957 // Check for ":python <<EOF", ":tcl <<EOF", etc.
958 arg = skipwhite(skiptowhite(p));
959 if (arg[0] == '<' && arg[1] =='<'
960 && ((p[0] == 'p' && p[1] == 'y'
961 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
962 || ((p[2] == '3' || p[2] == 'x')
963 && !ASCII_ISALPHA(p[3]))))
964 || (p[0] == 'p' && p[1] == 'e'
965 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
966 || (p[0] == 't' && p[1] == 'c'
967 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
968 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
969 && !ASCII_ISALPHA(p[3]))
970 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
971 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
972 || (p[0] == 'm' && p[1] == 'z'
973 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
974 ))
975 {
976 // ":python <<" continues until a dot, like ":append"
977 p = skipwhite(arg + 2);
978 if (STRNCMP(p, "trim", 4) == 0)
979 {
980 // Ignore leading white space.
981 p = skipwhite(p + 4);
982 heredoc_trimmed = vim_strnsave(theline,
983 skipwhite(theline) - theline);
984 }
985 if (*p == NUL)
986 skip_until = vim_strsave((char_u *)".");
987 else
988 skip_until = vim_strnsave(p, skiptowhite(p) - p);
989 getline_options = GETLINE_NONE;
990 is_heredoc = TRUE;
991 if (eap->cmdidx == CMD_def)
992 heredoc_concat_len = newlines->ga_len + 1;
993 }
994
995 // Check for ":cmd v =<< [trim] EOF"
996 // and ":cmd [a, b] =<< [trim] EOF"
997 // and "lines =<< [trim] EOF" for Vim9
998 // Where "cmd" can be "let", "var", "final" or "const".
999 arg = skipwhite(skiptowhite(p));
1000 if (*arg == '[')
1001 arg = vim_strchr(arg, ']');
1002 if (arg != NULL)
1003 {
1004 int found = (eap->cmdidx == CMD_def && arg[0] == '='
1005 && arg[1] == '<' && arg[2] =='<');
1006
1007 if (!found)
1008 // skip over the argument after "cmd"
1009 arg = skipwhite(skiptowhite(arg));
1010 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<'
1011 && (checkforcmd(&p, "let", 2)
1012 || checkforcmd(&p, "var", 3)
1013 || checkforcmd(&p, "final", 5)
1014 || checkforcmd(&p, "const", 5))))
1015 {
1016 p = skipwhite(arg + 3);
1017 if (STRNCMP(p, "trim", 4) == 0)
1018 {
1019 // Ignore leading white space.
1020 p = skipwhite(p + 4);
1021 heredoc_trimmed = vim_strnsave(theline,
1022 skipwhite(theline) - theline);
1023 }
1024 skip_until = vim_strnsave(p, skiptowhite(p) - p);
1025 getline_options = GETLINE_NONE;
1026 is_heredoc = TRUE;
1027 }
1028 }
1029 }
1030
1031 // Add the line to the function.
1032 if (ga_grow(newlines, 1 + sourcing_lnum_off) == FAIL)
1033 goto theend;
1034
1035 if (heredoc_concat_len > 0)
1036 {
1037 // For a :def function "python << EOF" concatenats all the lines,
1038 // to be used for the instruction later.
1039 ga_concat(&heredoc_ga, theline);
1040 ga_concat(&heredoc_ga, (char_u *)"\n");
1041 p = vim_strsave((char_u *)"");
1042 }
1043 else
1044 {
1045 // Copy the line to newly allocated memory. get_one_sourceline()
1046 // allocates 250 bytes per line, this saves 80% on average. The
1047 // cost is an extra alloc/free.
1048 p = vim_strsave(theline);
1049 }
1050 if (p == NULL)
1051 goto theend;
1052 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = p;
1053
1054 // Add NULL lines for continuation lines, so that the line count is
1055 // equal to the index in the growarray.
1056 while (sourcing_lnum_off-- > 0)
1057 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
1058
1059 // Check for end of eap->arg.
1060 if (line_arg != NULL && *line_arg == NUL)
1061 line_arg = NULL;
1062 }
1063
1064 // Return OK when no error was detected.
1065 if (!did_emsg)
1066 ret = OK;
1067
1068 theend:
1069 vim_free(skip_until);
1070 vim_free(heredoc_trimmed);
1071 vim_free(heredoc_ga.ga_data);
1072 need_wait_return |= saved_wait_return;
1073 return ret;
1074 }
1075
1076 /*
1077 * Handle the body of a lambda. *arg points to the "{", process statements
1078 * until the matching "}".
1079 * When not evaluating "newargs" is NULL.
1080 * When successful "rettv" is set to a funcref.
1081 */
1082 static int
lambda_function_body(char_u ** arg,typval_T * rettv,evalarg_T * evalarg,garray_T * newargs,garray_T * argtypes,int varargs,garray_T * default_args,char_u * ret_type)1083 lambda_function_body(
1084 char_u **arg,
1085 typval_T *rettv,
1086 evalarg_T *evalarg,
1087 garray_T *newargs,
1088 garray_T *argtypes,
1089 int varargs,
1090 garray_T *default_args,
1091 char_u *ret_type)
1092 {
1093 int evaluate = (evalarg->eval_flags & EVAL_EVALUATE);
1094 garray_T *gap = &evalarg->eval_ga;
1095 garray_T *freegap = &evalarg->eval_freega;
1096 ufunc_T *ufunc = NULL;
1097 exarg_T eap;
1098 garray_T newlines;
1099 char_u *cmdline = NULL;
1100 int ret = FAIL;
1101 char_u *line_to_free = NULL;
1102 partial_T *pt;
1103 char_u *name;
1104 int lnum_save = -1;
1105 linenr_T sourcing_lnum_top = SOURCING_LNUM;
1106
1107 if (!ends_excmd2(*arg, skipwhite(*arg + 1)))
1108 {
1109 semsg(_(e_trailing_arg), *arg + 1);
1110 return FAIL;
1111 }
1112
1113 CLEAR_FIELD(eap);
1114 eap.cmdidx = CMD_block;
1115 eap.forceit = FALSE;
1116 eap.cmdlinep = &cmdline;
1117 eap.skip = !evaluate;
1118 if (evalarg->eval_cctx != NULL)
1119 fill_exarg_from_cctx(&eap, evalarg->eval_cctx);
1120 else
1121 {
1122 eap.getline = evalarg->eval_getline;
1123 eap.cookie = evalarg->eval_cookie;
1124 }
1125
1126 ga_init2(&newlines, (int)sizeof(char_u *), 10);
1127 if (get_function_body(&eap, &newlines, NULL, &line_to_free) == FAIL)
1128 {
1129 vim_free(cmdline);
1130 goto erret;
1131 }
1132
1133 // When inside a lambda must add the function lines to evalarg.eval_ga.
1134 evalarg->eval_break_count += newlines.ga_len;
1135 if (gap->ga_itemsize > 0)
1136 {
1137 int idx;
1138 char_u *last;
1139 size_t plen;
1140 char_u *pnl;
1141
1142 for (idx = 0; idx < newlines.ga_len; ++idx)
1143 {
1144 char_u *p = skipwhite(((char_u **)newlines.ga_data)[idx]);
1145
1146 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
1147 goto erret;
1148
1149 // Going to concatenate the lines after parsing. For an empty or
1150 // comment line use an empty string.
1151 // Insert NL characters at the start of each line, the string will
1152 // be split again later in .get_lambda_tv().
1153 if (*p == NUL || vim9_comment_start(p))
1154 p = (char_u *)"";
1155 plen = STRLEN(p);
1156 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1157 if (pnl != NULL)
1158 mch_memmove(pnl + 1, p, plen + 1);
1159 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1160 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
1161 }
1162 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
1163 goto erret;
1164 if (cmdline != NULL)
1165 // more is following after the "}", which was skipped
1166 last = cmdline;
1167 else
1168 // nothing is following the "}"
1169 last = (char_u *)"}";
1170 plen = STRLEN(last);
1171 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1172 if (pnl != NULL)
1173 mch_memmove(pnl + 1, last, plen + 1);
1174 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1175 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
1176 }
1177
1178 if (cmdline != NULL)
1179 {
1180 garray_T *tfgap = &evalarg->eval_tofree_ga;
1181
1182 // Something comes after the "}".
1183 *arg = eap.nextcmd;
1184
1185 // "arg" points into cmdline, need to keep the line and free it later.
1186 if (ga_grow(tfgap, 1) == OK)
1187 {
1188 ((char_u **)(tfgap->ga_data))[tfgap->ga_len++] = cmdline;
1189 evalarg->eval_using_cmdline = TRUE;
1190 }
1191 }
1192 else
1193 *arg = (char_u *)"";
1194
1195 if (!evaluate)
1196 {
1197 ret = OK;
1198 goto erret;
1199 }
1200
1201 name = get_lambda_name();
1202 ufunc = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
1203 if (ufunc == NULL)
1204 goto erret;
1205 set_ufunc_name(ufunc, name);
1206 if (hash_add(&func_hashtab, UF2HIKEY(ufunc)) == FAIL)
1207 goto erret;
1208 ufunc->uf_refcount = 1;
1209 ufunc->uf_args = *newargs;
1210 newargs->ga_data = NULL;
1211 ufunc->uf_def_args = *default_args;
1212 default_args->ga_data = NULL;
1213 ufunc->uf_func_type = &t_func_any;
1214
1215 // error messages are for the first function line
1216 lnum_save = SOURCING_LNUM;
1217 SOURCING_LNUM = sourcing_lnum_top;
1218
1219 // parse argument types
1220 if (parse_argument_types(ufunc, argtypes, varargs) == FAIL)
1221 {
1222 SOURCING_LNUM = lnum_save;
1223 goto erret;
1224 }
1225
1226 // parse the return type, if any
1227 if (parse_return_type(ufunc, ret_type) == FAIL)
1228 goto erret;
1229
1230 pt = ALLOC_CLEAR_ONE(partial_T);
1231 if (pt == NULL)
1232 goto erret;
1233 pt->pt_func = ufunc;
1234 pt->pt_refcount = 1;
1235
1236 ufunc->uf_lines = newlines;
1237 newlines.ga_data = NULL;
1238 if (sandbox)
1239 ufunc->uf_flags |= FC_SANDBOX;
1240 if (!ASCII_ISUPPER(*ufunc->uf_name))
1241 ufunc->uf_flags |= FC_VIM9;
1242 ufunc->uf_script_ctx = current_sctx;
1243 ufunc->uf_script_ctx_version = current_sctx.sc_version;
1244 ufunc->uf_script_ctx.sc_lnum += sourcing_lnum_top;
1245 set_function_type(ufunc);
1246
1247 function_using_block_scopes(ufunc, evalarg->eval_cstack);
1248
1249 rettv->vval.v_partial = pt;
1250 rettv->v_type = VAR_PARTIAL;
1251 ufunc = NULL;
1252 ret = OK;
1253
1254 erret:
1255 if (lnum_save >= 0)
1256 SOURCING_LNUM = lnum_save;
1257 vim_free(line_to_free);
1258 ga_clear_strings(&newlines);
1259 if (newargs != NULL)
1260 ga_clear_strings(newargs);
1261 ga_clear_strings(default_args);
1262 if (ufunc != NULL)
1263 {
1264 func_clear(ufunc, TRUE);
1265 func_free(ufunc, TRUE);
1266 }
1267 return ret;
1268 }
1269
1270 /*
1271 * Parse a lambda expression and get a Funcref from "*arg" into "rettv".
1272 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
1273 * When "types_optional" is TRUE optionally take argument types.
1274 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
1275 */
1276 int
get_lambda_tv(char_u ** arg,typval_T * rettv,int types_optional,evalarg_T * evalarg)1277 get_lambda_tv(
1278 char_u **arg,
1279 typval_T *rettv,
1280 int types_optional,
1281 evalarg_T *evalarg)
1282 {
1283 int evaluate = evalarg != NULL
1284 && (evalarg->eval_flags & EVAL_EVALUATE);
1285 garray_T newargs;
1286 garray_T newlines;
1287 garray_T *pnewargs;
1288 garray_T argtypes;
1289 garray_T default_args;
1290 ufunc_T *fp = NULL;
1291 partial_T *pt = NULL;
1292 int varargs;
1293 char_u *ret_type = NULL;
1294 int ret;
1295 char_u *s;
1296 char_u *start, *end;
1297 int *old_eval_lavars = eval_lavars_used;
1298 int eval_lavars = FALSE;
1299 char_u *tofree1 = NULL;
1300 char_u *tofree2 = NULL;
1301 int equal_arrow = **arg == '(';
1302 int white_error = FALSE;
1303 int called_emsg_start = called_emsg;
1304
1305 if (equal_arrow && !in_vim9script())
1306 return NOTDONE;
1307
1308 ga_init(&newargs);
1309 ga_init(&newlines);
1310
1311 // First, check if this is really a lambda expression. "->" or "=>" must
1312 // be found after the arguments.
1313 s = *arg + 1;
1314 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
1315 types_optional ? &argtypes : NULL, types_optional, evalarg,
1316 NULL, &default_args, TRUE, NULL, NULL);
1317 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
1318 {
1319 if (types_optional)
1320 ga_clear_strings(&argtypes);
1321 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
1322 }
1323
1324 // Parse the arguments for real.
1325 if (evaluate)
1326 pnewargs = &newargs;
1327 else
1328 pnewargs = NULL;
1329 *arg += 1;
1330 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
1331 types_optional ? &argtypes : NULL, types_optional, evalarg,
1332 &varargs, &default_args,
1333 FALSE, NULL, NULL);
1334 if (ret == FAIL
1335 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
1336 equal_arrow || in_vim9script() ? &white_error : NULL)) == NULL)
1337 {
1338 if (types_optional)
1339 ga_clear_strings(&argtypes);
1340 ga_clear_strings(&newargs);
1341 return white_error ? FAIL : NOTDONE;
1342 }
1343 *arg = s;
1344
1345 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
1346 if (ret_type != NULL)
1347 {
1348 ret_type = vim_strsave(ret_type);
1349 tofree2 = ret_type;
1350 }
1351
1352 // Set up a flag for checking local variables and arguments.
1353 if (evaluate)
1354 eval_lavars_used = &eval_lavars;
1355
1356 *arg = skipwhite_and_linebreak(*arg, evalarg);
1357
1358 // Recognize "{" as the start of a function body.
1359 if (equal_arrow && **arg == '{')
1360 {
1361 if (evalarg == NULL)
1362 // cannot happen?
1363 goto theend;
1364 if (lambda_function_body(arg, rettv, evalarg, pnewargs,
1365 types_optional ? &argtypes : NULL, varargs,
1366 &default_args, ret_type) == FAIL)
1367 goto errret;
1368 goto theend;
1369 }
1370 if (default_args.ga_len > 0)
1371 {
1372 emsg(_(e_cannot_use_default_values_in_lambda));
1373 goto errret;
1374 }
1375
1376 // Get the start and the end of the expression.
1377 start = *arg;
1378 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
1379 if (ret == FAIL)
1380 goto errret;
1381 if (evalarg != NULL)
1382 {
1383 // avoid that the expression gets freed when another line break follows
1384 tofree1 = evalarg->eval_tofree;
1385 evalarg->eval_tofree = NULL;
1386 }
1387
1388 if (!equal_arrow)
1389 {
1390 *arg = skipwhite_and_linebreak(*arg, evalarg);
1391 if (**arg != '}')
1392 {
1393 semsg(_("E451: Expected }: %s"), *arg);
1394 goto errret;
1395 }
1396 ++*arg;
1397 }
1398
1399 if (evaluate)
1400 {
1401 int len;
1402 int flags = 0;
1403 char_u *p;
1404 char_u *line_end;
1405 char_u *name = get_lambda_name();
1406
1407 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
1408 if (fp == NULL)
1409 goto errret;
1410 fp->uf_def_status = UF_NOT_COMPILED;
1411 pt = ALLOC_CLEAR_ONE(partial_T);
1412 if (pt == NULL)
1413 goto errret;
1414
1415 ga_init2(&newlines, (int)sizeof(char_u *), 1);
1416 if (ga_grow(&newlines, 1) == FAIL)
1417 goto errret;
1418
1419 // If there are line breaks, we need to split up the string.
1420 line_end = vim_strchr(start, '\n');
1421 if (line_end == NULL || line_end > end)
1422 line_end = end;
1423
1424 // Add "return " before the expression (or the first line).
1425 len = 7 + (int)(line_end - start) + 1;
1426 p = alloc(len);
1427 if (p == NULL)
1428 goto errret;
1429 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
1430 STRCPY(p, "return ");
1431 vim_strncpy(p + 7, start, line_end - start);
1432
1433 if (line_end != end)
1434 {
1435 // Add more lines, split by line breaks. Thus is used when a
1436 // lambda with { cmds } is encountered.
1437 while (*line_end == '\n')
1438 {
1439 if (ga_grow(&newlines, 1) == FAIL)
1440 goto errret;
1441 start = line_end + 1;
1442 line_end = vim_strchr(start, '\n');
1443 if (line_end == NULL)
1444 line_end = end;
1445 ((char_u **)(newlines.ga_data))[newlines.ga_len++] =
1446 vim_strnsave(start, line_end - start);
1447 }
1448 }
1449
1450 if (strstr((char *)p + 7, "a:") == NULL)
1451 // No a: variables are used for sure.
1452 flags |= FC_NOARGS;
1453
1454 fp->uf_refcount = 1;
1455 set_ufunc_name(fp, name);
1456 fp->uf_args = newargs;
1457 ga_init(&fp->uf_def_args);
1458 if (types_optional)
1459 {
1460 if (parse_argument_types(fp, &argtypes,
1461 in_vim9script() && varargs) == FAIL)
1462 goto errret;
1463 if (ret_type != NULL)
1464 {
1465 fp->uf_ret_type = parse_type(&ret_type,
1466 &fp->uf_type_list, TRUE);
1467 if (fp->uf_ret_type == NULL)
1468 goto errret;
1469 }
1470 else
1471 fp->uf_ret_type = &t_unknown;
1472 }
1473
1474 fp->uf_lines = newlines;
1475 if (current_funccal != NULL && eval_lavars)
1476 {
1477 flags |= FC_CLOSURE;
1478 if (register_closure(fp) == FAIL)
1479 goto errret;
1480 }
1481
1482 #ifdef FEAT_PROFILE
1483 if (prof_def_func())
1484 func_do_profile(fp);
1485 #endif
1486 if (sandbox)
1487 flags |= FC_SANDBOX;
1488 // In legacy script a lambda can be called with more args than
1489 // uf_args.ga_len. In Vim9 script "...name" has to be used.
1490 fp->uf_varargs = !in_vim9script() || varargs;
1491 fp->uf_flags = flags;
1492 fp->uf_calls = 0;
1493 fp->uf_script_ctx = current_sctx;
1494 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len + 1;
1495
1496 function_using_block_scopes(fp, evalarg->eval_cstack);
1497
1498 pt->pt_func = fp;
1499 pt->pt_refcount = 1;
1500 rettv->vval.v_partial = pt;
1501 rettv->v_type = VAR_PARTIAL;
1502
1503 hash_add(&func_hashtab, UF2HIKEY(fp));
1504 }
1505
1506 theend:
1507 eval_lavars_used = old_eval_lavars;
1508 if (evalarg != NULL && evalarg->eval_tofree == NULL)
1509 evalarg->eval_tofree = tofree1;
1510 else
1511 vim_free(tofree1);
1512 vim_free(tofree2);
1513 if (types_optional)
1514 ga_clear_strings(&argtypes);
1515
1516 return OK;
1517
1518 errret:
1519 ga_clear_strings(&newargs);
1520 ga_clear_strings(&newlines);
1521 ga_clear_strings(&default_args);
1522 if (types_optional)
1523 {
1524 ga_clear_strings(&argtypes);
1525 if (fp != NULL)
1526 vim_free(fp->uf_arg_types);
1527 }
1528 vim_free(fp);
1529 vim_free(pt);
1530 if (evalarg != NULL && evalarg->eval_tofree == NULL)
1531 evalarg->eval_tofree = tofree1;
1532 else
1533 vim_free(tofree1);
1534 vim_free(tofree2);
1535 eval_lavars_used = old_eval_lavars;
1536 return FAIL;
1537 }
1538
1539 /*
1540 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
1541 * name it contains, otherwise return "name".
1542 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
1543 * "partialp".
1544 * If "type" is not NULL and a Vim9 script-local variable is found look up the
1545 * type of the variable.
1546 */
1547 char_u *
deref_func_name(char_u * name,int * lenp,partial_T ** partialp,type_T ** type,int no_autoload)1548 deref_func_name(
1549 char_u *name,
1550 int *lenp,
1551 partial_T **partialp,
1552 type_T **type,
1553 int no_autoload)
1554 {
1555 dictitem_T *v;
1556 typval_T *tv = NULL;
1557 int cc;
1558 char_u *s = NULL;
1559 hashtab_T *ht;
1560 int did_type = FALSE;
1561
1562 if (partialp != NULL)
1563 *partialp = NULL;
1564
1565 cc = name[*lenp];
1566 name[*lenp] = NUL;
1567
1568 v = find_var(name, &ht, no_autoload);
1569 name[*lenp] = cc;
1570 if (v != NULL)
1571 {
1572 tv = &v->di_tv;
1573 }
1574 else if (in_vim9script() || STRNCMP(name, "s:", 2) == 0)
1575 {
1576 imported_T *import;
1577 char_u *p = name;
1578 int len = *lenp;
1579
1580 if (STRNCMP(name, "s:", 2) == 0)
1581 {
1582 p = name + 2;
1583 len -= 2;
1584 }
1585 import = find_imported(p, len, NULL);
1586
1587 // imported variable from another script
1588 if (import != NULL)
1589 {
1590 if (import->imp_funcname != NULL)
1591 {
1592 s = import->imp_funcname;
1593 *lenp = (int)STRLEN(s);
1594 return s;
1595 }
1596 // TODO: what if (import->imp_flags & IMP_FLAGS_STAR)
1597 {
1598 scriptitem_T *si = SCRIPT_ITEM(import->imp_sid);
1599 svar_T *sv = ((svar_T *)si->sn_var_vals.ga_data)
1600 + import->imp_var_vals_idx;
1601 tv = sv->sv_tv;
1602 if (type != NULL)
1603 *type = sv->sv_type;
1604 did_type = TRUE;
1605 }
1606 }
1607 }
1608
1609 if (tv != NULL)
1610 {
1611 if (tv->v_type == VAR_FUNC)
1612 {
1613 if (tv->vval.v_string == NULL)
1614 {
1615 *lenp = 0;
1616 return (char_u *)""; // just in case
1617 }
1618 s = tv->vval.v_string;
1619 *lenp = (int)STRLEN(s);
1620 }
1621
1622 if (tv->v_type == VAR_PARTIAL)
1623 {
1624 partial_T *pt = tv->vval.v_partial;
1625
1626 if (pt == NULL)
1627 {
1628 *lenp = 0;
1629 return (char_u *)""; // just in case
1630 }
1631 if (partialp != NULL)
1632 *partialp = pt;
1633 s = partial_name(pt);
1634 *lenp = (int)STRLEN(s);
1635 }
1636
1637 if (s != NULL)
1638 {
1639 if (!did_type && type != NULL && ht == get_script_local_ht())
1640 {
1641 svar_T *sv = find_typval_in_script(tv);
1642
1643 if (sv != NULL)
1644 *type = sv->sv_type;
1645 }
1646 return s;
1647 }
1648 }
1649
1650 return name;
1651 }
1652
1653 /*
1654 * Give an error message with a function name. Handle <SNR> things.
1655 * "ermsg" is to be passed without translation, use N_() instead of _().
1656 */
1657 void
emsg_funcname(char * ermsg,char_u * name)1658 emsg_funcname(char *ermsg, char_u *name)
1659 {
1660 char_u *p;
1661
1662 if (*name == K_SPECIAL)
1663 p = concat_str((char_u *)"<SNR>", name + 3);
1664 else
1665 p = name;
1666 semsg(_(ermsg), p);
1667 if (p != name)
1668 vim_free(p);
1669 }
1670
1671 /*
1672 * Allocate a variable for the result of a function.
1673 * Return OK or FAIL.
1674 */
1675 int
get_func_tv(char_u * name,int len,typval_T * rettv,char_u ** arg,evalarg_T * evalarg,funcexe_T * funcexe)1676 get_func_tv(
1677 char_u *name, // name of the function
1678 int len, // length of "name" or -1 to use strlen()
1679 typval_T *rettv,
1680 char_u **arg, // argument, pointing to the '('
1681 evalarg_T *evalarg, // for line continuation
1682 funcexe_T *funcexe) // various values
1683 {
1684 char_u *argp;
1685 int ret = OK;
1686 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1687 int argcount = 0; // number of arguments found
1688 int vim9script = in_vim9script();
1689
1690 /*
1691 * Get the arguments.
1692 */
1693 argp = *arg;
1694 while (argcount < MAX_FUNC_ARGS - (funcexe->partial == NULL ? 0
1695 : funcexe->partial->pt_argc))
1696 {
1697 // skip the '(' or ',' and possibly line breaks
1698 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1699
1700 if (*argp == ')' || *argp == ',' || *argp == NUL)
1701 break;
1702 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
1703 {
1704 ret = FAIL;
1705 break;
1706 }
1707 ++argcount;
1708 // The comma should come right after the argument, but this wasn't
1709 // checked previously, thus only enforce it in Vim9 script.
1710 if (vim9script)
1711 {
1712 if (*argp != ',' && *skipwhite(argp) == ',')
1713 {
1714 semsg(_(e_no_white_space_allowed_before_str_str), ",", argp);
1715 ret = FAIL;
1716 break;
1717 }
1718 }
1719 else
1720 argp = skipwhite(argp);
1721 if (*argp != ',')
1722 break;
1723 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1724 {
1725 semsg(_(e_white_space_required_after_str_str), ",", argp);
1726 ret = FAIL;
1727 break;
1728 }
1729 }
1730 argp = skipwhite_and_linebreak(argp, evalarg);
1731 if (*argp == ')')
1732 ++argp;
1733 else
1734 ret = FAIL;
1735
1736 if (ret == OK)
1737 {
1738 int i = 0;
1739 int did_emsg_before = did_emsg;
1740
1741 if (get_vim_var_nr(VV_TESTING))
1742 {
1743 // Prepare for calling test_garbagecollect_now(), need to know
1744 // what variables are used on the call stack.
1745 if (funcargs.ga_itemsize == 0)
1746 ga_init2(&funcargs, (int)sizeof(typval_T *), 50);
1747 for (i = 0; i < argcount; ++i)
1748 if (ga_grow(&funcargs, 1) == OK)
1749 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1750 &argvars[i];
1751 }
1752
1753 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
1754 if (in_vim9script() && did_emsg > did_emsg_before)
1755 {
1756 // An error in a builtin function does not return FAIL, but we do
1757 // want to abort further processing if an error was given.
1758 ret = FAIL;
1759 clear_tv(rettv);
1760 }
1761
1762 funcargs.ga_len -= i;
1763 }
1764 else if (!aborting())
1765 {
1766 if (argcount == MAX_FUNC_ARGS)
1767 emsg_funcname(N_("E740: Too many arguments for function %s"), name);
1768 else
1769 emsg_funcname(N_("E116: Invalid arguments for function %s"), name);
1770 }
1771
1772 while (--argcount >= 0)
1773 clear_tv(&argvars[argcount]);
1774
1775 if (in_vim9script())
1776 *arg = argp;
1777 else
1778 *arg = skipwhite(argp);
1779 return ret;
1780 }
1781
1782 /*
1783 * Return TRUE if "p" starts with "<SID>" or "s:".
1784 * Only works if eval_fname_script() returned non-zero for "p"!
1785 */
1786 static int
eval_fname_sid(char_u * p)1787 eval_fname_sid(char_u *p)
1788 {
1789 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1790 }
1791
1792 /*
1793 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1794 * Change <SNR>123_name() to K_SNR 123_name().
1795 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1796 * (slow).
1797 */
1798 char_u *
fname_trans_sid(char_u * name,char_u * fname_buf,char_u ** tofree,int * error)1799 fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1800 {
1801 int llen;
1802 char_u *fname;
1803 int i;
1804
1805 llen = eval_fname_script(name);
1806 if (llen > 0)
1807 {
1808 fname_buf[0] = K_SPECIAL;
1809 fname_buf[1] = KS_EXTRA;
1810 fname_buf[2] = (int)KE_SNR;
1811 i = 3;
1812 if (eval_fname_sid(name)) // "<SID>" or "s:"
1813 {
1814 if (current_sctx.sc_sid <= 0)
1815 *error = FCERR_SCRIPT;
1816 else
1817 {
1818 sprintf((char *)fname_buf + 3, "%ld_",
1819 (long)current_sctx.sc_sid);
1820 i = (int)STRLEN(fname_buf);
1821 }
1822 }
1823 if (i + STRLEN(name + llen) < FLEN_FIXED)
1824 {
1825 STRCPY(fname_buf + i, name + llen);
1826 fname = fname_buf;
1827 }
1828 else
1829 {
1830 fname = alloc(i + STRLEN(name + llen) + 1);
1831 if (fname == NULL)
1832 *error = FCERR_OTHER;
1833 else
1834 {
1835 *tofree = fname;
1836 mch_memmove(fname, fname_buf, (size_t)i);
1837 STRCPY(fname + i, name + llen);
1838 }
1839 }
1840 }
1841 else
1842 fname = name;
1843 return fname;
1844 }
1845
1846 /*
1847 * Find a function "name" in script "sid".
1848 */
1849 static ufunc_T *
find_func_with_sid(char_u * name,int sid)1850 find_func_with_sid(char_u *name, int sid)
1851 {
1852 hashitem_T *hi;
1853 char_u buffer[200];
1854
1855 buffer[0] = K_SPECIAL;
1856 buffer[1] = KS_EXTRA;
1857 buffer[2] = (int)KE_SNR;
1858 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s",
1859 (long)sid, name);
1860 hi = hash_find(&func_hashtab, buffer);
1861 if (!HASHITEM_EMPTY(hi))
1862 return HI2UF(hi);
1863
1864 return NULL;
1865 }
1866
1867 /*
1868 * Find a function by name, return pointer to it in ufuncs.
1869 * When "is_global" is true don't find script-local or imported functions.
1870 * Return NULL for unknown function.
1871 */
1872 ufunc_T *
find_func_even_dead(char_u * name,int is_global,cctx_T * cctx)1873 find_func_even_dead(char_u *name, int is_global, cctx_T *cctx)
1874 {
1875 hashitem_T *hi;
1876 ufunc_T *func;
1877 imported_T *imported;
1878
1879 if (!is_global)
1880 {
1881 char_u *after_script = NULL;
1882 long sid = 0;
1883 int find_script_local = in_vim9script()
1884 && eval_isnamec1(*name) && name[1] != ':';
1885
1886 if (find_script_local)
1887 {
1888 // Find script-local function before global one.
1889 func = find_func_with_sid(name, current_sctx.sc_sid);
1890 if (func != NULL)
1891 return func;
1892 }
1893
1894 if (name[0] == K_SPECIAL
1895 && name[1] == KS_EXTRA
1896 && name[2] == KE_SNR)
1897 {
1898 // Caller changes s: to <SNR>99_name.
1899
1900 after_script = name + 3;
1901 sid = getdigits(&after_script);
1902 if (*after_script == '_')
1903 ++after_script;
1904 else
1905 after_script = NULL;
1906 }
1907 if (find_script_local || after_script != NULL)
1908 {
1909 // Find imported function before global one.
1910 if (after_script != NULL && sid != current_sctx.sc_sid)
1911 imported = find_imported_in_script(after_script, 0, sid);
1912 else
1913 imported = find_imported(after_script == NULL
1914 ? name : after_script, 0, cctx);
1915 if (imported != NULL && imported->imp_funcname != NULL)
1916 {
1917 hi = hash_find(&func_hashtab, imported->imp_funcname);
1918 if (!HASHITEM_EMPTY(hi))
1919 return HI2UF(hi);
1920 }
1921 }
1922 }
1923
1924 hi = hash_find(&func_hashtab,
1925 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
1926 if (!HASHITEM_EMPTY(hi))
1927 return HI2UF(hi);
1928
1929 return NULL;
1930 }
1931
1932 /*
1933 * Find a function by name, return pointer to it in ufuncs.
1934 * "cctx" is passed in a :def function to find imported functions.
1935 * Return NULL for unknown or dead function.
1936 */
1937 ufunc_T *
find_func(char_u * name,int is_global,cctx_T * cctx)1938 find_func(char_u *name, int is_global, cctx_T *cctx)
1939 {
1940 ufunc_T *fp = find_func_even_dead(name, is_global, cctx);
1941
1942 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
1943 return fp;
1944 return NULL;
1945 }
1946
1947 /*
1948 * Return TRUE if "ufunc" is a global function.
1949 */
1950 int
func_is_global(ufunc_T * ufunc)1951 func_is_global(ufunc_T *ufunc)
1952 {
1953 return ufunc->uf_name[0] != K_SPECIAL;
1954 }
1955
1956 /*
1957 * Copy the function name of "fp" to buffer "buf".
1958 * "buf" must be able to hold the function name plus three bytes.
1959 * Takes care of script-local function names.
1960 */
1961 static void
cat_func_name(char_u * buf,ufunc_T * fp)1962 cat_func_name(char_u *buf, ufunc_T *fp)
1963 {
1964 if (!func_is_global(fp))
1965 {
1966 STRCPY(buf, "<SNR>");
1967 STRCAT(buf, fp->uf_name + 3);
1968 }
1969 else
1970 STRCPY(buf, fp->uf_name);
1971 }
1972
1973 /*
1974 * Add a number variable "name" to dict "dp" with value "nr".
1975 */
1976 static void
add_nr_var(dict_T * dp,dictitem_T * v,char * name,varnumber_T nr)1977 add_nr_var(
1978 dict_T *dp,
1979 dictitem_T *v,
1980 char *name,
1981 varnumber_T nr)
1982 {
1983 STRCPY(v->di_key, name);
1984 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
1985 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
1986 v->di_tv.v_type = VAR_NUMBER;
1987 v->di_tv.v_lock = VAR_FIXED;
1988 v->di_tv.vval.v_number = nr;
1989 }
1990
1991 /*
1992 * Free "fc".
1993 */
1994 static void
free_funccal(funccall_T * fc)1995 free_funccal(funccall_T *fc)
1996 {
1997 int i;
1998
1999 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2000 {
2001 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
2002
2003 // When garbage collecting a funccall_T may be freed before the
2004 // function that references it, clear its uf_scoped field.
2005 // The function may have been redefined and point to another
2006 // funccall_T, don't clear it then.
2007 if (fp != NULL && fp->uf_scoped == fc)
2008 fp->uf_scoped = NULL;
2009 }
2010 ga_clear(&fc->fc_funcs);
2011
2012 func_ptr_unref(fc->func);
2013 vim_free(fc);
2014 }
2015
2016 /*
2017 * Free "fc" and what it contains.
2018 * Can be called only when "fc" is kept beyond the period of it called,
2019 * i.e. after cleanup_function_call(fc).
2020 */
2021 static void
free_funccal_contents(funccall_T * fc)2022 free_funccal_contents(funccall_T *fc)
2023 {
2024 listitem_T *li;
2025
2026 // Free all l: variables.
2027 vars_clear(&fc->l_vars.dv_hashtab);
2028
2029 // Free all a: variables.
2030 vars_clear(&fc->l_avars.dv_hashtab);
2031
2032 // Free the a:000 variables.
2033 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
2034 clear_tv(&li->li_tv);
2035
2036 free_funccal(fc);
2037 }
2038
2039 /*
2040 * Handle the last part of returning from a function: free the local hashtable.
2041 * Unless it is still in use by a closure.
2042 */
2043 static void
cleanup_function_call(funccall_T * fc)2044 cleanup_function_call(funccall_T *fc)
2045 {
2046 int may_free_fc = fc->fc_refcount <= 0;
2047 int free_fc = TRUE;
2048
2049 current_funccal = fc->caller;
2050
2051 // Free all l: variables if not referred.
2052 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
2053 vars_clear(&fc->l_vars.dv_hashtab);
2054 else
2055 free_fc = FALSE;
2056
2057 // If the a:000 list and the l: and a: dicts are not referenced and
2058 // there is no closure using it, we can free the funccall_T and what's
2059 // in it.
2060 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
2061 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
2062 else
2063 {
2064 int todo;
2065 hashitem_T *hi;
2066 dictitem_T *di;
2067
2068 free_fc = FALSE;
2069
2070 // Make a copy of the a: variables, since we didn't do that above.
2071 todo = (int)fc->l_avars.dv_hashtab.ht_used;
2072 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
2073 {
2074 if (!HASHITEM_EMPTY(hi))
2075 {
2076 --todo;
2077 di = HI2DI(hi);
2078 copy_tv(&di->di_tv, &di->di_tv);
2079 }
2080 }
2081 }
2082
2083 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
2084 fc->l_varlist.lv_first = NULL;
2085 else
2086 {
2087 listitem_T *li;
2088
2089 free_fc = FALSE;
2090
2091 // Make a copy of the a:000 items, since we didn't do that above.
2092 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
2093 copy_tv(&li->li_tv, &li->li_tv);
2094 }
2095
2096 if (free_fc)
2097 free_funccal(fc);
2098 else
2099 {
2100 static int made_copy = 0;
2101
2102 // "fc" is still in use. This can happen when returning "a:000",
2103 // assigning "l:" to a global variable or defining a closure.
2104 // Link "fc" in the list for garbage collection later.
2105 fc->caller = previous_funccal;
2106 previous_funccal = fc;
2107
2108 if (want_garbage_collect)
2109 // If garbage collector is ready, clear count.
2110 made_copy = 0;
2111 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
2112 {
2113 // We have made a lot of copies, worth 4 Mbyte. This can happen
2114 // when repetitively calling a function that creates a reference to
2115 // itself somehow. Call the garbage collector soon to avoid using
2116 // too much memory.
2117 made_copy = 0;
2118 want_garbage_collect = TRUE;
2119 }
2120 }
2121 }
2122
2123 /*
2124 * There are two kinds of function names:
2125 * 1. ordinary names, function defined with :function or :def
2126 * 2. numbered functions and lambdas
2127 * For the first we only count the name stored in func_hashtab as a reference,
2128 * using function() does not count as a reference, because the function is
2129 * looked up by name.
2130 */
2131 int
func_name_refcount(char_u * name)2132 func_name_refcount(char_u *name)
2133 {
2134 return isdigit(*name) || *name == '<';
2135 }
2136
2137 /*
2138 * Unreference "fc": decrement the reference count and free it when it
2139 * becomes zero. "fp" is detached from "fc".
2140 * When "force" is TRUE we are exiting.
2141 */
2142 static void
funccal_unref(funccall_T * fc,ufunc_T * fp,int force)2143 funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
2144 {
2145 funccall_T **pfc;
2146 int i;
2147
2148 if (fc == NULL)
2149 return;
2150
2151 if (--fc->fc_refcount <= 0 && (force || (
2152 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
2153 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
2154 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
2155 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
2156 {
2157 if (fc == *pfc)
2158 {
2159 *pfc = fc->caller;
2160 free_funccal_contents(fc);
2161 return;
2162 }
2163 }
2164 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2165 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
2166 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
2167 }
2168
2169 /*
2170 * Remove the function from the function hashtable. If the function was
2171 * deleted while it still has references this was already done.
2172 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
2173 */
2174 static int
func_remove(ufunc_T * fp)2175 func_remove(ufunc_T *fp)
2176 {
2177 hashitem_T *hi;
2178
2179 // Return if it was already virtually deleted.
2180 if (fp->uf_flags & FC_DEAD)
2181 return FALSE;
2182
2183 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
2184 if (!HASHITEM_EMPTY(hi))
2185 {
2186 // When there is a def-function index do not actually remove the
2187 // function, so we can find the index when defining the function again.
2188 // Do remove it when it's a copy.
2189 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
2190 {
2191 fp->uf_flags |= FC_DEAD;
2192 return FALSE;
2193 }
2194 hash_remove(&func_hashtab, hi);
2195 fp->uf_flags |= FC_DELETED;
2196 return TRUE;
2197 }
2198 return FALSE;
2199 }
2200
2201 static void
func_clear_items(ufunc_T * fp)2202 func_clear_items(ufunc_T *fp)
2203 {
2204 ga_clear_strings(&(fp->uf_args));
2205 ga_clear_strings(&(fp->uf_def_args));
2206 ga_clear_strings(&(fp->uf_lines));
2207 VIM_CLEAR(fp->uf_arg_types);
2208 VIM_CLEAR(fp->uf_block_ids);
2209 VIM_CLEAR(fp->uf_va_name);
2210 clear_type_list(&fp->uf_type_list);
2211
2212 // Increment the refcount of this function to avoid it being freed
2213 // recursively when the partial is freed.
2214 fp->uf_refcount += 3;
2215 partial_unref(fp->uf_partial);
2216 fp->uf_partial = NULL;
2217 fp->uf_refcount -= 3;
2218
2219 #ifdef FEAT_LUA
2220 if (fp->uf_cb_free != NULL)
2221 {
2222 fp->uf_cb_free(fp->uf_cb_state);
2223 fp->uf_cb_free = NULL;
2224 }
2225
2226 fp->uf_cb_state = NULL;
2227 fp->uf_cb = NULL;
2228 #endif
2229 #ifdef FEAT_PROFILE
2230 VIM_CLEAR(fp->uf_tml_count);
2231 VIM_CLEAR(fp->uf_tml_total);
2232 VIM_CLEAR(fp->uf_tml_self);
2233 #endif
2234 }
2235
2236 /*
2237 * Free all things that a function contains. Does not free the function
2238 * itself, use func_free() for that.
2239 * When "force" is TRUE we are exiting.
2240 */
2241 static void
func_clear(ufunc_T * fp,int force)2242 func_clear(ufunc_T *fp, int force)
2243 {
2244 if (fp->uf_cleared)
2245 return;
2246 fp->uf_cleared = TRUE;
2247
2248 // clear this function
2249 func_clear_items(fp);
2250 funccal_unref(fp->uf_scoped, fp, force);
2251 unlink_def_function(fp);
2252 }
2253
2254 /*
2255 * Free a function and remove it from the list of functions. Does not free
2256 * what a function contains, call func_clear() first.
2257 * When "force" is TRUE we are exiting.
2258 * Returns OK when the function was actually freed.
2259 */
2260 static int
func_free(ufunc_T * fp,int force)2261 func_free(ufunc_T *fp, int force)
2262 {
2263 // Only remove it when not done already, otherwise we would remove a newer
2264 // version of the function with the same name.
2265 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2266 func_remove(fp);
2267
2268 if ((fp->uf_flags & FC_DEAD) == 0 || force)
2269 {
2270 if (fp->uf_dfunc_idx > 0)
2271 unlink_def_function(fp);
2272 VIM_CLEAR(fp->uf_name_exp);
2273 vim_free(fp);
2274 return OK;
2275 }
2276 return FAIL;
2277 }
2278
2279 /*
2280 * Free all things that a function contains and free the function itself.
2281 * When "force" is TRUE we are exiting.
2282 */
2283 static void
func_clear_free(ufunc_T * fp,int force)2284 func_clear_free(ufunc_T *fp, int force)
2285 {
2286 func_clear(fp, force);
2287 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2288 || (fp->uf_flags & FC_COPY))
2289 func_free(fp, force);
2290 else
2291 fp->uf_flags |= FC_DEAD;
2292 }
2293
2294 /*
2295 * Copy already defined function "lambda" to a new function with name "global".
2296 * This is for when a compiled function defines a global function.
2297 */
2298 int
copy_func(char_u * lambda,char_u * global,ectx_T * ectx)2299 copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
2300 {
2301 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL);
2302 ufunc_T *fp = NULL;
2303
2304 if (ufunc == NULL)
2305 {
2306 semsg(_(e_lambda_function_not_found_str), lambda);
2307 return FAIL;
2308 }
2309
2310 fp = find_func(global, TRUE, NULL);
2311 if (fp != NULL)
2312 {
2313 // TODO: handle ! to overwrite
2314 semsg(_(e_funcexts), global);
2315 return FAIL;
2316 }
2317
2318 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2319 if (fp == NULL)
2320 return FAIL;
2321
2322 fp->uf_varargs = ufunc->uf_varargs;
2323 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2324 fp->uf_def_status = ufunc->uf_def_status;
2325 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2326 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2327 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2328 == FAIL
2329 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2330 goto failed;
2331
2332 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2333 : vim_strsave(ufunc->uf_name_exp);
2334 if (ufunc->uf_arg_types != NULL)
2335 {
2336 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2337 if (fp->uf_arg_types == NULL)
2338 goto failed;
2339 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2340 sizeof(type_T *) * fp->uf_args.ga_len);
2341 }
2342 if (ufunc->uf_va_name != NULL)
2343 {
2344 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2345 if (fp->uf_va_name == NULL)
2346 goto failed;
2347 }
2348 fp->uf_ret_type = ufunc->uf_ret_type;
2349
2350 fp->uf_refcount = 1;
2351 STRCPY(fp->uf_name, global);
2352 hash_add(&func_hashtab, UF2HIKEY(fp));
2353
2354 // the referenced dfunc_T is now used one more time
2355 link_def_function(fp);
2356
2357 // Create a partial to store the context of the function where it was
2358 // instantiated. Only needs to be done once. Do this on the original
2359 // function, "dfunc->df_ufunc" will point to it.
2360 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2361 {
2362 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2363
2364 if (pt == NULL)
2365 goto failed;
2366 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
2367 {
2368 vim_free(pt);
2369 goto failed;
2370 }
2371 ufunc->uf_partial = pt;
2372 --pt->pt_refcount; // not actually referenced here
2373 }
2374
2375 return OK;
2376
2377 failed:
2378 func_clear_free(fp, TRUE);
2379 return FAIL;
2380 }
2381
2382 static int funcdepth = 0;
2383
2384 /*
2385 * Increment the function call depth count.
2386 * Return FAIL when going over 'maxfuncdepth'.
2387 * Otherwise return OK, must call funcdepth_decrement() later!
2388 */
2389 int
funcdepth_increment(void)2390 funcdepth_increment(void)
2391 {
2392 if (funcdepth >= p_mfd)
2393 {
2394 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'"));
2395 return FAIL;
2396 }
2397 ++funcdepth;
2398 return OK;
2399 }
2400
2401 void
funcdepth_decrement(void)2402 funcdepth_decrement(void)
2403 {
2404 --funcdepth;
2405 }
2406
2407 /*
2408 * Get the current function call depth.
2409 */
2410 int
funcdepth_get(void)2411 funcdepth_get(void)
2412 {
2413 return funcdepth;
2414 }
2415
2416 /*
2417 * Restore the function call depth. This is for cases where there is no
2418 * guarantee funcdepth_decrement() can be called exactly the same number of
2419 * times as funcdepth_increment().
2420 */
2421 void
funcdepth_restore(int depth)2422 funcdepth_restore(int depth)
2423 {
2424 funcdepth = depth;
2425 }
2426
2427 /*
2428 * Call a user function.
2429 */
2430 static void
call_user_func(ufunc_T * fp,int argcount,typval_T * argvars,typval_T * rettv,funcexe_T * funcexe,dict_T * selfdict)2431 call_user_func(
2432 ufunc_T *fp, // pointer to function
2433 int argcount, // nr of args
2434 typval_T *argvars, // arguments
2435 typval_T *rettv, // return value
2436 funcexe_T *funcexe, // context
2437 dict_T *selfdict) // Dictionary for "self"
2438 {
2439 sctx_T save_current_sctx;
2440 int using_sandbox = FALSE;
2441 funccall_T *fc;
2442 int save_did_emsg;
2443 int default_arg_err = FALSE;
2444 dictitem_T *v;
2445 int fixvar_idx = 0; // index in fixvar[]
2446 int i;
2447 int ai;
2448 int islambda = FALSE;
2449 char_u numbuf[NUMBUFLEN];
2450 char_u *name;
2451 typval_T *tv_to_free[MAX_FUNC_ARGS];
2452 int tv_to_free_len = 0;
2453 #ifdef FEAT_PROFILE
2454 profinfo_T profile_info;
2455 #endif
2456 ESTACK_CHECK_DECLARATION
2457
2458 #ifdef FEAT_PROFILE
2459 CLEAR_FIELD(profile_info);
2460 #endif
2461
2462 // If depth of calling is getting too high, don't execute the function.
2463 if (funcdepth_increment() == FAIL)
2464 {
2465 rettv->v_type = VAR_NUMBER;
2466 rettv->vval.v_number = -1;
2467 return;
2468 }
2469
2470 line_breakcheck(); // check for CTRL-C hit
2471
2472 fc = ALLOC_CLEAR_ONE(funccall_T);
2473 if (fc == NULL)
2474 return;
2475 fc->caller = current_funccal;
2476 current_funccal = fc;
2477 fc->func = fp;
2478 fc->rettv = rettv;
2479 fc->level = ex_nesting_level;
2480 // Check if this function has a breakpoint.
2481 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2482 fc->dbg_tick = debug_tick;
2483 // Set up fields for closure.
2484 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
2485 func_ptr_ref(fp);
2486
2487 if (fp->uf_def_status != UF_NOT_COMPILED)
2488 {
2489 #ifdef FEAT_PROFILE
2490 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2491 #endif
2492 // Execute the function, possibly compiling it first.
2493 #ifdef FEAT_PROFILE
2494 if (do_profiling == PROF_YES)
2495 profile_may_start_func(&profile_info, fp, caller);
2496 #endif
2497 call_def_function(fp, argcount, argvars, funcexe->partial, rettv);
2498 funcdepth_decrement();
2499 #ifdef FEAT_PROFILE
2500 if (do_profiling == PROF_YES && (fp->uf_profiling
2501 || (caller != NULL && caller->uf_profiling)))
2502 profile_may_end_func(&profile_info, fp, caller);
2503 #endif
2504 current_funccal = fc->caller;
2505 free_funccal(fc);
2506 return;
2507 }
2508
2509 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
2510 islambda = TRUE;
2511
2512 /*
2513 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2514 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2515 * each argument variable and saves a lot of time.
2516 */
2517 /*
2518 * Init l: variables.
2519 */
2520 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2521 if (selfdict != NULL)
2522 {
2523 // Set l:self to "selfdict". Use "name" to avoid a warning from
2524 // some compiler that checks the destination size.
2525 v = &fc->fixvar[fixvar_idx++].var;
2526 name = v->di_key;
2527 STRCPY(name, "self");
2528 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2529 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2530 v->di_tv.v_type = VAR_DICT;
2531 v->di_tv.v_lock = 0;
2532 v->di_tv.vval.v_dict = selfdict;
2533 ++selfdict->dv_refcount;
2534 }
2535
2536 /*
2537 * Init a: variables, unless none found (in lambda).
2538 * Set a:0 to "argcount" less number of named arguments, if >= 0.
2539 * Set a:000 to a list with room for the "..." arguments.
2540 */
2541 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
2542 if ((fp->uf_flags & FC_NOARGS) == 0)
2543 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
2544 (varnumber_T)(argcount >= fp->uf_args.ga_len
2545 ? argcount - fp->uf_args.ga_len : 0));
2546 fc->l_avars.dv_lock = VAR_FIXED;
2547 if ((fp->uf_flags & FC_NOARGS) == 0)
2548 {
2549 // Use "name" to avoid a warning from some compiler that checks the
2550 // destination size.
2551 v = &fc->fixvar[fixvar_idx++].var;
2552 name = v->di_key;
2553 STRCPY(name, "000");
2554 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2555 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2556 v->di_tv.v_type = VAR_LIST;
2557 v->di_tv.v_lock = VAR_FIXED;
2558 v->di_tv.vval.v_list = &fc->l_varlist;
2559 }
2560 CLEAR_FIELD(fc->l_varlist);
2561 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2562 fc->l_varlist.lv_lock = VAR_FIXED;
2563
2564 /*
2565 * Set a:firstline to "firstline" and a:lastline to "lastline".
2566 * Set a:name to named arguments.
2567 * Set a:N to the "..." arguments.
2568 * Skipped when no a: variables used (in lambda).
2569 */
2570 if ((fp->uf_flags & FC_NOARGS) == 0)
2571 {
2572 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
2573 (varnumber_T)funcexe->firstline);
2574 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
2575 (varnumber_T)funcexe->lastline);
2576 }
2577 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
2578 {
2579 int addlocal = FALSE;
2580 typval_T def_rettv;
2581 int isdefault = FALSE;
2582
2583 ai = i - fp->uf_args.ga_len;
2584 if (ai < 0)
2585 {
2586 // named argument a:name
2587 name = FUNCARG(fp, i);
2588 if (islambda)
2589 addlocal = TRUE;
2590
2591 // evaluate named argument default expression
2592 isdefault = ai + fp->uf_def_args.ga_len >= 0
2593 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2594 && argvars[i].vval.v_number == VVAL_NONE));
2595 if (isdefault)
2596 {
2597 char_u *default_expr = NULL;
2598
2599 def_rettv.v_type = VAR_NUMBER;
2600 def_rettv.vval.v_number = -1;
2601
2602 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2603 [ai + fp->uf_def_args.ga_len];
2604 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
2605 {
2606 default_arg_err = 1;
2607 break;
2608 }
2609 }
2610 }
2611 else
2612 {
2613 if ((fp->uf_flags & FC_NOARGS) != 0)
2614 // Bail out if no a: arguments used (in lambda).
2615 break;
2616
2617 // "..." argument a:1, a:2, etc.
2618 sprintf((char *)numbuf, "%d", ai + 1);
2619 name = numbuf;
2620 }
2621 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2622 {
2623 v = &fc->fixvar[fixvar_idx++].var;
2624 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2625 STRCPY(v->di_key, name);
2626 }
2627 else
2628 {
2629 v = dictitem_alloc(name);
2630 if (v == NULL)
2631 break;
2632 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
2633 }
2634
2635 // Note: the values are copied directly to avoid alloc/free.
2636 // "argvars" must have VAR_FIXED for v_lock.
2637 v->di_tv = isdefault ? def_rettv : argvars[i];
2638 v->di_tv.v_lock = VAR_FIXED;
2639
2640 if (isdefault)
2641 // Need to free this later, no matter where it's stored.
2642 tv_to_free[tv_to_free_len++] = &v->di_tv;
2643
2644 if (addlocal)
2645 {
2646 // Named arguments should be accessed without the "a:" prefix in
2647 // lambda expressions. Add to the l: dict.
2648 copy_tv(&v->di_tv, &v->di_tv);
2649 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2650 }
2651 else
2652 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2653
2654 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2655 {
2656 listitem_T *li = &fc->l_listitems[ai];
2657
2658 li->li_tv = argvars[i];
2659 li->li_tv.v_lock = VAR_FIXED;
2660 list_append(&fc->l_varlist, li);
2661 }
2662 }
2663
2664 // Don't redraw while executing the function.
2665 ++RedrawingDisabled;
2666
2667 if (fp->uf_flags & FC_SANDBOX)
2668 {
2669 using_sandbox = TRUE;
2670 ++sandbox;
2671 }
2672
2673 estack_push_ufunc(fp, 1);
2674 ESTACK_CHECK_SETUP
2675 if (p_verbose >= 12)
2676 {
2677 ++no_wait_return;
2678 verbose_enter_scroll();
2679
2680 smsg(_("calling %s"), SOURCING_NAME);
2681 if (p_verbose >= 14)
2682 {
2683 char_u buf[MSG_BUF_LEN];
2684 char_u numbuf2[NUMBUFLEN];
2685 char_u *tofree;
2686 char_u *s;
2687
2688 msg_puts("(");
2689 for (i = 0; i < argcount; ++i)
2690 {
2691 if (i > 0)
2692 msg_puts(", ");
2693 if (argvars[i].v_type == VAR_NUMBER)
2694 msg_outnum((long)argvars[i].vval.v_number);
2695 else
2696 {
2697 // Do not want errors such as E724 here.
2698 ++emsg_off;
2699 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2700 --emsg_off;
2701 if (s != NULL)
2702 {
2703 if (vim_strsize(s) > MSG_BUF_CLEN)
2704 {
2705 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2706 s = buf;
2707 }
2708 msg_puts((char *)s);
2709 vim_free(tofree);
2710 }
2711 }
2712 }
2713 msg_puts(")");
2714 }
2715 msg_puts("\n"); // don't overwrite this either
2716
2717 verbose_leave_scroll();
2718 --no_wait_return;
2719 }
2720 #ifdef FEAT_PROFILE
2721 if (do_profiling == PROF_YES)
2722 profile_may_start_func(&profile_info, fp,
2723 fc->caller == NULL ? NULL : fc->caller->func);
2724 #endif
2725
2726 save_current_sctx = current_sctx;
2727 current_sctx = fp->uf_script_ctx;
2728 save_did_emsg = did_emsg;
2729 did_emsg = FALSE;
2730
2731 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2732 did_emsg = TRUE;
2733 else if (islambda)
2734 {
2735 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2736
2737 // A Lambda always has the command "return {expr}". It is much faster
2738 // to evaluate {expr} directly.
2739 ++ex_nesting_level;
2740 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
2741 --ex_nesting_level;
2742 }
2743 else
2744 // call do_cmdline() to execute the lines
2745 do_cmdline(NULL, get_func_line, (void *)fc,
2746 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2747
2748 --RedrawingDisabled;
2749
2750 // when the function was aborted because of an error, return -1
2751 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2752 {
2753 clear_tv(rettv);
2754 rettv->v_type = VAR_NUMBER;
2755 rettv->vval.v_number = -1;
2756 }
2757
2758 #ifdef FEAT_PROFILE
2759 if (do_profiling == PROF_YES)
2760 {
2761 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2762
2763 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2764 profile_may_end_func(&profile_info, fp, caller);
2765 }
2766 #endif
2767
2768 // when being verbose, mention the return value
2769 if (p_verbose >= 12)
2770 {
2771 ++no_wait_return;
2772 verbose_enter_scroll();
2773
2774 if (aborting())
2775 smsg(_("%s aborted"), SOURCING_NAME);
2776 else if (fc->rettv->v_type == VAR_NUMBER)
2777 smsg(_("%s returning #%ld"), SOURCING_NAME,
2778 (long)fc->rettv->vval.v_number);
2779 else
2780 {
2781 char_u buf[MSG_BUF_LEN];
2782 char_u numbuf2[NUMBUFLEN];
2783 char_u *tofree;
2784 char_u *s;
2785
2786 // The value may be very long. Skip the middle part, so that we
2787 // have some idea how it starts and ends. smsg() would always
2788 // truncate it at the end. Don't want errors such as E724 here.
2789 ++emsg_off;
2790 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2791 --emsg_off;
2792 if (s != NULL)
2793 {
2794 if (vim_strsize(s) > MSG_BUF_CLEN)
2795 {
2796 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2797 s = buf;
2798 }
2799 smsg(_("%s returning %s"), SOURCING_NAME, s);
2800 vim_free(tofree);
2801 }
2802 }
2803 msg_puts("\n"); // don't overwrite this either
2804
2805 verbose_leave_scroll();
2806 --no_wait_return;
2807 }
2808
2809 ESTACK_CHECK_NOW
2810 estack_pop();
2811 current_sctx = save_current_sctx;
2812 #ifdef FEAT_PROFILE
2813 if (do_profiling == PROF_YES)
2814 script_prof_restore(&profile_info.pi_wait_start);
2815 #endif
2816 if (using_sandbox)
2817 --sandbox;
2818
2819 if (p_verbose >= 12 && SOURCING_NAME != NULL)
2820 {
2821 ++no_wait_return;
2822 verbose_enter_scroll();
2823
2824 smsg(_("continuing in %s"), SOURCING_NAME);
2825 msg_puts("\n"); // don't overwrite this either
2826
2827 verbose_leave_scroll();
2828 --no_wait_return;
2829 }
2830
2831 did_emsg |= save_did_emsg;
2832 funcdepth_decrement();
2833 for (i = 0; i < tv_to_free_len; ++i)
2834 clear_tv(tv_to_free[i]);
2835 cleanup_function_call(fc);
2836 }
2837
2838 /*
2839 * Check the argument count for user function "fp".
2840 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2841 */
2842 int
check_user_func_argcount(ufunc_T * fp,int argcount)2843 check_user_func_argcount(ufunc_T *fp, int argcount)
2844 {
2845 int regular_args = fp->uf_args.ga_len;
2846
2847 if (argcount < regular_args - fp->uf_def_args.ga_len)
2848 return FCERR_TOOFEW;
2849 else if (!has_varargs(fp) && argcount > regular_args)
2850 return FCERR_TOOMANY;
2851 return FCERR_UNKNOWN;
2852 }
2853
2854 /*
2855 * Call a user function after checking the arguments.
2856 */
2857 int
call_user_func_check(ufunc_T * fp,int argcount,typval_T * argvars,typval_T * rettv,funcexe_T * funcexe,dict_T * selfdict)2858 call_user_func_check(
2859 ufunc_T *fp,
2860 int argcount,
2861 typval_T *argvars,
2862 typval_T *rettv,
2863 funcexe_T *funcexe,
2864 dict_T *selfdict)
2865 {
2866 int error;
2867
2868 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL)
2869 *funcexe->doesrange = TRUE;
2870 error = check_user_func_argcount(fp, argcount);
2871 if (error != FCERR_UNKNOWN)
2872 return error;
2873 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
2874 error = FCERR_DICT;
2875 else
2876 {
2877 int did_save_redo = FALSE;
2878 save_redo_T save_redo;
2879
2880 /*
2881 * Call the user function.
2882 * Save and restore search patterns, script variables and
2883 * redo buffer.
2884 */
2885 save_search_patterns();
2886 if (!ins_compl_active())
2887 {
2888 saveRedobuff(&save_redo);
2889 did_save_redo = TRUE;
2890 }
2891 ++fp->uf_calls;
2892 call_user_func(fp, argcount, argvars, rettv, funcexe,
2893 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
2894 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
2895 // Function was unreferenced while being used, free it now.
2896 func_clear_free(fp, FALSE);
2897 if (did_save_redo)
2898 restoreRedobuff(&save_redo);
2899 restore_search_patterns();
2900 error = FCERR_NONE;
2901 }
2902 return error;
2903 }
2904
2905 static funccal_entry_T *funccal_stack = NULL;
2906
2907 /*
2908 * Save the current function call pointer, and set it to NULL.
2909 * Used when executing autocommands and for ":source".
2910 */
2911 void
save_funccal(funccal_entry_T * entry)2912 save_funccal(funccal_entry_T *entry)
2913 {
2914 entry->top_funccal = current_funccal;
2915 entry->next = funccal_stack;
2916 funccal_stack = entry;
2917 current_funccal = NULL;
2918 }
2919
2920 void
restore_funccal(void)2921 restore_funccal(void)
2922 {
2923 if (funccal_stack == NULL)
2924 iemsg("INTERNAL: restore_funccal()");
2925 else
2926 {
2927 current_funccal = funccal_stack->top_funccal;
2928 funccal_stack = funccal_stack->next;
2929 }
2930 }
2931
2932 funccall_T *
get_current_funccal(void)2933 get_current_funccal(void)
2934 {
2935 return current_funccal;
2936 }
2937
2938 /*
2939 * Mark all functions of script "sid" as deleted.
2940 */
2941 void
delete_script_functions(int sid)2942 delete_script_functions(int sid)
2943 {
2944 hashitem_T *hi;
2945 ufunc_T *fp;
2946 long_u todo = 1;
2947 char_u buf[30];
2948 size_t len;
2949
2950 buf[0] = K_SPECIAL;
2951 buf[1] = KS_EXTRA;
2952 buf[2] = (int)KE_SNR;
2953 sprintf((char *)buf + 3, "%d_", sid);
2954 len = STRLEN(buf);
2955
2956 while (todo > 0)
2957 {
2958 todo = func_hashtab.ht_used;
2959 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
2960 if (!HASHITEM_EMPTY(hi))
2961 {
2962 fp = HI2UF(hi);
2963 if (STRNCMP(fp->uf_name, buf, len) == 0)
2964 {
2965 int changed = func_hashtab.ht_changed;
2966
2967 fp->uf_flags |= FC_DEAD;
2968
2969 if (fp->uf_calls > 0)
2970 {
2971 // Function is executing, don't free it but do remove
2972 // it from the hashtable.
2973 if (func_remove(fp))
2974 fp->uf_refcount--;
2975 }
2976 else
2977 {
2978 func_clear(fp, TRUE);
2979 // When clearing a function another function can be
2980 // cleared as a side effect. When that happens start
2981 // over.
2982 if (changed != func_hashtab.ht_changed)
2983 break;
2984 }
2985 }
2986 --todo;
2987 }
2988 }
2989 }
2990
2991 #if defined(EXITFREE) || defined(PROTO)
2992 void
free_all_functions(void)2993 free_all_functions(void)
2994 {
2995 hashitem_T *hi;
2996 ufunc_T *fp;
2997 long_u skipped = 0;
2998 long_u todo = 1;
2999 int changed;
3000
3001 // Clean up the current_funccal chain and the funccal stack.
3002 while (current_funccal != NULL)
3003 {
3004 clear_tv(current_funccal->rettv);
3005 cleanup_function_call(current_funccal);
3006 if (current_funccal == NULL && funccal_stack != NULL)
3007 restore_funccal();
3008 }
3009
3010 // First clear what the functions contain. Since this may lower the
3011 // reference count of a function, it may also free a function and change
3012 // the hash table. Restart if that happens.
3013 while (todo > 0)
3014 {
3015 todo = func_hashtab.ht_used;
3016 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3017 if (!HASHITEM_EMPTY(hi))
3018 {
3019 // clear the def function index now
3020 fp = HI2UF(hi);
3021 fp->uf_flags &= ~FC_DEAD;
3022 fp->uf_def_status = UF_NOT_COMPILED;
3023
3024 // Only free functions that are not refcounted, those are
3025 // supposed to be freed when no longer referenced.
3026 if (func_name_refcount(fp->uf_name))
3027 ++skipped;
3028 else
3029 {
3030 changed = func_hashtab.ht_changed;
3031 func_clear(fp, TRUE);
3032 if (changed != func_hashtab.ht_changed)
3033 {
3034 skipped = 0;
3035 break;
3036 }
3037 }
3038 --todo;
3039 }
3040 }
3041
3042 // Now actually free the functions. Need to start all over every time,
3043 // because func_free() may change the hash table.
3044 skipped = 0;
3045 while (func_hashtab.ht_used > skipped)
3046 {
3047 todo = func_hashtab.ht_used;
3048 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3049 if (!HASHITEM_EMPTY(hi))
3050 {
3051 --todo;
3052 // Only free functions that are not refcounted, those are
3053 // supposed to be freed when no longer referenced.
3054 fp = HI2UF(hi);
3055 if (func_name_refcount(fp->uf_name))
3056 ++skipped;
3057 else
3058 {
3059 if (func_free(fp, FALSE) == OK)
3060 {
3061 skipped = 0;
3062 break;
3063 }
3064 // did not actually free it
3065 ++skipped;
3066 }
3067 }
3068 }
3069 if (skipped == 0)
3070 hash_clear(&func_hashtab);
3071
3072 free_def_functions();
3073 }
3074 #endif
3075
3076 /*
3077 * Return TRUE if "name" looks like a builtin function name: starts with a
3078 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'.
3079 * "len" is the length of "name", or -1 for NUL terminated.
3080 */
3081 int
builtin_function(char_u * name,int len)3082 builtin_function(char_u *name, int len)
3083 {
3084 char_u *p;
3085
3086 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
3087 return FALSE;
3088 p = vim_strchr(name, AUTOLOAD_CHAR);
3089 return p == NULL || (len > 0 && p > name + len);
3090 }
3091
3092 int
func_call(char_u * name,typval_T * args,partial_T * partial,dict_T * selfdict,typval_T * rettv)3093 func_call(
3094 char_u *name,
3095 typval_T *args,
3096 partial_T *partial,
3097 dict_T *selfdict,
3098 typval_T *rettv)
3099 {
3100 list_T *l = args->vval.v_list;
3101 listitem_T *item;
3102 typval_T argv[MAX_FUNC_ARGS + 1];
3103 int argc = 0;
3104 int r = 0;
3105
3106 CHECK_LIST_MATERIALIZE(l);
3107 FOR_ALL_LIST_ITEMS(l, item)
3108 {
3109 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
3110 {
3111 emsg(_("E699: Too many arguments"));
3112 break;
3113 }
3114 // Make a copy of each argument. This is needed to be able to set
3115 // v_lock to VAR_FIXED in the copy without changing the original list.
3116 copy_tv(&item->li_tv, &argv[argc++]);
3117 }
3118
3119 if (item == NULL)
3120 {
3121 funcexe_T funcexe;
3122
3123 CLEAR_FIELD(funcexe);
3124 funcexe.firstline = curwin->w_cursor.lnum;
3125 funcexe.lastline = curwin->w_cursor.lnum;
3126 funcexe.evaluate = TRUE;
3127 funcexe.partial = partial;
3128 funcexe.selfdict = selfdict;
3129 r = call_func(name, -1, rettv, argc, argv, &funcexe);
3130 }
3131
3132 // Free the arguments.
3133 while (argc > 0)
3134 clear_tv(&argv[--argc]);
3135
3136 return r;
3137 }
3138
3139 static int callback_depth = 0;
3140
3141 int
get_callback_depth(void)3142 get_callback_depth(void)
3143 {
3144 return callback_depth;
3145 }
3146
3147 /*
3148 * Invoke call_func() with a callback.
3149 */
3150 int
call_callback(callback_T * callback,int len,typval_T * rettv,int argcount,typval_T * argvars)3151 call_callback(
3152 callback_T *callback,
3153 int len, // length of "name" or -1 to use strlen()
3154 typval_T *rettv, // return value goes here
3155 int argcount, // number of "argvars"
3156 typval_T *argvars) // vars for arguments, must have "argcount"
3157 // PLUS ONE elements!
3158 {
3159 funcexe_T funcexe;
3160 int ret;
3161
3162 CLEAR_FIELD(funcexe);
3163 funcexe.evaluate = TRUE;
3164 funcexe.partial = callback->cb_partial;
3165 ++callback_depth;
3166 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
3167 --callback_depth;
3168 return ret;
3169 }
3170
3171 /*
3172 * Give an error message for the result of a function.
3173 * Nothing if "error" is FCERR_NONE.
3174 */
3175 void
user_func_error(int error,char_u * name)3176 user_func_error(int error, char_u *name)
3177 {
3178 switch (error)
3179 {
3180 case FCERR_UNKNOWN:
3181 emsg_funcname(e_unknownfunc, name);
3182 break;
3183 case FCERR_NOTMETHOD:
3184 emsg_funcname(
3185 N_("E276: Cannot use function as a method: %s"), name);
3186 break;
3187 case FCERR_DELETED:
3188 emsg_funcname(N_(e_func_deleted), name);
3189 break;
3190 case FCERR_TOOMANY:
3191 emsg_funcname((char *)e_toomanyarg, name);
3192 break;
3193 case FCERR_TOOFEW:
3194 emsg_funcname((char *)e_toofewarg, name);
3195 break;
3196 case FCERR_SCRIPT:
3197 emsg_funcname(
3198 N_("E120: Using <SID> not in a script context: %s"), name);
3199 break;
3200 case FCERR_DICT:
3201 emsg_funcname(
3202 N_("E725: Calling dict function without Dictionary: %s"),
3203 name);
3204 break;
3205 }
3206 }
3207
3208 /*
3209 * Call a function with its resolved parameters
3210 *
3211 * Return FAIL when the function can't be called, OK otherwise.
3212 * Also returns OK when an error was encountered while executing the function.
3213 */
3214 int
call_func(char_u * funcname,int len,typval_T * rettv,int argcount_in,typval_T * argvars_in,funcexe_T * funcexe)3215 call_func(
3216 char_u *funcname, // name of the function
3217 int len, // length of "name" or -1 to use strlen()
3218 typval_T *rettv, // return value goes here
3219 int argcount_in, // number of "argvars"
3220 typval_T *argvars_in, // vars for arguments, must have "argcount"
3221 // PLUS ONE elements!
3222 funcexe_T *funcexe) // more arguments
3223 {
3224 int ret = FAIL;
3225 int error = FCERR_NONE;
3226 int i;
3227 ufunc_T *fp = NULL;
3228 char_u fname_buf[FLEN_FIXED + 1];
3229 char_u *tofree = NULL;
3230 char_u *fname = NULL;
3231 char_u *name = NULL;
3232 int argcount = argcount_in;
3233 typval_T *argvars = argvars_in;
3234 dict_T *selfdict = funcexe->selfdict;
3235 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
3236 // "funcexe->basetv" is not NULL
3237 int argv_clear = 0;
3238 int argv_base = 0;
3239 partial_T *partial = funcexe->partial;
3240 type_T check_type;
3241
3242 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
3243 // even when call_func() returns FAIL.
3244 rettv->v_type = VAR_UNKNOWN;
3245
3246 if (partial != NULL)
3247 fp = partial->pt_func;
3248 if (fp == NULL)
3249 {
3250 // Make a copy of the name, if it comes from a funcref variable it
3251 // could be changed or deleted in the called function.
3252 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
3253 if (name == NULL)
3254 return ret;
3255
3256 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3257 }
3258
3259 if (funcexe->doesrange != NULL)
3260 *funcexe->doesrange = FALSE;
3261
3262 if (partial != NULL)
3263 {
3264 // When the function has a partial with a dict and there is a dict
3265 // argument, use the dict argument. That is backwards compatible.
3266 // When the dict was bound explicitly use the one from the partial.
3267 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
3268 selfdict = partial->pt_dict;
3269 if (error == FCERR_NONE && partial->pt_argc > 0)
3270 {
3271 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
3272 {
3273 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3274 {
3275 error = FCERR_TOOMANY;
3276 goto theend;
3277 }
3278 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
3279 }
3280 for (i = 0; i < argcount_in; ++i)
3281 argv[i + argv_clear] = argvars_in[i];
3282 argvars = argv;
3283 argcount = partial->pt_argc + argcount_in;
3284
3285 if (funcexe->check_type != NULL
3286 && funcexe->check_type->tt_argcount != -1)
3287 {
3288 // Now funcexe->check_type is missing the added arguments, make
3289 // a copy of the type with the correction.
3290 check_type = *funcexe->check_type;
3291 funcexe->check_type = &check_type;
3292 check_type.tt_argcount += partial->pt_argc;
3293 check_type.tt_min_argcount += partial->pt_argc;
3294 }
3295 }
3296 }
3297
3298 if (error == FCERR_NONE && funcexe->check_type != NULL && funcexe->evaluate)
3299 {
3300 // Check that the argument types are OK for the types of the funcref.
3301 if (check_argument_types(funcexe->check_type, argvars, argcount,
3302 (name != NULL) ? name : funcname) == FAIL)
3303 error = FCERR_OTHER;
3304 }
3305
3306 if (error == FCERR_NONE && funcexe->evaluate)
3307 {
3308 char_u *rfname = fname;
3309 int is_global = FALSE;
3310
3311 // Skip "g:" before a function name.
3312 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
3313 {
3314 is_global = TRUE;
3315 rfname = fname + 2;
3316 }
3317
3318 rettv->v_type = VAR_NUMBER; // default rettv is number zero
3319 rettv->vval.v_number = 0;
3320 error = FCERR_UNKNOWN;
3321
3322 if (fp != NULL || !builtin_function(rfname, -1))
3323 {
3324 /*
3325 * User defined function.
3326 */
3327 if (fp == NULL)
3328 fp = find_func(rfname, is_global, NULL);
3329
3330 // Trigger FuncUndefined event, may load the function.
3331 if (fp == NULL
3332 && apply_autocmds(EVENT_FUNCUNDEFINED,
3333 rfname, rfname, TRUE, NULL)
3334 && !aborting())
3335 {
3336 // executed an autocommand, search for the function again
3337 fp = find_func(rfname, is_global, NULL);
3338 }
3339 // Try loading a package.
3340 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3341 {
3342 // loaded a package, search for the function again
3343 fp = find_func(rfname, is_global, NULL);
3344 }
3345 if (fp == NULL)
3346 {
3347 char_u *p = untrans_function_name(rfname);
3348
3349 // If using Vim9 script try not local to the script.
3350 // Don't do this if the name starts with "s:".
3351 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
3352 fp = find_func(p, is_global, NULL);
3353 }
3354
3355 if (fp != NULL && (fp->uf_flags & FC_DELETED))
3356 error = FCERR_DELETED;
3357 #ifdef FEAT_LUA
3358 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
3359 {
3360 cfunc_T cb = fp->uf_cb;
3361
3362 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3363 }
3364 #endif
3365 else if (fp != NULL)
3366 {
3367 if (funcexe->argv_func != NULL)
3368 // postponed filling in the arguments, do it now
3369 argcount = funcexe->argv_func(argcount, argvars, argv_clear,
3370 fp->uf_args.ga_len);
3371
3372 if (funcexe->basetv != NULL)
3373 {
3374 // Method call: base->Method()
3375 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
3376 argv[0] = *funcexe->basetv;
3377 argcount++;
3378 argvars = argv;
3379 argv_base = 1;
3380 }
3381
3382 error = call_user_func_check(fp, argcount, argvars, rettv,
3383 funcexe, selfdict);
3384 }
3385 }
3386 else if (funcexe->basetv != NULL)
3387 {
3388 /*
3389 * expr->method(): Find the method name in the table, call its
3390 * implementation with the base as one of the arguments.
3391 */
3392 error = call_internal_method(fname, argcount, argvars, rettv,
3393 funcexe->basetv);
3394 }
3395 else
3396 {
3397 /*
3398 * Find the function name in the table, call its implementation.
3399 */
3400 error = call_internal_func(fname, argcount, argvars, rettv);
3401 }
3402
3403 /*
3404 * The function call (or "FuncUndefined" autocommand sequence) might
3405 * have been aborted by an error, an interrupt, or an explicitly thrown
3406 * exception that has not been caught so far. This situation can be
3407 * tested for by calling aborting(). For an error in an internal
3408 * function or for the "E132" error in call_user_func(), however, the
3409 * throw point at which the "force_abort" flag (temporarily reset by
3410 * emsg()) is normally updated has not been reached yet. We need to
3411 * update that flag first to make aborting() reliable.
3412 */
3413 update_force_abort();
3414 }
3415 if (error == FCERR_NONE)
3416 ret = OK;
3417
3418 theend:
3419 /*
3420 * Report an error unless the argument evaluation or function call has been
3421 * cancelled due to an aborting error, an interrupt, or an exception.
3422 */
3423 if (!aborting())
3424 {
3425 user_func_error(error, (name != NULL) ? name : funcname);
3426 }
3427
3428 // clear the copies made from the partial
3429 while (argv_clear > 0)
3430 clear_tv(&argv[--argv_clear + argv_base]);
3431
3432 vim_free(tofree);
3433 vim_free(name);
3434
3435 return ret;
3436 }
3437
3438 char_u *
printable_func_name(ufunc_T * fp)3439 printable_func_name(ufunc_T *fp)
3440 {
3441 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3442 }
3443
3444 /*
3445 * List the head of the function: "function name(arg1, arg2)".
3446 */
3447 static void
list_func_head(ufunc_T * fp,int indent)3448 list_func_head(ufunc_T *fp, int indent)
3449 {
3450 int j;
3451
3452 msg_start();
3453 if (indent)
3454 msg_puts(" ");
3455 if (fp->uf_def_status != UF_NOT_COMPILED)
3456 msg_puts("def ");
3457 else
3458 msg_puts("function ");
3459 msg_puts((char *)printable_func_name(fp));
3460 msg_putchar('(');
3461 for (j = 0; j < fp->uf_args.ga_len; ++j)
3462 {
3463 if (j)
3464 msg_puts(", ");
3465 msg_puts((char *)FUNCARG(fp, j));
3466 if (fp->uf_arg_types != NULL)
3467 {
3468 char *tofree;
3469
3470 msg_puts(": ");
3471 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3472 vim_free(tofree);
3473 }
3474 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3475 {
3476 msg_puts(" = ");
3477 msg_puts(((char **)(fp->uf_def_args.ga_data))
3478 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3479 }
3480 }
3481 if (fp->uf_varargs)
3482 {
3483 if (j)
3484 msg_puts(", ");
3485 msg_puts("...");
3486 }
3487 if (fp->uf_va_name != NULL)
3488 {
3489 if (j)
3490 msg_puts(", ");
3491 msg_puts("...");
3492 msg_puts((char *)fp->uf_va_name);
3493 if (fp->uf_va_type != NULL)
3494 {
3495 char *tofree;
3496
3497 msg_puts(": ");
3498 msg_puts(type_name(fp->uf_va_type, &tofree));
3499 vim_free(tofree);
3500 }
3501 }
3502 msg_putchar(')');
3503
3504 if (fp->uf_def_status != UF_NOT_COMPILED)
3505 {
3506 if (fp->uf_ret_type != &t_void)
3507 {
3508 char *tofree;
3509
3510 msg_puts(": ");
3511 msg_puts(type_name(fp->uf_ret_type, &tofree));
3512 vim_free(tofree);
3513 }
3514 }
3515 else if (fp->uf_flags & FC_ABORT)
3516 msg_puts(" abort");
3517 if (fp->uf_flags & FC_RANGE)
3518 msg_puts(" range");
3519 if (fp->uf_flags & FC_DICT)
3520 msg_puts(" dict");
3521 if (fp->uf_flags & FC_CLOSURE)
3522 msg_puts(" closure");
3523 msg_clr_eos();
3524 if (p_verbose > 0)
3525 last_set_msg(fp->uf_script_ctx);
3526 }
3527
3528 /*
3529 * Get a function name, translating "<SID>" and "<SNR>".
3530 * Also handles a Funcref in a List or Dictionary.
3531 * Returns the function name in allocated memory, or NULL for failure.
3532 * Set "*is_global" to TRUE when the function must be global, unless
3533 * "is_global" is NULL.
3534 * flags:
3535 * TFN_INT: internal function name OK
3536 * TFN_QUIET: be quiet
3537 * TFN_NO_AUTOLOAD: do not use script autoloading
3538 * TFN_NO_DEREF: do not dereference a Funcref
3539 * Advances "pp" to just after the function name (if no error).
3540 */
3541 char_u *
trans_function_name(char_u ** pp,int * is_global,int skip,int flags,funcdict_T * fdp,partial_T ** partial,type_T ** type)3542 trans_function_name(
3543 char_u **pp,
3544 int *is_global,
3545 int skip, // only find the end, don't evaluate
3546 int flags,
3547 funcdict_T *fdp, // return: info about dictionary used
3548 partial_T **partial, // return: partial of a FuncRef
3549 type_T **type) // return: type of funcref if not NULL
3550 {
3551 char_u *name = NULL;
3552 char_u *start;
3553 char_u *end;
3554 int lead;
3555 char_u sid_buf[20];
3556 int len;
3557 int extra = 0;
3558 lval_T lv;
3559 int vim9script;
3560 static char *e_function_name = N_("E129: Function name required");
3561
3562 if (fdp != NULL)
3563 CLEAR_POINTER(fdp);
3564 start = *pp;
3565
3566 // Check for hard coded <SNR>: already translated function ID (from a user
3567 // command).
3568 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3569 && (*pp)[2] == (int)KE_SNR)
3570 {
3571 *pp += 3;
3572 len = get_id_len(pp) + 3;
3573 return vim_strnsave(start, len);
3574 }
3575
3576 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3577 // don't skip over "s:", get_lval() needs it for "s:dict.func".
3578 lead = eval_fname_script(start);
3579 if (lead > 2)
3580 start += lead;
3581
3582 // Note that TFN_ flags use the same values as GLV_ flags.
3583 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
3584 lead > 2 ? 0 : FNE_CHECK_START);
3585 if (end == start)
3586 {
3587 if (!skip)
3588 emsg(_(e_function_name));
3589 goto theend;
3590 }
3591 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3592 {
3593 /*
3594 * Report an invalid expression in braces, unless the expression
3595 * evaluation has been cancelled due to an aborting error, an
3596 * interrupt, or an exception.
3597 */
3598 if (!aborting())
3599 {
3600 if (end != NULL)
3601 semsg(_(e_invarg2), start);
3602 }
3603 else
3604 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3605 goto theend;
3606 }
3607
3608 if (lv.ll_tv != NULL)
3609 {
3610 if (fdp != NULL)
3611 {
3612 fdp->fd_dict = lv.ll_dict;
3613 fdp->fd_newkey = lv.ll_newkey;
3614 lv.ll_newkey = NULL;
3615 fdp->fd_di = lv.ll_di;
3616 }
3617 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3618 {
3619 name = vim_strsave(lv.ll_tv->vval.v_string);
3620 *pp = end;
3621 }
3622 else if (lv.ll_tv->v_type == VAR_PARTIAL
3623 && lv.ll_tv->vval.v_partial != NULL)
3624 {
3625 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
3626 *pp = end;
3627 if (partial != NULL)
3628 *partial = lv.ll_tv->vval.v_partial;
3629 }
3630 else
3631 {
3632 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3633 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
3634 emsg(_(e_funcref));
3635 else
3636 *pp = end;
3637 name = NULL;
3638 }
3639 goto theend;
3640 }
3641
3642 if (lv.ll_name == NULL)
3643 {
3644 // Error found, but continue after the function name.
3645 *pp = end;
3646 goto theend;
3647 }
3648
3649 // Check if the name is a Funcref. If so, use the value.
3650 if (lv.ll_exp_name != NULL)
3651 {
3652 len = (int)STRLEN(lv.ll_exp_name);
3653 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
3654 flags & TFN_NO_AUTOLOAD);
3655 if (name == lv.ll_exp_name)
3656 name = NULL;
3657 }
3658 else if (!(flags & TFN_NO_DEREF))
3659 {
3660 len = (int)(end - *pp);
3661 name = deref_func_name(*pp, &len, partial, type,
3662 flags & TFN_NO_AUTOLOAD);
3663 if (name == *pp)
3664 name = NULL;
3665 }
3666 if (name != NULL)
3667 {
3668 name = vim_strsave(name);
3669 *pp = end;
3670 if (STRNCMP(name, "<SNR>", 5) == 0)
3671 {
3672 // Change "<SNR>" to the byte sequence.
3673 name[0] = K_SPECIAL;
3674 name[1] = KS_EXTRA;
3675 name[2] = (int)KE_SNR;
3676 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3677 }
3678 goto theend;
3679 }
3680
3681 if (lv.ll_exp_name != NULL)
3682 {
3683 len = (int)STRLEN(lv.ll_exp_name);
3684 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3685 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3686 {
3687 // When there was "s:" already or the name expanded to get a
3688 // leading "s:" then remove it.
3689 lv.ll_name += 2;
3690 len -= 2;
3691 lead = 2;
3692 }
3693 }
3694 else
3695 {
3696 // skip over "s:" and "g:"
3697 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
3698 {
3699 if (is_global != NULL && lv.ll_name[0] == 'g')
3700 *is_global = TRUE;
3701 lv.ll_name += 2;
3702 }
3703 len = (int)(end - lv.ll_name);
3704 }
3705 if (len <= 0)
3706 {
3707 if (!skip)
3708 emsg(_(e_function_name));
3709 goto theend;
3710 }
3711
3712 // In Vim9 script a user function is script-local by default, unless it
3713 // starts with a lower case character: dict.func().
3714 vim9script = ASCII_ISUPPER(*start) && in_vim9script();
3715 if (vim9script)
3716 {
3717 char_u *p;
3718
3719 // SomeScript#func() is a global function.
3720 for (p = start; *p != NUL && *p != '('; ++p)
3721 if (*p == AUTOLOAD_CHAR)
3722 vim9script = FALSE;
3723 }
3724
3725 /*
3726 * Copy the function name to allocated memory.
3727 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3728 * Accept <SNR>123_name() outside a script.
3729 */
3730 if (skip)
3731 lead = 0; // do nothing
3732 else if (lead > 0 || vim9script)
3733 {
3734 if (!vim9script)
3735 lead = 3;
3736 if (vim9script || (lv.ll_exp_name != NULL
3737 && eval_fname_sid(lv.ll_exp_name))
3738 || eval_fname_sid(*pp))
3739 {
3740 // It's script-local, "s:" or "<SID>"
3741 if (current_sctx.sc_sid <= 0)
3742 {
3743 emsg(_(e_usingsid));
3744 goto theend;
3745 }
3746 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
3747 if (vim9script)
3748 extra = 3 + (int)STRLEN(sid_buf);
3749 else
3750 lead += (int)STRLEN(sid_buf);
3751 }
3752 }
3753 else if (!(flags & TFN_INT) && (builtin_function(lv.ll_name, len)
3754 || (in_vim9script() && *lv.ll_name == '_')))
3755 {
3756 semsg(_("E128: Function name must start with a capital or \"s:\": %s"),
3757 start);
3758 goto theend;
3759 }
3760 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
3761 {
3762 char_u *cp = vim_strchr(lv.ll_name, ':');
3763
3764 if (cp != NULL && cp < end)
3765 {
3766 semsg(_("E884: Function name cannot contain a colon: %s"), start);
3767 goto theend;
3768 }
3769 }
3770
3771 name = alloc(len + lead + extra + 1);
3772 if (name != NULL)
3773 {
3774 if (!skip && (lead > 0 || vim9script))
3775 {
3776 name[0] = K_SPECIAL;
3777 name[1] = KS_EXTRA;
3778 name[2] = (int)KE_SNR;
3779 if (vim9script || lead > 3) // If it's "<SID>"
3780 STRCPY(name + 3, sid_buf);
3781 }
3782 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
3783 name[lead + extra + len] = NUL;
3784 }
3785 *pp = end;
3786
3787 theend:
3788 clear_lval(&lv);
3789 return name;
3790 }
3791
3792 /*
3793 * Assuming "name" is the result of trans_function_name() and it was prefixed
3794 * to use the script-local name, return the unmodified name (points into
3795 * "name"). Otherwise return NULL.
3796 * This can be used to first search for a script-local function and fall back
3797 * to the global function if not found.
3798 */
3799 char_u *
untrans_function_name(char_u * name)3800 untrans_function_name(char_u *name)
3801 {
3802 char_u *p;
3803
3804 if (*name == K_SPECIAL && in_vim9script())
3805 {
3806 p = vim_strchr(name, '_');
3807 if (p != NULL)
3808 return p + 1;
3809 }
3810 return NULL;
3811 }
3812
3813 /*
3814 * List functions. When "regmatch" is NULL all of then.
3815 * Otherwise functions matching "regmatch".
3816 */
3817 void
list_functions(regmatch_T * regmatch)3818 list_functions(regmatch_T *regmatch)
3819 {
3820 int changed = func_hashtab.ht_changed;
3821 long_u todo = func_hashtab.ht_used;
3822 hashitem_T *hi;
3823
3824 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
3825 {
3826 if (!HASHITEM_EMPTY(hi))
3827 {
3828 ufunc_T *fp = HI2UF(hi);
3829
3830 --todo;
3831 if ((fp->uf_flags & FC_DEAD) == 0
3832 && (regmatch == NULL
3833 ? !message_filtered(fp->uf_name)
3834 && !func_name_refcount(fp->uf_name)
3835 : !isdigit(*fp->uf_name)
3836 && vim_regexec(regmatch, fp->uf_name, 0)))
3837 {
3838 list_func_head(fp, FALSE);
3839 if (changed != func_hashtab.ht_changed)
3840 {
3841 emsg(_("E454: function list was modified"));
3842 return;
3843 }
3844 }
3845 }
3846 }
3847 }
3848
3849 /*
3850 * ":function" also supporting nested ":def".
3851 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
3852 * the function name.
3853 * Returns a pointer to the function or NULL if no function defined.
3854 */
3855 ufunc_T *
define_function(exarg_T * eap,char_u * name_arg)3856 define_function(exarg_T *eap, char_u *name_arg)
3857 {
3858 char_u *line_to_free = NULL;
3859 int j;
3860 int c;
3861 int saved_did_emsg;
3862 char_u *name = name_arg;
3863 int is_global = FALSE;
3864 char_u *p;
3865 char_u *arg;
3866 char_u *whitep;
3867 char_u *line_arg = NULL;
3868 garray_T newargs;
3869 garray_T argtypes;
3870 garray_T default_args;
3871 garray_T newlines;
3872 int varargs = FALSE;
3873 int flags = 0;
3874 char_u *ret_type = NULL;
3875 ufunc_T *fp = NULL;
3876 int overwrite = FALSE;
3877 dictitem_T *v;
3878 funcdict_T fudi;
3879 static int func_nr = 0; // number for nameless function
3880 int paren;
3881 hashitem_T *hi;
3882 linenr_T sourcing_lnum_top;
3883 int vim9script = in_vim9script();
3884 imported_T *import = NULL;
3885
3886 /*
3887 * ":function" without argument: list functions.
3888 */
3889 if (ends_excmd2(eap->cmd, eap->arg))
3890 {
3891 if (!eap->skip)
3892 list_functions(NULL);
3893 set_nextcmd(eap, eap->arg);
3894 return NULL;
3895 }
3896
3897 /*
3898 * ":function /pat": list functions matching pattern.
3899 */
3900 if (*eap->arg == '/')
3901 {
3902 p = skip_regexp(eap->arg + 1, '/', TRUE);
3903 if (!eap->skip)
3904 {
3905 regmatch_T regmatch;
3906
3907 c = *p;
3908 *p = NUL;
3909 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
3910 *p = c;
3911 if (regmatch.regprog != NULL)
3912 {
3913 regmatch.rm_ic = p_ic;
3914 list_functions(®match);
3915 vim_regfree(regmatch.regprog);
3916 }
3917 }
3918 if (*p == '/')
3919 ++p;
3920 set_nextcmd(eap, p);
3921 return NULL;
3922 }
3923
3924 ga_init(&newargs);
3925 ga_init(&argtypes);
3926 ga_init(&default_args);
3927
3928 /*
3929 * Get the function name. There are these situations:
3930 * func normal function name
3931 * "name" == func, "fudi.fd_dict" == NULL
3932 * dict.func new dictionary entry
3933 * "name" == NULL, "fudi.fd_dict" set,
3934 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
3935 * dict.func existing dict entry with a Funcref
3936 * "name" == func, "fudi.fd_dict" set,
3937 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3938 * dict.func existing dict entry that's not a Funcref
3939 * "name" == NULL, "fudi.fd_dict" set,
3940 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
3941 * s:func script-local function name
3942 * g:func global function name, same as "func"
3943 */
3944 p = eap->arg;
3945 if (name_arg != NULL)
3946 {
3947 // nested function, argument is (args).
3948 paren = TRUE;
3949 CLEAR_FIELD(fudi);
3950 }
3951 else
3952 {
3953 if (STRNCMP(p, "<lambda>", 8) == 0)
3954 {
3955 p += 8;
3956 (void)getdigits(&p);
3957 name = vim_strnsave(eap->arg, p - eap->arg);
3958 CLEAR_FIELD(fudi);
3959 }
3960 else
3961 name = trans_function_name(&p, &is_global, eap->skip,
3962 TFN_NO_AUTOLOAD, &fudi, NULL, NULL);
3963 paren = (vim_strchr(p, '(') != NULL);
3964 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
3965 {
3966 /*
3967 * Return on an invalid expression in braces, unless the expression
3968 * evaluation has been cancelled due to an aborting error, an
3969 * interrupt, or an exception.
3970 */
3971 if (!aborting())
3972 {
3973 if (!eap->skip && fudi.fd_newkey != NULL)
3974 semsg(_(e_dictkey), fudi.fd_newkey);
3975 vim_free(fudi.fd_newkey);
3976 return NULL;
3977 }
3978 else
3979 eap->skip = TRUE;
3980 }
3981 }
3982
3983 // An error in a function call during evaluation of an expression in magic
3984 // braces should not cause the function not to be defined.
3985 saved_did_emsg = did_emsg;
3986 did_emsg = FALSE;
3987
3988 /*
3989 * ":function func" with only function name: list function.
3990 */
3991 if (!paren)
3992 {
3993 if (!ends_excmd(*skipwhite(p)))
3994 {
3995 semsg(_(e_trailing_arg), p);
3996 goto ret_free;
3997 }
3998 set_nextcmd(eap, p);
3999 if (eap->nextcmd != NULL)
4000 *p = NUL;
4001 if (!eap->skip && !got_int)
4002 {
4003 fp = find_func(name, is_global, NULL);
4004 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
4005 {
4006 char_u *up = untrans_function_name(name);
4007
4008 // With Vim9 script the name was made script-local, if not
4009 // found try again with the original name.
4010 if (up != NULL)
4011 fp = find_func(up, FALSE, NULL);
4012 }
4013
4014 if (fp != NULL)
4015 {
4016 list_func_head(fp, TRUE);
4017 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
4018 {
4019 if (FUNCLINE(fp, j) == NULL)
4020 continue;
4021 msg_putchar('\n');
4022 msg_outnum((long)(j + 1));
4023 if (j < 9)
4024 msg_putchar(' ');
4025 if (j < 99)
4026 msg_putchar(' ');
4027 msg_prt_line(FUNCLINE(fp, j), FALSE);
4028 out_flush(); // show a line at a time
4029 ui_breakcheck();
4030 }
4031 if (!got_int)
4032 {
4033 msg_putchar('\n');
4034 if (fp->uf_def_status != UF_NOT_COMPILED)
4035 msg_puts(" enddef");
4036 else
4037 msg_puts(" endfunction");
4038 }
4039 }
4040 else
4041 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg);
4042 }
4043 goto ret_free;
4044 }
4045
4046 /*
4047 * ":function name(arg1, arg2)" Define function.
4048 */
4049 p = skipwhite(p);
4050 if (*p != '(')
4051 {
4052 if (!eap->skip)
4053 {
4054 semsg(_("E124: Missing '(': %s"), eap->arg);
4055 goto ret_free;
4056 }
4057 // attempt to continue by skipping some text
4058 if (vim_strchr(p, '(') != NULL)
4059 p = vim_strchr(p, '(');
4060 }
4061
4062 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
4063 {
4064 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
4065 goto ret_free;
4066 }
4067
4068 // In Vim9 script only global functions can be redefined.
4069 if (vim9script && eap->forceit && !is_global)
4070 {
4071 emsg(_(e_nobang));
4072 goto ret_free;
4073 }
4074
4075 ga_init2(&newlines, (int)sizeof(char_u *), 10);
4076
4077 if (!eap->skip && name_arg == NULL)
4078 {
4079 // Check the name of the function. Unless it's a dictionary function
4080 // (that we are overwriting).
4081 if (name != NULL)
4082 arg = name;
4083 else
4084 arg = fudi.fd_newkey;
4085 if (arg != NULL && (fudi.fd_di == NULL
4086 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
4087 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
4088 {
4089 if (*arg == K_SPECIAL)
4090 j = 3;
4091 else
4092 j = 0;
4093 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j])
4094 : eval_isnamec(arg[j])))
4095 ++j;
4096 if (arg[j] != NUL)
4097 emsg_funcname((char *)e_invarg2, arg);
4098 }
4099 // Disallow using the g: dict.
4100 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
4101 emsg(_("E862: Cannot use g: here"));
4102 }
4103
4104 // This may get more lines and make the pointers into the first line
4105 // invalid.
4106 ++p;
4107 if (get_function_args(&p, ')', &newargs,
4108 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
4109 NULL, &varargs, &default_args, eap->skip,
4110 eap, &line_to_free) == FAIL)
4111 goto errret_2;
4112 whitep = p;
4113
4114 if (eap->cmdidx == CMD_def)
4115 {
4116 // find the return type: :def Func(): type
4117 if (*skipwhite(p) == ':')
4118 {
4119 if (*p != ':')
4120 {
4121 semsg(_(e_no_white_space_allowed_before_colon_str), p);
4122 p = skipwhite(p);
4123 }
4124 else if (!IS_WHITE_OR_NUL(p[1]))
4125 semsg(_(e_white_space_required_after_str_str), ":", p);
4126 ret_type = skipwhite(p + 1);
4127 p = skip_type(ret_type, FALSE);
4128 if (p > ret_type)
4129 {
4130 ret_type = vim_strnsave(ret_type, p - ret_type);
4131 whitep = p;
4132 p = skipwhite(p);
4133 }
4134 else
4135 {
4136 semsg(_(e_expected_type_str), ret_type);
4137 ret_type = NULL;
4138 }
4139 }
4140 p = skipwhite(p);
4141 }
4142 else
4143 // find extra arguments "range", "dict", "abort" and "closure"
4144 for (;;)
4145 {
4146 whitep = p;
4147 p = skipwhite(p);
4148 if (STRNCMP(p, "range", 5) == 0)
4149 {
4150 flags |= FC_RANGE;
4151 p += 5;
4152 }
4153 else if (STRNCMP(p, "dict", 4) == 0)
4154 {
4155 flags |= FC_DICT;
4156 p += 4;
4157 }
4158 else if (STRNCMP(p, "abort", 5) == 0)
4159 {
4160 flags |= FC_ABORT;
4161 p += 5;
4162 }
4163 else if (STRNCMP(p, "closure", 7) == 0)
4164 {
4165 flags |= FC_CLOSURE;
4166 p += 7;
4167 if (current_funccal == NULL)
4168 {
4169 emsg_funcname(N_("E932: Closure function should not be at top level: %s"),
4170 name == NULL ? (char_u *)"" : name);
4171 goto erret;
4172 }
4173 }
4174 else
4175 break;
4176 }
4177
4178 // When there is a line break use what follows for the function body.
4179 // Makes 'exe "func Test()\n...\nendfunc"' work.
4180 if (*p == '\n')
4181 line_arg = p + 1;
4182 else if (*p != NUL
4183 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
4184 && eap->cmdidx != CMD_def)
4185 && !(VIM_ISWHITE(*whitep) && *p == '#'
4186 && (vim9script || eap->cmdidx == CMD_def))
4187 && !eap->skip
4188 && !did_emsg)
4189 semsg(_(e_trailing_arg), p);
4190
4191 /*
4192 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
4193 * found.
4194 */
4195 if (KeyTyped)
4196 {
4197 // Check if the function already exists, don't let the user type the
4198 // whole function before telling him it doesn't work! For a script we
4199 // need to skip the body to be able to find what follows.
4200 if (!eap->skip && !eap->forceit)
4201 {
4202 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
4203 emsg(_(e_funcdict));
4204 else if (name != NULL && find_func(name, is_global, NULL) != NULL)
4205 emsg_funcname(e_funcexts, name);
4206 }
4207
4208 if (!eap->skip && did_emsg)
4209 goto erret;
4210
4211 msg_putchar('\n'); // don't overwrite the function name
4212 cmdline_row = msg_row;
4213 }
4214
4215 // Save the starting line number.
4216 sourcing_lnum_top = SOURCING_LNUM;
4217
4218 // Do not define the function when getting the body fails and when
4219 // skipping.
4220 if (get_function_body(eap, &newlines, line_arg, &line_to_free) == FAIL
4221 || eap->skip)
4222 goto erret;
4223
4224 /*
4225 * If there are no errors, add the function
4226 */
4227 if (fudi.fd_dict == NULL)
4228 {
4229 hashtab_T *ht;
4230
4231 v = find_var(name, &ht, TRUE);
4232 if (v != NULL && v->di_tv.v_type == VAR_FUNC)
4233 {
4234 emsg_funcname(N_("E707: Function name conflicts with variable: %s"),
4235 name);
4236 goto erret;
4237 }
4238
4239 fp = find_func_even_dead(name, is_global, NULL);
4240 if (vim9script)
4241 {
4242 char_u *uname = untrans_function_name(name);
4243
4244 import = find_imported(uname == NULL ? name : uname, 0, NULL);
4245 }
4246
4247 if (fp != NULL || import != NULL)
4248 {
4249 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
4250
4251 // Function can be replaced with "function!" and when sourcing the
4252 // same script again, but only once.
4253 // A name that is used by an import can not be overruled.
4254 if (import != NULL
4255 || (!dead && !eap->forceit
4256 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
4257 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
4258 {
4259 SOURCING_LNUM = sourcing_lnum_top;
4260 if (vim9script)
4261 emsg_funcname(e_name_already_defined_str, name);
4262 else
4263 emsg_funcname(e_funcexts, name);
4264 goto erret;
4265 }
4266 if (fp->uf_calls > 0)
4267 {
4268 emsg_funcname(
4269 N_("E127: Cannot redefine function %s: It is in use"),
4270 name);
4271 goto erret;
4272 }
4273 if (fp->uf_refcount > 1)
4274 {
4275 // This function is referenced somewhere, don't redefine it but
4276 // create a new one.
4277 --fp->uf_refcount;
4278 fp->uf_flags |= FC_REMOVED;
4279 fp = NULL;
4280 overwrite = TRUE;
4281 }
4282 else
4283 {
4284 char_u *exp_name = fp->uf_name_exp;
4285
4286 // redefine existing function, keep the expanded name
4287 VIM_CLEAR(name);
4288 fp->uf_name_exp = NULL;
4289 func_clear_items(fp);
4290 fp->uf_name_exp = exp_name;
4291 fp->uf_flags &= ~FC_DEAD;
4292 #ifdef FEAT_PROFILE
4293 fp->uf_profiling = FALSE;
4294 fp->uf_prof_initialized = FALSE;
4295 #endif
4296 fp->uf_def_status = UF_NOT_COMPILED;
4297 }
4298 }
4299 }
4300 else
4301 {
4302 char numbuf[20];
4303
4304 fp = NULL;
4305 if (fudi.fd_newkey == NULL && !eap->forceit)
4306 {
4307 emsg(_(e_funcdict));
4308 goto erret;
4309 }
4310 if (fudi.fd_di == NULL)
4311 {
4312 // Can't add a function to a locked dictionary
4313 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
4314 goto erret;
4315 }
4316 // Can't change an existing function if it is locked
4317 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
4318 goto erret;
4319
4320 // Give the function a sequential number. Can only be used with a
4321 // Funcref!
4322 vim_free(name);
4323 sprintf(numbuf, "%d", ++func_nr);
4324 name = vim_strsave((char_u *)numbuf);
4325 if (name == NULL)
4326 goto erret;
4327 }
4328
4329 if (fp == NULL)
4330 {
4331 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4332 {
4333 int slen, plen;
4334 char_u *scriptname;
4335
4336 // Check that the autoload name matches the script name.
4337 j = FAIL;
4338 if (SOURCING_NAME != NULL)
4339 {
4340 scriptname = autoload_name(name);
4341 if (scriptname != NULL)
4342 {
4343 p = vim_strchr(scriptname, '/');
4344 plen = (int)STRLEN(p);
4345 slen = (int)STRLEN(SOURCING_NAME);
4346 if (slen > plen && fnamecmp(p,
4347 SOURCING_NAME + slen - plen) == 0)
4348 j = OK;
4349 vim_free(scriptname);
4350 }
4351 }
4352 if (j == FAIL)
4353 {
4354 linenr_T save_lnum = SOURCING_LNUM;
4355
4356 SOURCING_LNUM = sourcing_lnum_top;
4357 semsg(_("E746: Function name does not match script file name: %s"), name);
4358 SOURCING_LNUM = save_lnum;
4359 goto erret;
4360 }
4361 }
4362
4363 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
4364 if (fp == NULL)
4365 goto erret;
4366
4367 if (fudi.fd_dict != NULL)
4368 {
4369 if (fudi.fd_di == NULL)
4370 {
4371 // add new dict entry
4372 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4373 if (fudi.fd_di == NULL)
4374 {
4375 vim_free(fp);
4376 fp = NULL;
4377 goto erret;
4378 }
4379 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4380 {
4381 vim_free(fudi.fd_di);
4382 vim_free(fp);
4383 fp = NULL;
4384 goto erret;
4385 }
4386 }
4387 else
4388 // overwrite existing dict entry
4389 clear_tv(&fudi.fd_di->di_tv);
4390 fudi.fd_di->di_tv.v_type = VAR_FUNC;
4391 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
4392
4393 // behave like "dict" was used
4394 flags |= FC_DICT;
4395 }
4396
4397 // insert the new function in the function list
4398 set_ufunc_name(fp, name);
4399 if (overwrite)
4400 {
4401 hi = hash_find(&func_hashtab, name);
4402 hi->hi_key = UF2HIKEY(fp);
4403 }
4404 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
4405 {
4406 vim_free(fp);
4407 fp = NULL;
4408 goto erret;
4409 }
4410 fp->uf_refcount = 1;
4411 }
4412 fp->uf_args = newargs;
4413 fp->uf_def_args = default_args;
4414 fp->uf_ret_type = &t_any;
4415 fp->uf_func_type = &t_func_any;
4416
4417 if (eap->cmdidx == CMD_def)
4418 {
4419 int lnum_save = SOURCING_LNUM;
4420 cstack_T *cstack = eap->cstack;
4421
4422 fp->uf_def_status = UF_TO_BE_COMPILED;
4423
4424 // error messages are for the first function line
4425 SOURCING_LNUM = sourcing_lnum_top;
4426
4427 // The function may use script variables from the context.
4428 function_using_block_scopes(fp, cstack);
4429
4430 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
4431 {
4432 SOURCING_LNUM = lnum_save;
4433 goto errret_2;
4434 }
4435 varargs = FALSE;
4436
4437 // parse the return type, if any
4438 if (parse_return_type(fp, ret_type) == FAIL)
4439 {
4440 SOURCING_LNUM = lnum_save;
4441 goto erret;
4442 }
4443 SOURCING_LNUM = lnum_save;
4444 }
4445 else
4446 fp->uf_def_status = UF_NOT_COMPILED;
4447
4448 fp->uf_lines = newlines;
4449 if ((flags & FC_CLOSURE) != 0)
4450 {
4451 if (register_closure(fp) == FAIL)
4452 goto erret;
4453 }
4454 else
4455 fp->uf_scoped = NULL;
4456
4457 #ifdef FEAT_PROFILE
4458 if (prof_def_func())
4459 func_do_profile(fp);
4460 #endif
4461 fp->uf_varargs = varargs;
4462 if (sandbox)
4463 flags |= FC_SANDBOX;
4464 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
4465 flags |= FC_VIM9;
4466 fp->uf_flags = flags;
4467 fp->uf_calls = 0;
4468 fp->uf_cleared = FALSE;
4469 fp->uf_script_ctx = current_sctx;
4470 fp->uf_script_ctx_version = current_sctx.sc_version;
4471 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
4472 if (is_export)
4473 {
4474 fp->uf_flags |= FC_EXPORT;
4475 // let ex_export() know the export worked.
4476 is_export = FALSE;
4477 }
4478
4479 if (eap->cmdidx == CMD_def)
4480 set_function_type(fp);
4481 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4482 // :func does not use Vim9 script syntax, even in a Vim9 script file
4483 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
4484
4485 goto ret_free;
4486
4487 erret:
4488 ga_clear_strings(&newargs);
4489 ga_clear_strings(&default_args);
4490 if (fp != NULL)
4491 {
4492 ga_init(&fp->uf_args);
4493 ga_init(&fp->uf_def_args);
4494 }
4495 errret_2:
4496 ga_clear_strings(&newlines);
4497 if (fp != NULL)
4498 VIM_CLEAR(fp->uf_arg_types);
4499 ret_free:
4500 ga_clear_strings(&argtypes);
4501 vim_free(line_to_free);
4502 vim_free(fudi.fd_newkey);
4503 if (name != name_arg)
4504 vim_free(name);
4505 vim_free(ret_type);
4506 did_emsg |= saved_did_emsg;
4507
4508 return fp;
4509 }
4510
4511 /*
4512 * ":function"
4513 */
4514 void
ex_function(exarg_T * eap)4515 ex_function(exarg_T *eap)
4516 {
4517 (void)define_function(eap, NULL);
4518 }
4519
4520 /*
4521 * :defcompile - compile all :def functions in the current script that need to
4522 * be compiled. Except dead functions. Doesn't do profiling.
4523 */
4524 void
ex_defcompile(exarg_T * eap UNUSED)4525 ex_defcompile(exarg_T *eap UNUSED)
4526 {
4527 long todo = (long)func_hashtab.ht_used;
4528 int changed = func_hashtab.ht_changed;
4529 hashitem_T *hi;
4530 ufunc_T *ufunc;
4531
4532 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
4533 {
4534 if (!HASHITEM_EMPTY(hi))
4535 {
4536 --todo;
4537 ufunc = HI2UF(hi);
4538 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
4539 && ufunc->uf_def_status == UF_TO_BE_COMPILED
4540 && (ufunc->uf_flags & FC_DEAD) == 0)
4541 {
4542 (void)compile_def_function(ufunc, FALSE, CT_NONE, NULL);
4543
4544 if (func_hashtab.ht_changed != changed)
4545 {
4546 // a function has been added or removed, need to start over
4547 todo = (long)func_hashtab.ht_used;
4548 changed = func_hashtab.ht_changed;
4549 hi = func_hashtab.ht_array;
4550 --hi;
4551 }
4552 }
4553 }
4554 }
4555 }
4556
4557 /*
4558 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
4559 * Return 2 if "p" starts with "s:".
4560 * Return 0 otherwise.
4561 */
4562 int
eval_fname_script(char_u * p)4563 eval_fname_script(char_u *p)
4564 {
4565 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
4566 // the standard library function.
4567 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
4568 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
4569 return 5;
4570 if (p[0] == 's' && p[1] == ':')
4571 return 2;
4572 return 0;
4573 }
4574
4575 int
translated_function_exists(char_u * name,int is_global)4576 translated_function_exists(char_u *name, int is_global)
4577 {
4578 if (builtin_function(name, -1))
4579 return has_internal_func(name);
4580 return find_func(name, is_global, NULL) != NULL;
4581 }
4582
4583 /*
4584 * Return TRUE when "ufunc" has old-style "..." varargs
4585 * or named varargs "...name: type".
4586 */
4587 int
has_varargs(ufunc_T * ufunc)4588 has_varargs(ufunc_T *ufunc)
4589 {
4590 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
4591 }
4592
4593 /*
4594 * Return TRUE if a function "name" exists.
4595 * If "no_defef" is TRUE, do not dereference a Funcref.
4596 */
4597 int
function_exists(char_u * name,int no_deref)4598 function_exists(char_u *name, int no_deref)
4599 {
4600 char_u *nm = name;
4601 char_u *p;
4602 int n = FALSE;
4603 int flag;
4604 int is_global = FALSE;
4605
4606 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
4607 if (no_deref)
4608 flag |= TFN_NO_DEREF;
4609 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
4610 nm = skipwhite(nm);
4611
4612 // Only accept "funcname", "funcname ", "funcname (..." and
4613 // "funcname(...", not "funcname!...".
4614 if (p != NULL && (*nm == NUL || *nm == '('))
4615 n = translated_function_exists(p, is_global);
4616 vim_free(p);
4617 return n;
4618 }
4619
4620 #if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
4621 char_u *
get_expanded_name(char_u * name,int check)4622 get_expanded_name(char_u *name, int check)
4623 {
4624 char_u *nm = name;
4625 char_u *p;
4626 int is_global = FALSE;
4627
4628 p = trans_function_name(&nm, &is_global, FALSE,
4629 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
4630
4631 if (p != NULL && *nm == NUL
4632 && (!check || translated_function_exists(p, is_global)))
4633 return p;
4634
4635 vim_free(p);
4636 return NULL;
4637 }
4638 #endif
4639
4640 /*
4641 * Function given to ExpandGeneric() to obtain the list of user defined
4642 * function names.
4643 */
4644 char_u *
get_user_func_name(expand_T * xp,int idx)4645 get_user_func_name(expand_T *xp, int idx)
4646 {
4647 static long_u done;
4648 static int changed;
4649 static hashitem_T *hi;
4650 ufunc_T *fp;
4651
4652 if (idx == 0)
4653 {
4654 done = 0;
4655 hi = func_hashtab.ht_array;
4656 changed = func_hashtab.ht_changed;
4657 }
4658 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
4659 {
4660 if (done++ > 0)
4661 ++hi;
4662 while (HASHITEM_EMPTY(hi))
4663 ++hi;
4664 fp = HI2UF(hi);
4665
4666 // don't show dead, dict and lambda functions
4667 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
4668 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
4669 return (char_u *)"";
4670
4671 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
4672 return fp->uf_name; // prevents overflow
4673
4674 cat_func_name(IObuff, fp);
4675 if (xp->xp_context != EXPAND_USER_FUNC
4676 && xp->xp_context != EXPAND_DISASSEMBLE)
4677 {
4678 STRCAT(IObuff, "(");
4679 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
4680 STRCAT(IObuff, ")");
4681 }
4682 return IObuff;
4683 }
4684 return NULL;
4685 }
4686
4687 /*
4688 * ":delfunction {name}"
4689 */
4690 void
ex_delfunction(exarg_T * eap)4691 ex_delfunction(exarg_T *eap)
4692 {
4693 ufunc_T *fp = NULL;
4694 char_u *p;
4695 char_u *name;
4696 funcdict_T fudi;
4697 int is_global = FALSE;
4698
4699 p = eap->arg;
4700 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
4701 NULL, NULL);
4702 vim_free(fudi.fd_newkey);
4703 if (name == NULL)
4704 {
4705 if (fudi.fd_dict != NULL && !eap->skip)
4706 emsg(_(e_funcref));
4707 return;
4708 }
4709 if (!ends_excmd(*skipwhite(p)))
4710 {
4711 vim_free(name);
4712 semsg(_(e_trailing_arg), p);
4713 return;
4714 }
4715 set_nextcmd(eap, p);
4716 if (eap->nextcmd != NULL)
4717 *p = NUL;
4718
4719 if (isdigit(*name) && fudi.fd_dict == NULL)
4720 {
4721 if (!eap->skip)
4722 semsg(_(e_invarg2), eap->arg);
4723 vim_free(name);
4724 return;
4725 }
4726 if (!eap->skip)
4727 fp = find_func(name, is_global, NULL);
4728 vim_free(name);
4729
4730 if (!eap->skip)
4731 {
4732 if (fp == NULL)
4733 {
4734 if (!eap->forceit)
4735 semsg(_(e_nofunc), eap->arg);
4736 return;
4737 }
4738 if (fp->uf_calls > 0)
4739 {
4740 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg);
4741 return;
4742 }
4743 if (fp->uf_flags & FC_VIM9)
4744 {
4745 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
4746 return;
4747 }
4748
4749 if (fudi.fd_dict != NULL)
4750 {
4751 // Delete the dict item that refers to the function, it will
4752 // invoke func_unref() and possibly delete the function.
4753 dictitem_remove(fudi.fd_dict, fudi.fd_di);
4754 }
4755 else
4756 {
4757 // A normal function (not a numbered function or lambda) has a
4758 // refcount of 1 for the entry in the hashtable. When deleting
4759 // it and the refcount is more than one, it should be kept.
4760 // A numbered function and lambda should be kept if the refcount is
4761 // one or more.
4762 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
4763 {
4764 // Function is still referenced somewhere. Don't free it but
4765 // do remove it from the hashtable.
4766 if (func_remove(fp))
4767 fp->uf_refcount--;
4768 }
4769 else
4770 func_clear_free(fp, FALSE);
4771 }
4772 }
4773 }
4774
4775 /*
4776 * Unreference a Function: decrement the reference count and free it when it
4777 * becomes zero.
4778 */
4779 void
func_unref(char_u * name)4780 func_unref(char_u *name)
4781 {
4782 ufunc_T *fp = NULL;
4783
4784 if (name == NULL || !func_name_refcount(name))
4785 return;
4786 fp = find_func(name, FALSE, NULL);
4787 if (fp == NULL && isdigit(*name))
4788 {
4789 #ifdef EXITFREE
4790 if (!entered_free_all_mem)
4791 #endif
4792 internal_error("func_unref()");
4793 }
4794 func_ptr_unref(fp);
4795 }
4796
4797 /*
4798 * Unreference a Function: decrement the reference count and free it when it
4799 * becomes zero.
4800 * Also when it becomes one and uf_partial points to the function.
4801 */
4802 void
func_ptr_unref(ufunc_T * fp)4803 func_ptr_unref(ufunc_T *fp)
4804 {
4805 if (fp != NULL && (--fp->uf_refcount <= 0
4806 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
4807 && fp->uf_partial->pt_refcount <= 1
4808 && fp->uf_partial->pt_func == fp)))
4809 {
4810 // Only delete it when it's not being used. Otherwise it's done
4811 // when "uf_calls" becomes zero.
4812 if (fp->uf_calls == 0)
4813 func_clear_free(fp, FALSE);
4814 }
4815 }
4816
4817 /*
4818 * Count a reference to a Function.
4819 */
4820 void
func_ref(char_u * name)4821 func_ref(char_u *name)
4822 {
4823 ufunc_T *fp;
4824
4825 if (name == NULL || !func_name_refcount(name))
4826 return;
4827 fp = find_func(name, FALSE, NULL);
4828 if (fp != NULL)
4829 ++fp->uf_refcount;
4830 else if (isdigit(*name))
4831 // Only give an error for a numbered function.
4832 // Fail silently, when named or lambda function isn't found.
4833 internal_error("func_ref()");
4834 }
4835
4836 /*
4837 * Count a reference to a Function.
4838 */
4839 void
func_ptr_ref(ufunc_T * fp)4840 func_ptr_ref(ufunc_T *fp)
4841 {
4842 if (fp != NULL)
4843 ++fp->uf_refcount;
4844 }
4845
4846 /*
4847 * Return TRUE if items in "fc" do not have "copyID". That means they are not
4848 * referenced from anywhere that is in use.
4849 */
4850 static int
can_free_funccal(funccall_T * fc,int copyID)4851 can_free_funccal(funccall_T *fc, int copyID)
4852 {
4853 return (fc->l_varlist.lv_copyID != copyID
4854 && fc->l_vars.dv_copyID != copyID
4855 && fc->l_avars.dv_copyID != copyID
4856 && fc->fc_copyID != copyID);
4857 }
4858
4859 /*
4860 * ":return [expr]"
4861 */
4862 void
ex_return(exarg_T * eap)4863 ex_return(exarg_T *eap)
4864 {
4865 char_u *arg = eap->arg;
4866 typval_T rettv;
4867 int returning = FALSE;
4868 evalarg_T evalarg;
4869
4870 if (current_funccal == NULL)
4871 {
4872 emsg(_("E133: :return not inside a function"));
4873 return;
4874 }
4875
4876 init_evalarg(&evalarg);
4877 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
4878
4879 if (eap->skip)
4880 ++emsg_skip;
4881
4882 eap->nextcmd = NULL;
4883 if ((*arg != NUL && *arg != '|' && *arg != '\n')
4884 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
4885 {
4886 if (!eap->skip)
4887 returning = do_return(eap, FALSE, TRUE, &rettv);
4888 else
4889 clear_tv(&rettv);
4890 }
4891 // It's safer to return also on error.
4892 else if (!eap->skip)
4893 {
4894 // In return statement, cause_abort should be force_abort.
4895 update_force_abort();
4896
4897 /*
4898 * Return unless the expression evaluation has been cancelled due to an
4899 * aborting error, an interrupt, or an exception.
4900 */
4901 if (!aborting())
4902 returning = do_return(eap, FALSE, TRUE, NULL);
4903 }
4904
4905 // When skipping or the return gets pending, advance to the next command
4906 // in this line (!returning). Otherwise, ignore the rest of the line.
4907 // Following lines will be ignored by get_func_line().
4908 if (returning)
4909 eap->nextcmd = NULL;
4910 else if (eap->nextcmd == NULL) // no argument
4911 set_nextcmd(eap, arg);
4912
4913 if (eap->skip)
4914 --emsg_skip;
4915 clear_evalarg(&evalarg, eap);
4916 }
4917
4918 /*
4919 * ":1,25call func(arg1, arg2)" function call.
4920 */
4921 void
ex_call(exarg_T * eap)4922 ex_call(exarg_T *eap)
4923 {
4924 char_u *arg = eap->arg;
4925 char_u *startarg;
4926 char_u *name;
4927 char_u *tofree;
4928 int len;
4929 typval_T rettv;
4930 linenr_T lnum;
4931 int doesrange;
4932 int failed = FALSE;
4933 funcdict_T fudi;
4934 partial_T *partial = NULL;
4935 evalarg_T evalarg;
4936 type_T *type = NULL;
4937
4938 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
4939 if (eap->skip)
4940 {
4941 // trans_function_name() doesn't work well when skipping, use eval0()
4942 // instead to skip to any following command, e.g. for:
4943 // :if 0 | call dict.foo().bar() | endif
4944 ++emsg_skip;
4945 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
4946 clear_tv(&rettv);
4947 --emsg_skip;
4948 clear_evalarg(&evalarg, eap);
4949 return;
4950 }
4951
4952 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
4953 &fudi, &partial, in_vim9script() ? &type : NULL);
4954 if (fudi.fd_newkey != NULL)
4955 {
4956 // Still need to give an error message for missing key.
4957 semsg(_(e_dictkey), fudi.fd_newkey);
4958 vim_free(fudi.fd_newkey);
4959 }
4960 if (tofree == NULL)
4961 return;
4962
4963 // Increase refcount on dictionary, it could get deleted when evaluating
4964 // the arguments.
4965 if (fudi.fd_dict != NULL)
4966 ++fudi.fd_dict->dv_refcount;
4967
4968 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
4969 // contents. For VAR_PARTIAL get its partial, unless we already have one
4970 // from trans_function_name().
4971 len = (int)STRLEN(tofree);
4972 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
4973 in_vim9script() && type == NULL ? &type : NULL, FALSE);
4974
4975 // Skip white space to allow ":call func ()". Not good, but required for
4976 // backward compatibility.
4977 startarg = skipwhite(arg);
4978 if (*startarg != '(')
4979 {
4980 semsg(_(e_missing_paren), eap->arg);
4981 goto end;
4982 }
4983 if (in_vim9script() && startarg > arg)
4984 {
4985 semsg(_(e_no_white_space_allowed_before_str_str), "(", eap->arg);
4986 goto end;
4987 }
4988
4989 /*
4990 * When skipping, evaluate the function once, to find the end of the
4991 * arguments.
4992 * When the function takes a range, this is discovered after the first
4993 * call, and the loop is broken.
4994 */
4995 if (eap->skip)
4996 {
4997 ++emsg_skip;
4998 lnum = eap->line2; // do it once, also with an invalid range
4999 }
5000 else
5001 lnum = eap->line1;
5002 for ( ; lnum <= eap->line2; ++lnum)
5003 {
5004 funcexe_T funcexe;
5005
5006 if (!eap->skip && eap->addr_count > 0)
5007 {
5008 if (lnum > curbuf->b_ml.ml_line_count)
5009 {
5010 // If the function deleted lines or switched to another buffer
5011 // the line number may become invalid.
5012 emsg(_(e_invalid_range));
5013 break;
5014 }
5015 curwin->w_cursor.lnum = lnum;
5016 curwin->w_cursor.col = 0;
5017 curwin->w_cursor.coladd = 0;
5018 }
5019 arg = startarg;
5020
5021 CLEAR_FIELD(funcexe);
5022 funcexe.firstline = eap->line1;
5023 funcexe.lastline = eap->line2;
5024 funcexe.doesrange = &doesrange;
5025 funcexe.evaluate = !eap->skip;
5026 funcexe.partial = partial;
5027 funcexe.selfdict = fudi.fd_dict;
5028 funcexe.check_type = type;
5029 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
5030 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
5031 {
5032 failed = TRUE;
5033 break;
5034 }
5035 if (has_watchexpr())
5036 dbg_check_breakpoint(eap);
5037
5038 // Handle a function returning a Funcref, Dictionary or List.
5039 if (handle_subscript(&arg, &rettv,
5040 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
5041 {
5042 failed = TRUE;
5043 break;
5044 }
5045
5046 clear_tv(&rettv);
5047 if (doesrange || eap->skip)
5048 break;
5049
5050 // Stop when immediately aborting on error, or when an interrupt
5051 // occurred or an exception was thrown but not caught.
5052 // get_func_tv() returned OK, so that the check for trailing
5053 // characters below is executed.
5054 if (aborting())
5055 break;
5056 }
5057 if (eap->skip)
5058 --emsg_skip;
5059 clear_evalarg(&evalarg, eap);
5060
5061 // When inside :try we need to check for following "| catch" or "| endtry".
5062 // Not when there was an error, but do check if an exception was thrown.
5063 if ((!aborting() || did_throw)
5064 && (!failed || eap->cstack->cs_trylevel > 0))
5065 {
5066 // Check for trailing illegal characters and a following command.
5067 arg = skipwhite(arg);
5068 if (!ends_excmd2(eap->arg, arg))
5069 {
5070 if (!failed && !aborting())
5071 {
5072 emsg_severe = TRUE;
5073 semsg(_(e_trailing_arg), arg);
5074 }
5075 }
5076 else
5077 set_nextcmd(eap, arg);
5078 }
5079
5080 end:
5081 dict_unref(fudi.fd_dict);
5082 vim_free(tofree);
5083 }
5084
5085 /*
5086 * Return from a function. Possibly makes the return pending. Also called
5087 * for a pending return at the ":endtry" or after returning from an extra
5088 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
5089 * when called due to a ":return" command. "rettv" may point to a typval_T
5090 * with the return rettv. Returns TRUE when the return can be carried out,
5091 * FALSE when the return gets pending.
5092 */
5093 int
do_return(exarg_T * eap,int reanimate,int is_cmd,void * rettv)5094 do_return(
5095 exarg_T *eap,
5096 int reanimate,
5097 int is_cmd,
5098 void *rettv)
5099 {
5100 int idx;
5101 cstack_T *cstack = eap->cstack;
5102
5103 if (reanimate)
5104 // Undo the return.
5105 current_funccal->returned = FALSE;
5106
5107 /*
5108 * Cleanup (and inactivate) conditionals, but stop when a try conditional
5109 * not in its finally clause (which then is to be executed next) is found.
5110 * In this case, make the ":return" pending for execution at the ":endtry".
5111 * Otherwise, return normally.
5112 */
5113 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
5114 if (idx >= 0)
5115 {
5116 cstack->cs_pending[idx] = CSTP_RETURN;
5117
5118 if (!is_cmd && !reanimate)
5119 // A pending return again gets pending. "rettv" points to an
5120 // allocated variable with the rettv of the original ":return"'s
5121 // argument if present or is NULL else.
5122 cstack->cs_rettv[idx] = rettv;
5123 else
5124 {
5125 // When undoing a return in order to make it pending, get the stored
5126 // return rettv.
5127 if (reanimate)
5128 rettv = current_funccal->rettv;
5129
5130 if (rettv != NULL)
5131 {
5132 // Store the value of the pending return.
5133 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
5134 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
5135 else
5136 emsg(_(e_out_of_memory));
5137 }
5138 else
5139 cstack->cs_rettv[idx] = NULL;
5140
5141 if (reanimate)
5142 {
5143 // The pending return value could be overwritten by a ":return"
5144 // without argument in a finally clause; reset the default
5145 // return value.
5146 current_funccal->rettv->v_type = VAR_NUMBER;
5147 current_funccal->rettv->vval.v_number = 0;
5148 }
5149 }
5150 report_make_pending(CSTP_RETURN, rettv);
5151 }
5152 else
5153 {
5154 current_funccal->returned = TRUE;
5155
5156 // If the return is carried out now, store the return value. For
5157 // a return immediately after reanimation, the value is already
5158 // there.
5159 if (!reanimate && rettv != NULL)
5160 {
5161 clear_tv(current_funccal->rettv);
5162 *current_funccal->rettv = *(typval_T *)rettv;
5163 if (!is_cmd)
5164 vim_free(rettv);
5165 }
5166 }
5167
5168 return idx < 0;
5169 }
5170
5171 /*
5172 * Free the variable with a pending return value.
5173 */
5174 void
discard_pending_return(void * rettv)5175 discard_pending_return(void *rettv)
5176 {
5177 free_tv((typval_T *)rettv);
5178 }
5179
5180 /*
5181 * Generate a return command for producing the value of "rettv". The result
5182 * is an allocated string. Used by report_pending() for verbose messages.
5183 */
5184 char_u *
get_return_cmd(void * rettv)5185 get_return_cmd(void *rettv)
5186 {
5187 char_u *s = NULL;
5188 char_u *tofree = NULL;
5189 char_u numbuf[NUMBUFLEN];
5190
5191 if (rettv != NULL)
5192 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
5193 if (s == NULL)
5194 s = (char_u *)"";
5195
5196 STRCPY(IObuff, ":return ");
5197 STRNCPY(IObuff + 8, s, IOSIZE - 8);
5198 if (STRLEN(s) + 8 >= IOSIZE)
5199 STRCPY(IObuff + IOSIZE - 4, "...");
5200 vim_free(tofree);
5201 return vim_strsave(IObuff);
5202 }
5203
5204 /*
5205 * Get next function line.
5206 * Called by do_cmdline() to get the next line.
5207 * Returns allocated string, or NULL for end of function.
5208 */
5209 char_u *
get_func_line(int c UNUSED,void * cookie,int indent UNUSED,getline_opt_T options UNUSED)5210 get_func_line(
5211 int c UNUSED,
5212 void *cookie,
5213 int indent UNUSED,
5214 getline_opt_T options UNUSED)
5215 {
5216 funccall_T *fcp = (funccall_T *)cookie;
5217 ufunc_T *fp = fcp->func;
5218 char_u *retval;
5219 garray_T *gap; // growarray with function lines
5220
5221 // If breakpoints have been added/deleted need to check for it.
5222 if (fcp->dbg_tick != debug_tick)
5223 {
5224 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
5225 SOURCING_LNUM);
5226 fcp->dbg_tick = debug_tick;
5227 }
5228 #ifdef FEAT_PROFILE
5229 if (do_profiling == PROF_YES)
5230 func_line_end(cookie);
5231 #endif
5232
5233 gap = &fp->uf_lines;
5234 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5235 || fcp->returned)
5236 retval = NULL;
5237 else
5238 {
5239 // Skip NULL lines (continuation lines).
5240 while (fcp->linenr < gap->ga_len
5241 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
5242 ++fcp->linenr;
5243 if (fcp->linenr >= gap->ga_len)
5244 retval = NULL;
5245 else
5246 {
5247 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
5248 SOURCING_LNUM = fcp->linenr;
5249 #ifdef FEAT_PROFILE
5250 if (do_profiling == PROF_YES)
5251 func_line_start(cookie, SOURCING_LNUM);
5252 #endif
5253 }
5254 }
5255
5256 // Did we encounter a breakpoint?
5257 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
5258 {
5259 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
5260 // Find next breakpoint.
5261 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
5262 SOURCING_LNUM);
5263 fcp->dbg_tick = debug_tick;
5264 }
5265
5266 return retval;
5267 }
5268
5269 /*
5270 * Return TRUE if the currently active function should be ended, because a
5271 * return was encountered or an error occurred. Used inside a ":while".
5272 */
5273 int
func_has_ended(void * cookie)5274 func_has_ended(void *cookie)
5275 {
5276 funccall_T *fcp = (funccall_T *)cookie;
5277
5278 // Ignore the "abort" flag if the abortion behavior has been changed due to
5279 // an error inside a try conditional.
5280 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5281 || fcp->returned);
5282 }
5283
5284 /*
5285 * return TRUE if cookie indicates a function which "abort"s on errors.
5286 */
5287 int
func_has_abort(void * cookie)5288 func_has_abort(
5289 void *cookie)
5290 {
5291 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
5292 }
5293
5294
5295 /*
5296 * Turn "dict.Func" into a partial for "Func" bound to "dict".
5297 * Don't do this when "Func" is already a partial that was bound
5298 * explicitly (pt_auto is FALSE).
5299 * Changes "rettv" in-place.
5300 * Returns the updated "selfdict_in".
5301 */
5302 dict_T *
make_partial(dict_T * selfdict_in,typval_T * rettv)5303 make_partial(dict_T *selfdict_in, typval_T *rettv)
5304 {
5305 char_u *fname;
5306 char_u *tofree = NULL;
5307 ufunc_T *fp;
5308 char_u fname_buf[FLEN_FIXED + 1];
5309 int error;
5310 dict_T *selfdict = selfdict_in;
5311
5312 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL)
5313 fp = rettv->vval.v_partial->pt_func;
5314 else
5315 {
5316 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
5317 : rettv->vval.v_partial->pt_name;
5318 // Translate "s:func" to the stored function name.
5319 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
5320 fp = find_func(fname, FALSE, NULL);
5321 vim_free(tofree);
5322 }
5323
5324 if (fp != NULL && (fp->uf_flags & FC_DICT))
5325 {
5326 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
5327
5328 if (pt != NULL)
5329 {
5330 pt->pt_refcount = 1;
5331 pt->pt_dict = selfdict;
5332 pt->pt_auto = TRUE;
5333 selfdict = NULL;
5334 if (rettv->v_type == VAR_FUNC)
5335 {
5336 // Just a function: Take over the function name and use
5337 // selfdict.
5338 pt->pt_name = rettv->vval.v_string;
5339 }
5340 else
5341 {
5342 partial_T *ret_pt = rettv->vval.v_partial;
5343 int i;
5344
5345 // Partial: copy the function name, use selfdict and copy
5346 // args. Can't take over name or args, the partial might
5347 // be referenced elsewhere.
5348 if (ret_pt->pt_name != NULL)
5349 {
5350 pt->pt_name = vim_strsave(ret_pt->pt_name);
5351 func_ref(pt->pt_name);
5352 }
5353 else
5354 {
5355 pt->pt_func = ret_pt->pt_func;
5356 func_ptr_ref(pt->pt_func);
5357 }
5358 if (ret_pt->pt_argc > 0)
5359 {
5360 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
5361 if (pt->pt_argv == NULL)
5362 // out of memory: drop the arguments
5363 pt->pt_argc = 0;
5364 else
5365 {
5366 pt->pt_argc = ret_pt->pt_argc;
5367 for (i = 0; i < pt->pt_argc; i++)
5368 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
5369 }
5370 }
5371 partial_unref(ret_pt);
5372 }
5373 rettv->v_type = VAR_PARTIAL;
5374 rettv->vval.v_partial = pt;
5375 }
5376 }
5377 return selfdict;
5378 }
5379
5380 /*
5381 * Return the name of the executed function.
5382 */
5383 char_u *
func_name(void * cookie)5384 func_name(void *cookie)
5385 {
5386 return ((funccall_T *)cookie)->func->uf_name;
5387 }
5388
5389 /*
5390 * Return the address holding the next breakpoint line for a funccall cookie.
5391 */
5392 linenr_T *
func_breakpoint(void * cookie)5393 func_breakpoint(void *cookie)
5394 {
5395 return &((funccall_T *)cookie)->breakpoint;
5396 }
5397
5398 /*
5399 * Return the address holding the debug tick for a funccall cookie.
5400 */
5401 int *
func_dbg_tick(void * cookie)5402 func_dbg_tick(void *cookie)
5403 {
5404 return &((funccall_T *)cookie)->dbg_tick;
5405 }
5406
5407 /*
5408 * Return the nesting level for a funccall cookie.
5409 */
5410 int
func_level(void * cookie)5411 func_level(void *cookie)
5412 {
5413 return ((funccall_T *)cookie)->level;
5414 }
5415
5416 /*
5417 * Return TRUE when a function was ended by a ":return" command.
5418 */
5419 int
current_func_returned(void)5420 current_func_returned(void)
5421 {
5422 return current_funccal->returned;
5423 }
5424
5425 int
free_unref_funccal(int copyID,int testing)5426 free_unref_funccal(int copyID, int testing)
5427 {
5428 int did_free = FALSE;
5429 int did_free_funccal = FALSE;
5430 funccall_T *fc, **pfc;
5431
5432 for (pfc = &previous_funccal; *pfc != NULL; )
5433 {
5434 if (can_free_funccal(*pfc, copyID))
5435 {
5436 fc = *pfc;
5437 *pfc = fc->caller;
5438 free_funccal_contents(fc);
5439 did_free = TRUE;
5440 did_free_funccal = TRUE;
5441 }
5442 else
5443 pfc = &(*pfc)->caller;
5444 }
5445 if (did_free_funccal)
5446 // When a funccal was freed some more items might be garbage
5447 // collected, so run again.
5448 (void)garbage_collect(testing);
5449
5450 return did_free;
5451 }
5452
5453 /*
5454 * Get function call environment based on backtrace debug level
5455 */
5456 static funccall_T *
get_funccal(void)5457 get_funccal(void)
5458 {
5459 int i;
5460 funccall_T *funccal;
5461 funccall_T *temp_funccal;
5462
5463 funccal = current_funccal;
5464 if (debug_backtrace_level > 0)
5465 {
5466 for (i = 0; i < debug_backtrace_level; i++)
5467 {
5468 temp_funccal = funccal->caller;
5469 if (temp_funccal)
5470 funccal = temp_funccal;
5471 else
5472 // backtrace level overflow. reset to max
5473 debug_backtrace_level = i;
5474 }
5475 }
5476 return funccal;
5477 }
5478
5479 /*
5480 * Return the hashtable used for local variables in the current funccal.
5481 * Return NULL if there is no current funccal.
5482 */
5483 hashtab_T *
get_funccal_local_ht()5484 get_funccal_local_ht()
5485 {
5486 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
5487 return NULL;
5488 return &get_funccal()->l_vars.dv_hashtab;
5489 }
5490
5491 /*
5492 * Return the l: scope variable.
5493 * Return NULL if there is no current funccal.
5494 */
5495 dictitem_T *
get_funccal_local_var()5496 get_funccal_local_var()
5497 {
5498 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
5499 return NULL;
5500 return &get_funccal()->l_vars_var;
5501 }
5502
5503 /*
5504 * Return the hashtable used for argument in the current funccal.
5505 * Return NULL if there is no current funccal.
5506 */
5507 hashtab_T *
get_funccal_args_ht()5508 get_funccal_args_ht()
5509 {
5510 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
5511 return NULL;
5512 return &get_funccal()->l_avars.dv_hashtab;
5513 }
5514
5515 /*
5516 * Return the a: scope variable.
5517 * Return NULL if there is no current funccal.
5518 */
5519 dictitem_T *
get_funccal_args_var()5520 get_funccal_args_var()
5521 {
5522 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
5523 return NULL;
5524 return &get_funccal()->l_avars_var;
5525 }
5526
5527 /*
5528 * List function variables, if there is a function.
5529 */
5530 void
list_func_vars(int * first)5531 list_func_vars(int *first)
5532 {
5533 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
5534 list_hashtable_vars(¤t_funccal->l_vars.dv_hashtab,
5535 "l:", FALSE, first);
5536 }
5537
5538 /*
5539 * If "ht" is the hashtable for local variables in the current funccal, return
5540 * the dict that contains it.
5541 * Otherwise return NULL.
5542 */
5543 dict_T *
get_current_funccal_dict(hashtab_T * ht)5544 get_current_funccal_dict(hashtab_T *ht)
5545 {
5546 if (current_funccal != NULL
5547 && ht == ¤t_funccal->l_vars.dv_hashtab)
5548 return ¤t_funccal->l_vars;
5549 return NULL;
5550 }
5551
5552 /*
5553 * Search hashitem in parent scope.
5554 */
5555 hashitem_T *
find_hi_in_scoped_ht(char_u * name,hashtab_T ** pht)5556 find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
5557 {
5558 funccall_T *old_current_funccal = current_funccal;
5559 hashtab_T *ht;
5560 hashitem_T *hi = NULL;
5561 char_u *varname;
5562
5563 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5564 return NULL;
5565
5566 // Search in parent scope, which can be referenced from a lambda.
5567 current_funccal = current_funccal->func->uf_scoped;
5568 while (current_funccal != NULL)
5569 {
5570 ht = find_var_ht(name, &varname);
5571 if (ht != NULL && *varname != NUL)
5572 {
5573 hi = hash_find(ht, varname);
5574 if (!HASHITEM_EMPTY(hi))
5575 {
5576 *pht = ht;
5577 break;
5578 }
5579 }
5580 if (current_funccal == current_funccal->func->uf_scoped)
5581 break;
5582 current_funccal = current_funccal->func->uf_scoped;
5583 }
5584 current_funccal = old_current_funccal;
5585
5586 return hi;
5587 }
5588
5589 /*
5590 * Search variable in parent scope.
5591 */
5592 dictitem_T *
find_var_in_scoped_ht(char_u * name,int no_autoload)5593 find_var_in_scoped_ht(char_u *name, int no_autoload)
5594 {
5595 dictitem_T *v = NULL;
5596 funccall_T *old_current_funccal = current_funccal;
5597 hashtab_T *ht;
5598 char_u *varname;
5599
5600 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
5601 return NULL;
5602
5603 // Search in parent scope which is possible to reference from lambda
5604 current_funccal = current_funccal->func->uf_scoped;
5605 while (current_funccal)
5606 {
5607 ht = find_var_ht(name, &varname);
5608 if (ht != NULL && *varname != NUL)
5609 {
5610 v = find_var_in_ht(ht, *name, varname, no_autoload);
5611 if (v != NULL)
5612 break;
5613 }
5614 if (current_funccal == current_funccal->func->uf_scoped)
5615 break;
5616 current_funccal = current_funccal->func->uf_scoped;
5617 }
5618 current_funccal = old_current_funccal;
5619
5620 return v;
5621 }
5622
5623 /*
5624 * Set "copyID + 1" in previous_funccal and callers.
5625 */
5626 int
set_ref_in_previous_funccal(int copyID)5627 set_ref_in_previous_funccal(int copyID)
5628 {
5629 funccall_T *fc;
5630
5631 for (fc = previous_funccal; fc != NULL; fc = fc->caller)
5632 {
5633 fc->fc_copyID = copyID + 1;
5634 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
5635 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
5636 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL))
5637 return TRUE;
5638 }
5639 return FALSE;
5640 }
5641
5642 static int
set_ref_in_funccal(funccall_T * fc,int copyID)5643 set_ref_in_funccal(funccall_T *fc, int copyID)
5644 {
5645 if (fc->fc_copyID != copyID)
5646 {
5647 fc->fc_copyID = copyID;
5648 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
5649 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
5650 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
5651 || set_ref_in_func(NULL, fc->func, copyID))
5652 return TRUE;
5653 }
5654 return FALSE;
5655 }
5656
5657 /*
5658 * Set "copyID" in all local vars and arguments in the call stack.
5659 */
5660 int
set_ref_in_call_stack(int copyID)5661 set_ref_in_call_stack(int copyID)
5662 {
5663 funccall_T *fc;
5664 funccal_entry_T *entry;
5665
5666 for (fc = current_funccal; fc != NULL; fc = fc->caller)
5667 if (set_ref_in_funccal(fc, copyID))
5668 return TRUE;
5669
5670 // Also go through the funccal_stack.
5671 for (entry = funccal_stack; entry != NULL; entry = entry->next)
5672 for (fc = entry->top_funccal; fc != NULL; fc = fc->caller)
5673 if (set_ref_in_funccal(fc, copyID))
5674 return TRUE;
5675 return FALSE;
5676 }
5677
5678 /*
5679 * Set "copyID" in all functions available by name.
5680 */
5681 int
set_ref_in_functions(int copyID)5682 set_ref_in_functions(int copyID)
5683 {
5684 int todo;
5685 hashitem_T *hi = NULL;
5686 ufunc_T *fp;
5687
5688 todo = (int)func_hashtab.ht_used;
5689 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
5690 {
5691 if (!HASHITEM_EMPTY(hi))
5692 {
5693 --todo;
5694 fp = HI2UF(hi);
5695 if (!func_name_refcount(fp->uf_name)
5696 && set_ref_in_func(NULL, fp, copyID))
5697 return TRUE;
5698 }
5699 }
5700 return FALSE;
5701 }
5702
5703 /*
5704 * Set "copyID" in all function arguments.
5705 */
5706 int
set_ref_in_func_args(int copyID)5707 set_ref_in_func_args(int copyID)
5708 {
5709 int i;
5710
5711 for (i = 0; i < funcargs.ga_len; ++i)
5712 if (set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
5713 copyID, NULL, NULL))
5714 return TRUE;
5715 return FALSE;
5716 }
5717
5718 /*
5719 * Mark all lists and dicts referenced through function "name" with "copyID".
5720 * Returns TRUE if setting references failed somehow.
5721 */
5722 int
set_ref_in_func(char_u * name,ufunc_T * fp_in,int copyID)5723 set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
5724 {
5725 ufunc_T *fp = fp_in;
5726 funccall_T *fc;
5727 int error = FCERR_NONE;
5728 char_u fname_buf[FLEN_FIXED + 1];
5729 char_u *tofree = NULL;
5730 char_u *fname;
5731 int abort = FALSE;
5732
5733 if (name == NULL && fp_in == NULL)
5734 return FALSE;
5735
5736 if (fp_in == NULL)
5737 {
5738 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
5739 fp = find_func(fname, FALSE, NULL);
5740 }
5741 if (fp != NULL)
5742 {
5743 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
5744 abort = abort || set_ref_in_funccal(fc, copyID);
5745 }
5746
5747 vim_free(tofree);
5748 return abort;
5749 }
5750
5751 #endif // FEAT_EVAL
5752