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