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