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