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