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