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