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