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