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