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