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 // An error in a builtin function does not return FAIL, but we do 1695 // want to abort further processing if an error was given. 1696 ret = FAIL; 1697 1698 funcargs.ga_len -= i; 1699 } 1700 else if (!aborting()) 1701 { 1702 if (argcount == MAX_FUNC_ARGS) 1703 emsg_funcname(N_("E740: Too many arguments for function %s"), name); 1704 else 1705 emsg_funcname(N_("E116: Invalid arguments for function %s"), name); 1706 } 1707 1708 while (--argcount >= 0) 1709 clear_tv(&argvars[argcount]); 1710 1711 if (in_vim9script()) 1712 *arg = argp; 1713 else 1714 *arg = skipwhite(argp); 1715 return ret; 1716 } 1717 1718 /* 1719 * Return TRUE if "p" starts with "<SID>" or "s:". 1720 * Only works if eval_fname_script() returned non-zero for "p"! 1721 */ 1722 static int 1723 eval_fname_sid(char_u *p) 1724 { 1725 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I'); 1726 } 1727 1728 /* 1729 * In a script change <SID>name() and s:name() to K_SNR 123_name(). 1730 * Change <SNR>123_name() to K_SNR 123_name(). 1731 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory 1732 * (slow). 1733 */ 1734 char_u * 1735 fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error) 1736 { 1737 int llen; 1738 char_u *fname; 1739 int i; 1740 1741 llen = eval_fname_script(name); 1742 if (llen > 0) 1743 { 1744 fname_buf[0] = K_SPECIAL; 1745 fname_buf[1] = KS_EXTRA; 1746 fname_buf[2] = (int)KE_SNR; 1747 i = 3; 1748 if (eval_fname_sid(name)) // "<SID>" or "s:" 1749 { 1750 if (current_sctx.sc_sid <= 0) 1751 *error = FCERR_SCRIPT; 1752 else 1753 { 1754 sprintf((char *)fname_buf + 3, "%ld_", 1755 (long)current_sctx.sc_sid); 1756 i = (int)STRLEN(fname_buf); 1757 } 1758 } 1759 if (i + STRLEN(name + llen) < FLEN_FIXED) 1760 { 1761 STRCPY(fname_buf + i, name + llen); 1762 fname = fname_buf; 1763 } 1764 else 1765 { 1766 fname = alloc(i + STRLEN(name + llen) + 1); 1767 if (fname == NULL) 1768 *error = FCERR_OTHER; 1769 else 1770 { 1771 *tofree = fname; 1772 mch_memmove(fname, fname_buf, (size_t)i); 1773 STRCPY(fname + i, name + llen); 1774 } 1775 } 1776 } 1777 else 1778 fname = name; 1779 return fname; 1780 } 1781 1782 /* 1783 * Find a function "name" in script "sid". 1784 */ 1785 static ufunc_T * 1786 find_func_with_sid(char_u *name, int sid) 1787 { 1788 hashitem_T *hi; 1789 char_u buffer[200]; 1790 1791 buffer[0] = K_SPECIAL; 1792 buffer[1] = KS_EXTRA; 1793 buffer[2] = (int)KE_SNR; 1794 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s", 1795 (long)sid, name); 1796 hi = hash_find(&func_hashtab, buffer); 1797 if (!HASHITEM_EMPTY(hi)) 1798 return HI2UF(hi); 1799 1800 return NULL; 1801 } 1802 1803 /* 1804 * Find a function by name, return pointer to it in ufuncs. 1805 * When "is_global" is true don't find script-local or imported functions. 1806 * Return NULL for unknown function. 1807 */ 1808 ufunc_T * 1809 find_func_even_dead(char_u *name, int is_global, cctx_T *cctx) 1810 { 1811 hashitem_T *hi; 1812 ufunc_T *func; 1813 imported_T *imported; 1814 1815 if (!is_global) 1816 { 1817 char_u *after_script = NULL; 1818 long sid = 0; 1819 int find_script_local = in_vim9script() 1820 && eval_isnamec1(*name) && name[1] != ':'; 1821 1822 if (find_script_local) 1823 { 1824 // Find script-local function before global one. 1825 func = find_func_with_sid(name, current_sctx.sc_sid); 1826 if (func != NULL) 1827 return func; 1828 } 1829 1830 if (name[0] == K_SPECIAL 1831 && name[1] == KS_EXTRA 1832 && name[2] == KE_SNR) 1833 { 1834 // Caller changes s: to <SNR>99_name. 1835 1836 after_script = name + 3; 1837 sid = getdigits(&after_script); 1838 if (*after_script == '_') 1839 ++after_script; 1840 else 1841 after_script = NULL; 1842 } 1843 if (find_script_local || after_script != NULL) 1844 { 1845 // Find imported function before global one. 1846 if (after_script != NULL && sid != current_sctx.sc_sid) 1847 imported = find_imported_in_script(after_script, 0, sid); 1848 else 1849 imported = find_imported(after_script == NULL 1850 ? name : after_script, 0, cctx); 1851 if (imported != NULL && imported->imp_funcname != NULL) 1852 { 1853 hi = hash_find(&func_hashtab, imported->imp_funcname); 1854 if (!HASHITEM_EMPTY(hi)) 1855 return HI2UF(hi); 1856 } 1857 } 1858 } 1859 1860 hi = hash_find(&func_hashtab, 1861 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name); 1862 if (!HASHITEM_EMPTY(hi)) 1863 return HI2UF(hi); 1864 1865 return NULL; 1866 } 1867 1868 /* 1869 * Find a function by name, return pointer to it in ufuncs. 1870 * "cctx" is passed in a :def function to find imported functions. 1871 * Return NULL for unknown or dead function. 1872 */ 1873 ufunc_T * 1874 find_func(char_u *name, int is_global, cctx_T *cctx) 1875 { 1876 ufunc_T *fp = find_func_even_dead(name, is_global, cctx); 1877 1878 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0) 1879 return fp; 1880 return NULL; 1881 } 1882 1883 /* 1884 * Return TRUE if "ufunc" is a global function. 1885 */ 1886 int 1887 func_is_global(ufunc_T *ufunc) 1888 { 1889 return ufunc->uf_name[0] != K_SPECIAL; 1890 } 1891 1892 /* 1893 * Copy the function name of "fp" to buffer "buf". 1894 * "buf" must be able to hold the function name plus three bytes. 1895 * Takes care of script-local function names. 1896 */ 1897 static void 1898 cat_func_name(char_u *buf, ufunc_T *fp) 1899 { 1900 if (!func_is_global(fp)) 1901 { 1902 STRCPY(buf, "<SNR>"); 1903 STRCAT(buf, fp->uf_name + 3); 1904 } 1905 else 1906 STRCPY(buf, fp->uf_name); 1907 } 1908 1909 /* 1910 * Add a number variable "name" to dict "dp" with value "nr". 1911 */ 1912 static void 1913 add_nr_var( 1914 dict_T *dp, 1915 dictitem_T *v, 1916 char *name, 1917 varnumber_T nr) 1918 { 1919 STRCPY(v->di_key, name); 1920 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX; 1921 hash_add(&dp->dv_hashtab, DI2HIKEY(v)); 1922 v->di_tv.v_type = VAR_NUMBER; 1923 v->di_tv.v_lock = VAR_FIXED; 1924 v->di_tv.vval.v_number = nr; 1925 } 1926 1927 /* 1928 * Free "fc". 1929 */ 1930 static void 1931 free_funccal(funccall_T *fc) 1932 { 1933 int i; 1934 1935 for (i = 0; i < fc->fc_funcs.ga_len; ++i) 1936 { 1937 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i]; 1938 1939 // When garbage collecting a funccall_T may be freed before the 1940 // function that references it, clear its uf_scoped field. 1941 // The function may have been redefined and point to another 1942 // funccall_T, don't clear it then. 1943 if (fp != NULL && fp->uf_scoped == fc) 1944 fp->uf_scoped = NULL; 1945 } 1946 ga_clear(&fc->fc_funcs); 1947 1948 func_ptr_unref(fc->func); 1949 vim_free(fc); 1950 } 1951 1952 /* 1953 * Free "fc" and what it contains. 1954 * Can be called only when "fc" is kept beyond the period of it called, 1955 * i.e. after cleanup_function_call(fc). 1956 */ 1957 static void 1958 free_funccal_contents(funccall_T *fc) 1959 { 1960 listitem_T *li; 1961 1962 // Free all l: variables. 1963 vars_clear(&fc->l_vars.dv_hashtab); 1964 1965 // Free all a: variables. 1966 vars_clear(&fc->l_avars.dv_hashtab); 1967 1968 // Free the a:000 variables. 1969 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li) 1970 clear_tv(&li->li_tv); 1971 1972 free_funccal(fc); 1973 } 1974 1975 /* 1976 * Handle the last part of returning from a function: free the local hashtable. 1977 * Unless it is still in use by a closure. 1978 */ 1979 static void 1980 cleanup_function_call(funccall_T *fc) 1981 { 1982 int may_free_fc = fc->fc_refcount <= 0; 1983 int free_fc = TRUE; 1984 1985 current_funccal = fc->caller; 1986 1987 // Free all l: variables if not referred. 1988 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT) 1989 vars_clear(&fc->l_vars.dv_hashtab); 1990 else 1991 free_fc = FALSE; 1992 1993 // If the a:000 list and the l: and a: dicts are not referenced and 1994 // there is no closure using it, we can free the funccall_T and what's 1995 // in it. 1996 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT) 1997 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE); 1998 else 1999 { 2000 int todo; 2001 hashitem_T *hi; 2002 dictitem_T *di; 2003 2004 free_fc = FALSE; 2005 2006 // Make a copy of the a: variables, since we didn't do that above. 2007 todo = (int)fc->l_avars.dv_hashtab.ht_used; 2008 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi) 2009 { 2010 if (!HASHITEM_EMPTY(hi)) 2011 { 2012 --todo; 2013 di = HI2DI(hi); 2014 copy_tv(&di->di_tv, &di->di_tv); 2015 } 2016 } 2017 } 2018 2019 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT) 2020 fc->l_varlist.lv_first = NULL; 2021 else 2022 { 2023 listitem_T *li; 2024 2025 free_fc = FALSE; 2026 2027 // Make a copy of the a:000 items, since we didn't do that above. 2028 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li) 2029 copy_tv(&li->li_tv, &li->li_tv); 2030 } 2031 2032 if (free_fc) 2033 free_funccal(fc); 2034 else 2035 { 2036 static int made_copy = 0; 2037 2038 // "fc" is still in use. This can happen when returning "a:000", 2039 // assigning "l:" to a global variable or defining a closure. 2040 // Link "fc" in the list for garbage collection later. 2041 fc->caller = previous_funccal; 2042 previous_funccal = fc; 2043 2044 if (want_garbage_collect) 2045 // If garbage collector is ready, clear count. 2046 made_copy = 0; 2047 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc))) 2048 { 2049 // We have made a lot of copies, worth 4 Mbyte. This can happen 2050 // when repetitively calling a function that creates a reference to 2051 // itself somehow. Call the garbage collector soon to avoid using 2052 // too much memory. 2053 made_copy = 0; 2054 want_garbage_collect = TRUE; 2055 } 2056 } 2057 } 2058 2059 /* 2060 * There are two kinds of function names: 2061 * 1. ordinary names, function defined with :function or :def 2062 * 2. numbered functions and lambdas 2063 * For the first we only count the name stored in func_hashtab as a reference, 2064 * using function() does not count as a reference, because the function is 2065 * looked up by name. 2066 */ 2067 int 2068 func_name_refcount(char_u *name) 2069 { 2070 return isdigit(*name) || *name == '<'; 2071 } 2072 2073 /* 2074 * Unreference "fc": decrement the reference count and free it when it 2075 * becomes zero. "fp" is detached from "fc". 2076 * When "force" is TRUE we are exiting. 2077 */ 2078 static void 2079 funccal_unref(funccall_T *fc, ufunc_T *fp, int force) 2080 { 2081 funccall_T **pfc; 2082 int i; 2083 2084 if (fc == NULL) 2085 return; 2086 2087 if (--fc->fc_refcount <= 0 && (force || ( 2088 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT 2089 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT 2090 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT))) 2091 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller) 2092 { 2093 if (fc == *pfc) 2094 { 2095 *pfc = fc->caller; 2096 free_funccal_contents(fc); 2097 return; 2098 } 2099 } 2100 for (i = 0; i < fc->fc_funcs.ga_len; ++i) 2101 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp) 2102 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL; 2103 } 2104 2105 /* 2106 * Remove the function from the function hashtable. If the function was 2107 * deleted while it still has references this was already done. 2108 * Return TRUE if the entry was deleted, FALSE if it wasn't found. 2109 */ 2110 static int 2111 func_remove(ufunc_T *fp) 2112 { 2113 hashitem_T *hi; 2114 2115 // Return if it was already virtually deleted. 2116 if (fp->uf_flags & FC_DEAD) 2117 return FALSE; 2118 2119 hi = hash_find(&func_hashtab, UF2HIKEY(fp)); 2120 if (!HASHITEM_EMPTY(hi)) 2121 { 2122 // When there is a def-function index do not actually remove the 2123 // function, so we can find the index when defining the function again. 2124 // Do remove it when it's a copy. 2125 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0) 2126 { 2127 fp->uf_flags |= FC_DEAD; 2128 return FALSE; 2129 } 2130 hash_remove(&func_hashtab, hi); 2131 fp->uf_flags |= FC_DELETED; 2132 return TRUE; 2133 } 2134 return FALSE; 2135 } 2136 2137 static void 2138 func_clear_items(ufunc_T *fp) 2139 { 2140 ga_clear_strings(&(fp->uf_args)); 2141 ga_clear_strings(&(fp->uf_def_args)); 2142 ga_clear_strings(&(fp->uf_lines)); 2143 VIM_CLEAR(fp->uf_arg_types); 2144 VIM_CLEAR(fp->uf_block_ids); 2145 VIM_CLEAR(fp->uf_va_name); 2146 clear_type_list(&fp->uf_type_list); 2147 2148 // Increment the refcount of this function to avoid it being freed 2149 // recursively when the partial is freed. 2150 fp->uf_refcount += 3; 2151 partial_unref(fp->uf_partial); 2152 fp->uf_partial = NULL; 2153 fp->uf_refcount -= 3; 2154 2155 #ifdef FEAT_LUA 2156 if (fp->uf_cb_free != NULL) 2157 { 2158 fp->uf_cb_free(fp->uf_cb_state); 2159 fp->uf_cb_free = NULL; 2160 } 2161 2162 fp->uf_cb_state = NULL; 2163 fp->uf_cb = NULL; 2164 #endif 2165 #ifdef FEAT_PROFILE 2166 VIM_CLEAR(fp->uf_tml_count); 2167 VIM_CLEAR(fp->uf_tml_total); 2168 VIM_CLEAR(fp->uf_tml_self); 2169 #endif 2170 } 2171 2172 /* 2173 * Free all things that a function contains. Does not free the function 2174 * itself, use func_free() for that. 2175 * When "force" is TRUE we are exiting. 2176 */ 2177 static void 2178 func_clear(ufunc_T *fp, int force) 2179 { 2180 if (fp->uf_cleared) 2181 return; 2182 fp->uf_cleared = TRUE; 2183 2184 // clear this function 2185 func_clear_items(fp); 2186 funccal_unref(fp->uf_scoped, fp, force); 2187 unlink_def_function(fp); 2188 } 2189 2190 /* 2191 * Free a function and remove it from the list of functions. Does not free 2192 * what a function contains, call func_clear() first. 2193 * When "force" is TRUE we are exiting. 2194 * Returns OK when the function was actually freed. 2195 */ 2196 static int 2197 func_free(ufunc_T *fp, int force) 2198 { 2199 // Only remove it when not done already, otherwise we would remove a newer 2200 // version of the function with the same name. 2201 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0) 2202 func_remove(fp); 2203 2204 if ((fp->uf_flags & FC_DEAD) == 0 || force) 2205 { 2206 if (fp->uf_dfunc_idx > 0) 2207 unlink_def_function(fp); 2208 VIM_CLEAR(fp->uf_name_exp); 2209 vim_free(fp); 2210 return OK; 2211 } 2212 return FAIL; 2213 } 2214 2215 /* 2216 * Free all things that a function contains and free the function itself. 2217 * When "force" is TRUE we are exiting. 2218 */ 2219 static void 2220 func_clear_free(ufunc_T *fp, int force) 2221 { 2222 func_clear(fp, force); 2223 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name) 2224 || (fp->uf_flags & FC_COPY)) 2225 func_free(fp, force); 2226 else 2227 fp->uf_flags |= FC_DEAD; 2228 } 2229 2230 /* 2231 * Copy already defined function "lambda" to a new function with name "global". 2232 * This is for when a compiled function defines a global function. 2233 */ 2234 int 2235 copy_func(char_u *lambda, char_u *global, ectx_T *ectx) 2236 { 2237 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL); 2238 ufunc_T *fp = NULL; 2239 2240 if (ufunc == NULL) 2241 { 2242 semsg(_(e_lambda_function_not_found_str), lambda); 2243 return FAIL; 2244 } 2245 2246 fp = find_func(global, TRUE, NULL); 2247 if (fp != NULL) 2248 { 2249 // TODO: handle ! to overwrite 2250 semsg(_(e_funcexts), global); 2251 return FAIL; 2252 } 2253 2254 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1); 2255 if (fp == NULL) 2256 return FAIL; 2257 2258 fp->uf_varargs = ufunc->uf_varargs; 2259 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY; 2260 fp->uf_def_status = ufunc->uf_def_status; 2261 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx; 2262 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL 2263 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args) 2264 == FAIL 2265 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL) 2266 goto failed; 2267 2268 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL 2269 : vim_strsave(ufunc->uf_name_exp); 2270 if (ufunc->uf_arg_types != NULL) 2271 { 2272 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len); 2273 if (fp->uf_arg_types == NULL) 2274 goto failed; 2275 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types, 2276 sizeof(type_T *) * fp->uf_args.ga_len); 2277 } 2278 if (ufunc->uf_va_name != NULL) 2279 { 2280 fp->uf_va_name = vim_strsave(ufunc->uf_va_name); 2281 if (fp->uf_va_name == NULL) 2282 goto failed; 2283 } 2284 fp->uf_ret_type = ufunc->uf_ret_type; 2285 2286 fp->uf_refcount = 1; 2287 STRCPY(fp->uf_name, global); 2288 hash_add(&func_hashtab, UF2HIKEY(fp)); 2289 2290 // the referenced dfunc_T is now used one more time 2291 link_def_function(fp); 2292 2293 // Create a partial to store the context of the function where it was 2294 // instantiated. Only needs to be done once. Do this on the original 2295 // function, "dfunc->df_ufunc" will point to it. 2296 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL) 2297 { 2298 partial_T *pt = ALLOC_CLEAR_ONE(partial_T); 2299 2300 if (pt == NULL) 2301 goto failed; 2302 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL) 2303 { 2304 vim_free(pt); 2305 goto failed; 2306 } 2307 ufunc->uf_partial = pt; 2308 --pt->pt_refcount; // not actually referenced here 2309 } 2310 2311 return OK; 2312 2313 failed: 2314 func_clear_free(fp, TRUE); 2315 return FAIL; 2316 } 2317 2318 static int funcdepth = 0; 2319 2320 /* 2321 * Increment the function call depth count. 2322 * Return FAIL when going over 'maxfuncdepth'. 2323 * Otherwise return OK, must call funcdepth_decrement() later! 2324 */ 2325 int 2326 funcdepth_increment(void) 2327 { 2328 if (funcdepth >= p_mfd) 2329 { 2330 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'")); 2331 return FAIL; 2332 } 2333 ++funcdepth; 2334 return OK; 2335 } 2336 2337 void 2338 funcdepth_decrement(void) 2339 { 2340 --funcdepth; 2341 } 2342 2343 /* 2344 * Get the current function call depth. 2345 */ 2346 int 2347 funcdepth_get(void) 2348 { 2349 return funcdepth; 2350 } 2351 2352 /* 2353 * Restore the function call depth. This is for cases where there is no 2354 * guarantee funcdepth_decrement() can be called exactly the same number of 2355 * times as funcdepth_increment(). 2356 */ 2357 void 2358 funcdepth_restore(int depth) 2359 { 2360 funcdepth = depth; 2361 } 2362 2363 /* 2364 * Call a user function. 2365 */ 2366 static void 2367 call_user_func( 2368 ufunc_T *fp, // pointer to function 2369 int argcount, // nr of args 2370 typval_T *argvars, // arguments 2371 typval_T *rettv, // return value 2372 funcexe_T *funcexe, // context 2373 dict_T *selfdict) // Dictionary for "self" 2374 { 2375 sctx_T save_current_sctx; 2376 int using_sandbox = FALSE; 2377 funccall_T *fc; 2378 int save_did_emsg; 2379 int default_arg_err = FALSE; 2380 dictitem_T *v; 2381 int fixvar_idx = 0; // index in fixvar[] 2382 int i; 2383 int ai; 2384 int islambda = FALSE; 2385 char_u numbuf[NUMBUFLEN]; 2386 char_u *name; 2387 typval_T *tv_to_free[MAX_FUNC_ARGS]; 2388 int tv_to_free_len = 0; 2389 #ifdef FEAT_PROFILE 2390 profinfo_T profile_info; 2391 #endif 2392 ESTACK_CHECK_DECLARATION 2393 2394 #ifdef FEAT_PROFILE 2395 CLEAR_FIELD(profile_info); 2396 #endif 2397 2398 // If depth of calling is getting too high, don't execute the function. 2399 if (funcdepth_increment() == FAIL) 2400 { 2401 rettv->v_type = VAR_NUMBER; 2402 rettv->vval.v_number = -1; 2403 return; 2404 } 2405 2406 line_breakcheck(); // check for CTRL-C hit 2407 2408 fc = ALLOC_CLEAR_ONE(funccall_T); 2409 if (fc == NULL) 2410 return; 2411 fc->caller = current_funccal; 2412 current_funccal = fc; 2413 fc->func = fp; 2414 fc->rettv = rettv; 2415 fc->level = ex_nesting_level; 2416 // Check if this function has a breakpoint. 2417 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0); 2418 fc->dbg_tick = debug_tick; 2419 // Set up fields for closure. 2420 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1); 2421 func_ptr_ref(fp); 2422 2423 if (fp->uf_def_status != UF_NOT_COMPILED) 2424 { 2425 #ifdef FEAT_PROFILE 2426 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func; 2427 #endif 2428 // Execute the function, possibly compiling it first. 2429 #ifdef FEAT_PROFILE 2430 if (do_profiling == PROF_YES) 2431 profile_may_start_func(&profile_info, fp, caller); 2432 #endif 2433 call_def_function(fp, argcount, argvars, funcexe->partial, rettv); 2434 funcdepth_decrement(); 2435 #ifdef FEAT_PROFILE 2436 if (do_profiling == PROF_YES && (fp->uf_profiling 2437 || (caller != NULL && caller->uf_profiling))) 2438 profile_may_end_func(&profile_info, fp, caller); 2439 #endif 2440 current_funccal = fc->caller; 2441 free_funccal(fc); 2442 return; 2443 } 2444 2445 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0) 2446 islambda = TRUE; 2447 2448 /* 2449 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables 2450 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free 2451 * each argument variable and saves a lot of time. 2452 */ 2453 /* 2454 * Init l: variables. 2455 */ 2456 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE); 2457 if (selfdict != NULL) 2458 { 2459 // Set l:self to "selfdict". Use "name" to avoid a warning from 2460 // some compiler that checks the destination size. 2461 v = &fc->fixvar[fixvar_idx++].var; 2462 name = v->di_key; 2463 STRCPY(name, "self"); 2464 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX; 2465 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v)); 2466 v->di_tv.v_type = VAR_DICT; 2467 v->di_tv.v_lock = 0; 2468 v->di_tv.vval.v_dict = selfdict; 2469 ++selfdict->dv_refcount; 2470 } 2471 2472 /* 2473 * Init a: variables, unless none found (in lambda). 2474 * Set a:0 to "argcount" less number of named arguments, if >= 0. 2475 * Set a:000 to a list with room for the "..." arguments. 2476 */ 2477 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE); 2478 if ((fp->uf_flags & FC_NOARGS) == 0) 2479 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0", 2480 (varnumber_T)(argcount >= fp->uf_args.ga_len 2481 ? argcount - fp->uf_args.ga_len : 0)); 2482 fc->l_avars.dv_lock = VAR_FIXED; 2483 if ((fp->uf_flags & FC_NOARGS) == 0) 2484 { 2485 // Use "name" to avoid a warning from some compiler that checks the 2486 // destination size. 2487 v = &fc->fixvar[fixvar_idx++].var; 2488 name = v->di_key; 2489 STRCPY(name, "000"); 2490 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX; 2491 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v)); 2492 v->di_tv.v_type = VAR_LIST; 2493 v->di_tv.v_lock = VAR_FIXED; 2494 v->di_tv.vval.v_list = &fc->l_varlist; 2495 } 2496 CLEAR_FIELD(fc->l_varlist); 2497 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT; 2498 fc->l_varlist.lv_lock = VAR_FIXED; 2499 2500 /* 2501 * Set a:firstline to "firstline" and a:lastline to "lastline". 2502 * Set a:name to named arguments. 2503 * Set a:N to the "..." arguments. 2504 * Skipped when no a: variables used (in lambda). 2505 */ 2506 if ((fp->uf_flags & FC_NOARGS) == 0) 2507 { 2508 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline", 2509 (varnumber_T)funcexe->firstline); 2510 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline", 2511 (varnumber_T)funcexe->lastline); 2512 } 2513 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i) 2514 { 2515 int addlocal = FALSE; 2516 typval_T def_rettv; 2517 int isdefault = FALSE; 2518 2519 ai = i - fp->uf_args.ga_len; 2520 if (ai < 0) 2521 { 2522 // named argument a:name 2523 name = FUNCARG(fp, i); 2524 if (islambda) 2525 addlocal = TRUE; 2526 2527 // evaluate named argument default expression 2528 isdefault = ai + fp->uf_def_args.ga_len >= 0 2529 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL 2530 && argvars[i].vval.v_number == VVAL_NONE)); 2531 if (isdefault) 2532 { 2533 char_u *default_expr = NULL; 2534 2535 def_rettv.v_type = VAR_NUMBER; 2536 def_rettv.vval.v_number = -1; 2537 2538 default_expr = ((char_u **)(fp->uf_def_args.ga_data)) 2539 [ai + fp->uf_def_args.ga_len]; 2540 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL) 2541 { 2542 default_arg_err = 1; 2543 break; 2544 } 2545 } 2546 } 2547 else 2548 { 2549 if ((fp->uf_flags & FC_NOARGS) != 0) 2550 // Bail out if no a: arguments used (in lambda). 2551 break; 2552 2553 // "..." argument a:1, a:2, etc. 2554 sprintf((char *)numbuf, "%d", ai + 1); 2555 name = numbuf; 2556 } 2557 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN) 2558 { 2559 v = &fc->fixvar[fixvar_idx++].var; 2560 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX; 2561 STRCPY(v->di_key, name); 2562 } 2563 else 2564 { 2565 v = dictitem_alloc(name); 2566 if (v == NULL) 2567 break; 2568 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX; 2569 } 2570 2571 // Note: the values are copied directly to avoid alloc/free. 2572 // "argvars" must have VAR_FIXED for v_lock. 2573 v->di_tv = isdefault ? def_rettv : argvars[i]; 2574 v->di_tv.v_lock = VAR_FIXED; 2575 2576 if (isdefault) 2577 // Need to free this later, no matter where it's stored. 2578 tv_to_free[tv_to_free_len++] = &v->di_tv; 2579 2580 if (addlocal) 2581 { 2582 // Named arguments should be accessed without the "a:" prefix in 2583 // lambda expressions. Add to the l: dict. 2584 copy_tv(&v->di_tv, &v->di_tv); 2585 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v)); 2586 } 2587 else 2588 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v)); 2589 2590 if (ai >= 0 && ai < MAX_FUNC_ARGS) 2591 { 2592 listitem_T *li = &fc->l_listitems[ai]; 2593 2594 li->li_tv = argvars[i]; 2595 li->li_tv.v_lock = VAR_FIXED; 2596 list_append(&fc->l_varlist, li); 2597 } 2598 } 2599 2600 // Don't redraw while executing the function. 2601 ++RedrawingDisabled; 2602 2603 if (fp->uf_flags & FC_SANDBOX) 2604 { 2605 using_sandbox = TRUE; 2606 ++sandbox; 2607 } 2608 2609 estack_push_ufunc(fp, 1); 2610 ESTACK_CHECK_SETUP 2611 if (p_verbose >= 12) 2612 { 2613 ++no_wait_return; 2614 verbose_enter_scroll(); 2615 2616 smsg(_("calling %s"), SOURCING_NAME); 2617 if (p_verbose >= 14) 2618 { 2619 char_u buf[MSG_BUF_LEN]; 2620 char_u numbuf2[NUMBUFLEN]; 2621 char_u *tofree; 2622 char_u *s; 2623 2624 msg_puts("("); 2625 for (i = 0; i < argcount; ++i) 2626 { 2627 if (i > 0) 2628 msg_puts(", "); 2629 if (argvars[i].v_type == VAR_NUMBER) 2630 msg_outnum((long)argvars[i].vval.v_number); 2631 else 2632 { 2633 // Do not want errors such as E724 here. 2634 ++emsg_off; 2635 s = tv2string(&argvars[i], &tofree, numbuf2, 0); 2636 --emsg_off; 2637 if (s != NULL) 2638 { 2639 if (vim_strsize(s) > MSG_BUF_CLEN) 2640 { 2641 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN); 2642 s = buf; 2643 } 2644 msg_puts((char *)s); 2645 vim_free(tofree); 2646 } 2647 } 2648 } 2649 msg_puts(")"); 2650 } 2651 msg_puts("\n"); // don't overwrite this either 2652 2653 verbose_leave_scroll(); 2654 --no_wait_return; 2655 } 2656 #ifdef FEAT_PROFILE 2657 if (do_profiling == PROF_YES) 2658 profile_may_start_func(&profile_info, fp, 2659 fc->caller == NULL ? NULL : fc->caller->func); 2660 #endif 2661 2662 save_current_sctx = current_sctx; 2663 current_sctx = fp->uf_script_ctx; 2664 save_did_emsg = did_emsg; 2665 did_emsg = FALSE; 2666 2667 if (default_arg_err && (fp->uf_flags & FC_ABORT)) 2668 did_emsg = TRUE; 2669 else if (islambda) 2670 { 2671 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7; 2672 2673 // A Lambda always has the command "return {expr}". It is much faster 2674 // to evaluate {expr} directly. 2675 ++ex_nesting_level; 2676 (void)eval1(&p, rettv, &EVALARG_EVALUATE); 2677 --ex_nesting_level; 2678 } 2679 else 2680 // call do_cmdline() to execute the lines 2681 do_cmdline(NULL, get_func_line, (void *)fc, 2682 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT); 2683 2684 --RedrawingDisabled; 2685 2686 // when the function was aborted because of an error, return -1 2687 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN) 2688 { 2689 clear_tv(rettv); 2690 rettv->v_type = VAR_NUMBER; 2691 rettv->vval.v_number = -1; 2692 } 2693 2694 #ifdef FEAT_PROFILE 2695 if (do_profiling == PROF_YES) 2696 { 2697 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func; 2698 2699 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling)) 2700 profile_may_end_func(&profile_info, fp, caller); 2701 } 2702 #endif 2703 2704 // when being verbose, mention the return value 2705 if (p_verbose >= 12) 2706 { 2707 ++no_wait_return; 2708 verbose_enter_scroll(); 2709 2710 if (aborting()) 2711 smsg(_("%s aborted"), SOURCING_NAME); 2712 else if (fc->rettv->v_type == VAR_NUMBER) 2713 smsg(_("%s returning #%ld"), SOURCING_NAME, 2714 (long)fc->rettv->vval.v_number); 2715 else 2716 { 2717 char_u buf[MSG_BUF_LEN]; 2718 char_u numbuf2[NUMBUFLEN]; 2719 char_u *tofree; 2720 char_u *s; 2721 2722 // The value may be very long. Skip the middle part, so that we 2723 // have some idea how it starts and ends. smsg() would always 2724 // truncate it at the end. Don't want errors such as E724 here. 2725 ++emsg_off; 2726 s = tv2string(fc->rettv, &tofree, numbuf2, 0); 2727 --emsg_off; 2728 if (s != NULL) 2729 { 2730 if (vim_strsize(s) > MSG_BUF_CLEN) 2731 { 2732 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN); 2733 s = buf; 2734 } 2735 smsg(_("%s returning %s"), SOURCING_NAME, s); 2736 vim_free(tofree); 2737 } 2738 } 2739 msg_puts("\n"); // don't overwrite this either 2740 2741 verbose_leave_scroll(); 2742 --no_wait_return; 2743 } 2744 2745 ESTACK_CHECK_NOW 2746 estack_pop(); 2747 current_sctx = save_current_sctx; 2748 #ifdef FEAT_PROFILE 2749 if (do_profiling == PROF_YES) 2750 script_prof_restore(&profile_info.pi_wait_start); 2751 #endif 2752 if (using_sandbox) 2753 --sandbox; 2754 2755 if (p_verbose >= 12 && SOURCING_NAME != NULL) 2756 { 2757 ++no_wait_return; 2758 verbose_enter_scroll(); 2759 2760 smsg(_("continuing in %s"), SOURCING_NAME); 2761 msg_puts("\n"); // don't overwrite this either 2762 2763 verbose_leave_scroll(); 2764 --no_wait_return; 2765 } 2766 2767 did_emsg |= save_did_emsg; 2768 funcdepth_decrement(); 2769 for (i = 0; i < tv_to_free_len; ++i) 2770 clear_tv(tv_to_free[i]); 2771 cleanup_function_call(fc); 2772 } 2773 2774 /* 2775 * Check the argument count for user function "fp". 2776 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise. 2777 */ 2778 int 2779 check_user_func_argcount(ufunc_T *fp, int argcount) 2780 { 2781 int regular_args = fp->uf_args.ga_len; 2782 2783 if (argcount < regular_args - fp->uf_def_args.ga_len) 2784 return FCERR_TOOFEW; 2785 else if (!has_varargs(fp) && argcount > regular_args) 2786 return FCERR_TOOMANY; 2787 return FCERR_UNKNOWN; 2788 } 2789 2790 /* 2791 * Call a user function after checking the arguments. 2792 */ 2793 int 2794 call_user_func_check( 2795 ufunc_T *fp, 2796 int argcount, 2797 typval_T *argvars, 2798 typval_T *rettv, 2799 funcexe_T *funcexe, 2800 dict_T *selfdict) 2801 { 2802 int error; 2803 2804 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL) 2805 *funcexe->doesrange = TRUE; 2806 error = check_user_func_argcount(fp, argcount); 2807 if (error != FCERR_UNKNOWN) 2808 return error; 2809 if ((fp->uf_flags & FC_DICT) && selfdict == NULL) 2810 error = FCERR_DICT; 2811 else 2812 { 2813 int did_save_redo = FALSE; 2814 save_redo_T save_redo; 2815 2816 /* 2817 * Call the user function. 2818 * Save and restore search patterns, script variables and 2819 * redo buffer. 2820 */ 2821 save_search_patterns(); 2822 if (!ins_compl_active()) 2823 { 2824 saveRedobuff(&save_redo); 2825 did_save_redo = TRUE; 2826 } 2827 ++fp->uf_calls; 2828 call_user_func(fp, argcount, argvars, rettv, funcexe, 2829 (fp->uf_flags & FC_DICT) ? selfdict : NULL); 2830 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0) 2831 // Function was unreferenced while being used, free it now. 2832 func_clear_free(fp, FALSE); 2833 if (did_save_redo) 2834 restoreRedobuff(&save_redo); 2835 restore_search_patterns(); 2836 error = FCERR_NONE; 2837 } 2838 return error; 2839 } 2840 2841 static funccal_entry_T *funccal_stack = NULL; 2842 2843 /* 2844 * Save the current function call pointer, and set it to NULL. 2845 * Used when executing autocommands and for ":source". 2846 */ 2847 void 2848 save_funccal(funccal_entry_T *entry) 2849 { 2850 entry->top_funccal = current_funccal; 2851 entry->next = funccal_stack; 2852 funccal_stack = entry; 2853 current_funccal = NULL; 2854 } 2855 2856 void 2857 restore_funccal(void) 2858 { 2859 if (funccal_stack == NULL) 2860 iemsg("INTERNAL: restore_funccal()"); 2861 else 2862 { 2863 current_funccal = funccal_stack->top_funccal; 2864 funccal_stack = funccal_stack->next; 2865 } 2866 } 2867 2868 funccall_T * 2869 get_current_funccal(void) 2870 { 2871 return current_funccal; 2872 } 2873 2874 /* 2875 * Mark all functions of script "sid" as deleted. 2876 */ 2877 void 2878 delete_script_functions(int sid) 2879 { 2880 hashitem_T *hi; 2881 ufunc_T *fp; 2882 long_u todo = 1; 2883 char_u buf[30]; 2884 size_t len; 2885 2886 buf[0] = K_SPECIAL; 2887 buf[1] = KS_EXTRA; 2888 buf[2] = (int)KE_SNR; 2889 sprintf((char *)buf + 3, "%d_", sid); 2890 len = STRLEN(buf); 2891 2892 while (todo > 0) 2893 { 2894 todo = func_hashtab.ht_used; 2895 for (hi = func_hashtab.ht_array; todo > 0; ++hi) 2896 if (!HASHITEM_EMPTY(hi)) 2897 { 2898 fp = HI2UF(hi); 2899 if (STRNCMP(fp->uf_name, buf, len) == 0) 2900 { 2901 int changed = func_hashtab.ht_changed; 2902 2903 fp->uf_flags |= FC_DEAD; 2904 2905 if (fp->uf_calls > 0) 2906 { 2907 // Function is executing, don't free it but do remove 2908 // it from the hashtable. 2909 if (func_remove(fp)) 2910 fp->uf_refcount--; 2911 } 2912 else 2913 { 2914 func_clear(fp, TRUE); 2915 // When clearing a function another function can be 2916 // cleared as a side effect. When that happens start 2917 // over. 2918 if (changed != func_hashtab.ht_changed) 2919 break; 2920 } 2921 } 2922 --todo; 2923 } 2924 } 2925 } 2926 2927 #if defined(EXITFREE) || defined(PROTO) 2928 void 2929 free_all_functions(void) 2930 { 2931 hashitem_T *hi; 2932 ufunc_T *fp; 2933 long_u skipped = 0; 2934 long_u todo = 1; 2935 int changed; 2936 2937 // Clean up the current_funccal chain and the funccal stack. 2938 while (current_funccal != NULL) 2939 { 2940 clear_tv(current_funccal->rettv); 2941 cleanup_function_call(current_funccal); 2942 if (current_funccal == NULL && funccal_stack != NULL) 2943 restore_funccal(); 2944 } 2945 2946 // First clear what the functions contain. Since this may lower the 2947 // reference count of a function, it may also free a function and change 2948 // the hash table. Restart if that happens. 2949 while (todo > 0) 2950 { 2951 todo = func_hashtab.ht_used; 2952 for (hi = func_hashtab.ht_array; todo > 0; ++hi) 2953 if (!HASHITEM_EMPTY(hi)) 2954 { 2955 // clear the def function index now 2956 fp = HI2UF(hi); 2957 fp->uf_flags &= ~FC_DEAD; 2958 fp->uf_def_status = UF_NOT_COMPILED; 2959 2960 // Only free functions that are not refcounted, those are 2961 // supposed to be freed when no longer referenced. 2962 if (func_name_refcount(fp->uf_name)) 2963 ++skipped; 2964 else 2965 { 2966 changed = func_hashtab.ht_changed; 2967 func_clear(fp, TRUE); 2968 if (changed != func_hashtab.ht_changed) 2969 { 2970 skipped = 0; 2971 break; 2972 } 2973 } 2974 --todo; 2975 } 2976 } 2977 2978 // Now actually free the functions. Need to start all over every time, 2979 // because func_free() may change the hash table. 2980 skipped = 0; 2981 while (func_hashtab.ht_used > skipped) 2982 { 2983 todo = func_hashtab.ht_used; 2984 for (hi = func_hashtab.ht_array; todo > 0; ++hi) 2985 if (!HASHITEM_EMPTY(hi)) 2986 { 2987 --todo; 2988 // Only free functions that are not refcounted, those are 2989 // supposed to be freed when no longer referenced. 2990 fp = HI2UF(hi); 2991 if (func_name_refcount(fp->uf_name)) 2992 ++skipped; 2993 else 2994 { 2995 if (func_free(fp, FALSE) == OK) 2996 { 2997 skipped = 0; 2998 break; 2999 } 3000 // did not actually free it 3001 ++skipped; 3002 } 3003 } 3004 } 3005 if (skipped == 0) 3006 hash_clear(&func_hashtab); 3007 3008 free_def_functions(); 3009 } 3010 #endif 3011 3012 /* 3013 * Return TRUE if "name" looks like a builtin function name: starts with a 3014 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'. 3015 * "len" is the length of "name", or -1 for NUL terminated. 3016 */ 3017 int 3018 builtin_function(char_u *name, int len) 3019 { 3020 char_u *p; 3021 3022 if (!ASCII_ISLOWER(name[0]) || name[1] == ':') 3023 return FALSE; 3024 p = vim_strchr(name, AUTOLOAD_CHAR); 3025 return p == NULL || (len > 0 && p > name + len); 3026 } 3027 3028 int 3029 func_call( 3030 char_u *name, 3031 typval_T *args, 3032 partial_T *partial, 3033 dict_T *selfdict, 3034 typval_T *rettv) 3035 { 3036 list_T *l = args->vval.v_list; 3037 listitem_T *item; 3038 typval_T argv[MAX_FUNC_ARGS + 1]; 3039 int argc = 0; 3040 int r = 0; 3041 3042 CHECK_LIST_MATERIALIZE(l); 3043 FOR_ALL_LIST_ITEMS(l, item) 3044 { 3045 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc)) 3046 { 3047 emsg(_("E699: Too many arguments")); 3048 break; 3049 } 3050 // Make a copy of each argument. This is needed to be able to set 3051 // v_lock to VAR_FIXED in the copy without changing the original list. 3052 copy_tv(&item->li_tv, &argv[argc++]); 3053 } 3054 3055 if (item == NULL) 3056 { 3057 funcexe_T funcexe; 3058 3059 CLEAR_FIELD(funcexe); 3060 funcexe.firstline = curwin->w_cursor.lnum; 3061 funcexe.lastline = curwin->w_cursor.lnum; 3062 funcexe.evaluate = TRUE; 3063 funcexe.partial = partial; 3064 funcexe.selfdict = selfdict; 3065 r = call_func(name, -1, rettv, argc, argv, &funcexe); 3066 } 3067 3068 // Free the arguments. 3069 while (argc > 0) 3070 clear_tv(&argv[--argc]); 3071 3072 return r; 3073 } 3074 3075 static int callback_depth = 0; 3076 3077 int 3078 get_callback_depth(void) 3079 { 3080 return callback_depth; 3081 } 3082 3083 /* 3084 * Invoke call_func() with a callback. 3085 */ 3086 int 3087 call_callback( 3088 callback_T *callback, 3089 int len, // length of "name" or -1 to use strlen() 3090 typval_T *rettv, // return value goes here 3091 int argcount, // number of "argvars" 3092 typval_T *argvars) // vars for arguments, must have "argcount" 3093 // PLUS ONE elements! 3094 { 3095 funcexe_T funcexe; 3096 int ret; 3097 3098 CLEAR_FIELD(funcexe); 3099 funcexe.evaluate = TRUE; 3100 funcexe.partial = callback->cb_partial; 3101 ++callback_depth; 3102 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe); 3103 --callback_depth; 3104 return ret; 3105 } 3106 3107 /* 3108 * Give an error message for the result of a function. 3109 * Nothing if "error" is FCERR_NONE. 3110 */ 3111 void 3112 user_func_error(int error, char_u *name) 3113 { 3114 switch (error) 3115 { 3116 case FCERR_UNKNOWN: 3117 emsg_funcname(e_unknownfunc, name); 3118 break; 3119 case FCERR_NOTMETHOD: 3120 emsg_funcname( 3121 N_("E276: Cannot use function as a method: %s"), name); 3122 break; 3123 case FCERR_DELETED: 3124 emsg_funcname(N_(e_func_deleted), name); 3125 break; 3126 case FCERR_TOOMANY: 3127 emsg_funcname((char *)e_toomanyarg, name); 3128 break; 3129 case FCERR_TOOFEW: 3130 emsg_funcname((char *)e_toofewarg, name); 3131 break; 3132 case FCERR_SCRIPT: 3133 emsg_funcname( 3134 N_("E120: Using <SID> not in a script context: %s"), name); 3135 break; 3136 case FCERR_DICT: 3137 emsg_funcname( 3138 N_("E725: Calling dict function without Dictionary: %s"), 3139 name); 3140 break; 3141 } 3142 } 3143 3144 /* 3145 * Call a function with its resolved parameters 3146 * 3147 * Return FAIL when the function can't be called, OK otherwise. 3148 * Also returns OK when an error was encountered while executing the function. 3149 */ 3150 int 3151 call_func( 3152 char_u *funcname, // name of the function 3153 int len, // length of "name" or -1 to use strlen() 3154 typval_T *rettv, // return value goes here 3155 int argcount_in, // number of "argvars" 3156 typval_T *argvars_in, // vars for arguments, must have "argcount" 3157 // PLUS ONE elements! 3158 funcexe_T *funcexe) // more arguments 3159 { 3160 int ret = FAIL; 3161 int error = FCERR_NONE; 3162 int i; 3163 ufunc_T *fp = NULL; 3164 char_u fname_buf[FLEN_FIXED + 1]; 3165 char_u *tofree = NULL; 3166 char_u *fname = NULL; 3167 char_u *name = NULL; 3168 int argcount = argcount_in; 3169 typval_T *argvars = argvars_in; 3170 dict_T *selfdict = funcexe->selfdict; 3171 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or 3172 // "funcexe->basetv" is not NULL 3173 int argv_clear = 0; 3174 int argv_base = 0; 3175 partial_T *partial = funcexe->partial; 3176 type_T check_type; 3177 3178 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv) 3179 // even when call_func() returns FAIL. 3180 rettv->v_type = VAR_UNKNOWN; 3181 3182 if (partial != NULL) 3183 fp = partial->pt_func; 3184 if (fp == NULL) 3185 { 3186 // Make a copy of the name, if it comes from a funcref variable it 3187 // could be changed or deleted in the called function. 3188 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname); 3189 if (name == NULL) 3190 return ret; 3191 3192 fname = fname_trans_sid(name, fname_buf, &tofree, &error); 3193 } 3194 3195 if (funcexe->doesrange != NULL) 3196 *funcexe->doesrange = FALSE; 3197 3198 if (partial != NULL) 3199 { 3200 // When the function has a partial with a dict and there is a dict 3201 // argument, use the dict argument. That is backwards compatible. 3202 // When the dict was bound explicitly use the one from the partial. 3203 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto)) 3204 selfdict = partial->pt_dict; 3205 if (error == FCERR_NONE && partial->pt_argc > 0) 3206 { 3207 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear) 3208 { 3209 if (argv_clear + argcount_in >= MAX_FUNC_ARGS) 3210 { 3211 error = FCERR_TOOMANY; 3212 goto theend; 3213 } 3214 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]); 3215 } 3216 for (i = 0; i < argcount_in; ++i) 3217 argv[i + argv_clear] = argvars_in[i]; 3218 argvars = argv; 3219 argcount = partial->pt_argc + argcount_in; 3220 3221 if (funcexe->check_type != NULL 3222 && funcexe->check_type->tt_argcount != -1) 3223 { 3224 // Now funcexe->check_type is missing the added arguments, make 3225 // a copy of the type with the correction. 3226 check_type = *funcexe->check_type; 3227 funcexe->check_type = &check_type; 3228 check_type.tt_argcount += partial->pt_argc; 3229 check_type.tt_min_argcount += partial->pt_argc; 3230 } 3231 } 3232 } 3233 3234 if (error == FCERR_NONE && funcexe->check_type != NULL && funcexe->evaluate) 3235 { 3236 // Check that the argument types are OK for the types of the funcref. 3237 if (check_argument_types(funcexe->check_type, argvars, argcount, 3238 (name != NULL) ? name : funcname) == FAIL) 3239 error = FCERR_OTHER; 3240 } 3241 3242 if (error == FCERR_NONE && funcexe->evaluate) 3243 { 3244 char_u *rfname = fname; 3245 int is_global = FALSE; 3246 3247 // Skip "g:" before a function name. 3248 if (fp == NULL && fname[0] == 'g' && fname[1] == ':') 3249 { 3250 is_global = TRUE; 3251 rfname = fname + 2; 3252 } 3253 3254 rettv->v_type = VAR_NUMBER; // default rettv is number zero 3255 rettv->vval.v_number = 0; 3256 error = FCERR_UNKNOWN; 3257 3258 if (fp != NULL || !builtin_function(rfname, -1)) 3259 { 3260 /* 3261 * User defined function. 3262 */ 3263 if (fp == NULL) 3264 fp = find_func(rfname, is_global, NULL); 3265 3266 // Trigger FuncUndefined event, may load the function. 3267 if (fp == NULL 3268 && apply_autocmds(EVENT_FUNCUNDEFINED, 3269 rfname, rfname, TRUE, NULL) 3270 && !aborting()) 3271 { 3272 // executed an autocommand, search for the function again 3273 fp = find_func(rfname, is_global, NULL); 3274 } 3275 // Try loading a package. 3276 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting()) 3277 { 3278 // loaded a package, search for the function again 3279 fp = find_func(rfname, is_global, NULL); 3280 } 3281 if (fp == NULL) 3282 { 3283 char_u *p = untrans_function_name(rfname); 3284 3285 // If using Vim9 script try not local to the script. 3286 // Don't do this if the name starts with "s:". 3287 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':')) 3288 fp = find_func(p, is_global, NULL); 3289 } 3290 3291 if (fp != NULL && (fp->uf_flags & FC_DELETED)) 3292 error = FCERR_DELETED; 3293 #ifdef FEAT_LUA 3294 else if (fp != NULL && (fp->uf_flags & FC_CFUNC)) 3295 { 3296 cfunc_T cb = fp->uf_cb; 3297 3298 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state); 3299 } 3300 #endif 3301 else if (fp != NULL) 3302 { 3303 if (funcexe->argv_func != NULL) 3304 // postponed filling in the arguments, do it now 3305 argcount = funcexe->argv_func(argcount, argvars, argv_clear, 3306 fp->uf_args.ga_len); 3307 3308 if (funcexe->basetv != NULL) 3309 { 3310 // Method call: base->Method() 3311 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount); 3312 argv[0] = *funcexe->basetv; 3313 argcount++; 3314 argvars = argv; 3315 argv_base = 1; 3316 } 3317 3318 error = call_user_func_check(fp, argcount, argvars, rettv, 3319 funcexe, selfdict); 3320 } 3321 } 3322 else if (funcexe->basetv != NULL) 3323 { 3324 /* 3325 * expr->method(): Find the method name in the table, call its 3326 * implementation with the base as one of the arguments. 3327 */ 3328 error = call_internal_method(fname, argcount, argvars, rettv, 3329 funcexe->basetv); 3330 } 3331 else 3332 { 3333 /* 3334 * Find the function name in the table, call its implementation. 3335 */ 3336 error = call_internal_func(fname, argcount, argvars, rettv); 3337 } 3338 3339 /* 3340 * The function call (or "FuncUndefined" autocommand sequence) might 3341 * have been aborted by an error, an interrupt, or an explicitly thrown 3342 * exception that has not been caught so far. This situation can be 3343 * tested for by calling aborting(). For an error in an internal 3344 * function or for the "E132" error in call_user_func(), however, the 3345 * throw point at which the "force_abort" flag (temporarily reset by 3346 * emsg()) is normally updated has not been reached yet. We need to 3347 * update that flag first to make aborting() reliable. 3348 */ 3349 update_force_abort(); 3350 } 3351 if (error == FCERR_NONE) 3352 ret = OK; 3353 3354 theend: 3355 /* 3356 * Report an error unless the argument evaluation or function call has been 3357 * cancelled due to an aborting error, an interrupt, or an exception. 3358 */ 3359 if (!aborting()) 3360 { 3361 user_func_error(error, (name != NULL) ? name : funcname); 3362 } 3363 3364 // clear the copies made from the partial 3365 while (argv_clear > 0) 3366 clear_tv(&argv[--argv_clear + argv_base]); 3367 3368 vim_free(tofree); 3369 vim_free(name); 3370 3371 return ret; 3372 } 3373 3374 char_u * 3375 printable_func_name(ufunc_T *fp) 3376 { 3377 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name; 3378 } 3379 3380 /* 3381 * List the head of the function: "function name(arg1, arg2)". 3382 */ 3383 static void 3384 list_func_head(ufunc_T *fp, int indent) 3385 { 3386 int j; 3387 3388 msg_start(); 3389 if (indent) 3390 msg_puts(" "); 3391 if (fp->uf_def_status != UF_NOT_COMPILED) 3392 msg_puts("def "); 3393 else 3394 msg_puts("function "); 3395 msg_puts((char *)printable_func_name(fp)); 3396 msg_putchar('('); 3397 for (j = 0; j < fp->uf_args.ga_len; ++j) 3398 { 3399 if (j) 3400 msg_puts(", "); 3401 msg_puts((char *)FUNCARG(fp, j)); 3402 if (fp->uf_arg_types != NULL) 3403 { 3404 char *tofree; 3405 3406 msg_puts(": "); 3407 msg_puts(type_name(fp->uf_arg_types[j], &tofree)); 3408 vim_free(tofree); 3409 } 3410 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len) 3411 { 3412 msg_puts(" = "); 3413 msg_puts(((char **)(fp->uf_def_args.ga_data)) 3414 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]); 3415 } 3416 } 3417 if (fp->uf_varargs) 3418 { 3419 if (j) 3420 msg_puts(", "); 3421 msg_puts("..."); 3422 } 3423 if (fp->uf_va_name != NULL) 3424 { 3425 if (j) 3426 msg_puts(", "); 3427 msg_puts("..."); 3428 msg_puts((char *)fp->uf_va_name); 3429 if (fp->uf_va_type != NULL) 3430 { 3431 char *tofree; 3432 3433 msg_puts(": "); 3434 msg_puts(type_name(fp->uf_va_type, &tofree)); 3435 vim_free(tofree); 3436 } 3437 } 3438 msg_putchar(')'); 3439 3440 if (fp->uf_def_status != UF_NOT_COMPILED) 3441 { 3442 if (fp->uf_ret_type != &t_void) 3443 { 3444 char *tofree; 3445 3446 msg_puts(": "); 3447 msg_puts(type_name(fp->uf_ret_type, &tofree)); 3448 vim_free(tofree); 3449 } 3450 } 3451 else if (fp->uf_flags & FC_ABORT) 3452 msg_puts(" abort"); 3453 if (fp->uf_flags & FC_RANGE) 3454 msg_puts(" range"); 3455 if (fp->uf_flags & FC_DICT) 3456 msg_puts(" dict"); 3457 if (fp->uf_flags & FC_CLOSURE) 3458 msg_puts(" closure"); 3459 msg_clr_eos(); 3460 if (p_verbose > 0) 3461 last_set_msg(fp->uf_script_ctx); 3462 } 3463 3464 /* 3465 * Get a function name, translating "<SID>" and "<SNR>". 3466 * Also handles a Funcref in a List or Dictionary. 3467 * Returns the function name in allocated memory, or NULL for failure. 3468 * Set "*is_global" to TRUE when the function must be global, unless 3469 * "is_global" is NULL. 3470 * flags: 3471 * TFN_INT: internal function name OK 3472 * TFN_QUIET: be quiet 3473 * TFN_NO_AUTOLOAD: do not use script autoloading 3474 * TFN_NO_DEREF: do not dereference a Funcref 3475 * Advances "pp" to just after the function name (if no error). 3476 */ 3477 char_u * 3478 trans_function_name( 3479 char_u **pp, 3480 int *is_global, 3481 int skip, // only find the end, don't evaluate 3482 int flags, 3483 funcdict_T *fdp, // return: info about dictionary used 3484 partial_T **partial, // return: partial of a FuncRef 3485 type_T **type) // return: type of funcref if not NULL 3486 { 3487 char_u *name = NULL; 3488 char_u *start; 3489 char_u *end; 3490 int lead; 3491 char_u sid_buf[20]; 3492 int len; 3493 int extra = 0; 3494 lval_T lv; 3495 int vim9script; 3496 static char *e_function_name = N_("E129: Function name required"); 3497 3498 if (fdp != NULL) 3499 CLEAR_POINTER(fdp); 3500 start = *pp; 3501 3502 // Check for hard coded <SNR>: already translated function ID (from a user 3503 // command). 3504 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA 3505 && (*pp)[2] == (int)KE_SNR) 3506 { 3507 *pp += 3; 3508 len = get_id_len(pp) + 3; 3509 return vim_strnsave(start, len); 3510 } 3511 3512 // A name starting with "<SID>" or "<SNR>" is local to a script. But 3513 // don't skip over "s:", get_lval() needs it for "s:dict.func". 3514 lead = eval_fname_script(start); 3515 if (lead > 2) 3516 start += lead; 3517 3518 // Note that TFN_ flags use the same values as GLV_ flags. 3519 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY, 3520 lead > 2 ? 0 : FNE_CHECK_START); 3521 if (end == start) 3522 { 3523 if (!skip) 3524 emsg(_(e_function_name)); 3525 goto theend; 3526 } 3527 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range))) 3528 { 3529 /* 3530 * Report an invalid expression in braces, unless the expression 3531 * evaluation has been cancelled due to an aborting error, an 3532 * interrupt, or an exception. 3533 */ 3534 if (!aborting()) 3535 { 3536 if (end != NULL) 3537 semsg(_(e_invarg2), start); 3538 } 3539 else 3540 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR); 3541 goto theend; 3542 } 3543 3544 if (lv.ll_tv != NULL) 3545 { 3546 if (fdp != NULL) 3547 { 3548 fdp->fd_dict = lv.ll_dict; 3549 fdp->fd_newkey = lv.ll_newkey; 3550 lv.ll_newkey = NULL; 3551 fdp->fd_di = lv.ll_di; 3552 } 3553 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL) 3554 { 3555 name = vim_strsave(lv.ll_tv->vval.v_string); 3556 *pp = end; 3557 } 3558 else if (lv.ll_tv->v_type == VAR_PARTIAL 3559 && lv.ll_tv->vval.v_partial != NULL) 3560 { 3561 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial)); 3562 *pp = end; 3563 if (partial != NULL) 3564 *partial = lv.ll_tv->vval.v_partial; 3565 } 3566 else 3567 { 3568 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL 3569 || lv.ll_dict == NULL || fdp->fd_newkey == NULL)) 3570 emsg(_(e_funcref)); 3571 else 3572 *pp = end; 3573 name = NULL; 3574 } 3575 goto theend; 3576 } 3577 3578 if (lv.ll_name == NULL) 3579 { 3580 // Error found, but continue after the function name. 3581 *pp = end; 3582 goto theend; 3583 } 3584 3585 // Check if the name is a Funcref. If so, use the value. 3586 if (lv.ll_exp_name != NULL) 3587 { 3588 len = (int)STRLEN(lv.ll_exp_name); 3589 name = deref_func_name(lv.ll_exp_name, &len, partial, type, 3590 flags & TFN_NO_AUTOLOAD); 3591 if (name == lv.ll_exp_name) 3592 name = NULL; 3593 } 3594 else if (!(flags & TFN_NO_DEREF)) 3595 { 3596 len = (int)(end - *pp); 3597 name = deref_func_name(*pp, &len, partial, type, 3598 flags & TFN_NO_AUTOLOAD); 3599 if (name == *pp) 3600 name = NULL; 3601 } 3602 if (name != NULL) 3603 { 3604 name = vim_strsave(name); 3605 *pp = end; 3606 if (STRNCMP(name, "<SNR>", 5) == 0) 3607 { 3608 // Change "<SNR>" to the byte sequence. 3609 name[0] = K_SPECIAL; 3610 name[1] = KS_EXTRA; 3611 name[2] = (int)KE_SNR; 3612 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1); 3613 } 3614 goto theend; 3615 } 3616 3617 if (lv.ll_exp_name != NULL) 3618 { 3619 len = (int)STRLEN(lv.ll_exp_name); 3620 if (lead <= 2 && lv.ll_name == lv.ll_exp_name 3621 && STRNCMP(lv.ll_name, "s:", 2) == 0) 3622 { 3623 // When there was "s:" already or the name expanded to get a 3624 // leading "s:" then remove it. 3625 lv.ll_name += 2; 3626 len -= 2; 3627 lead = 2; 3628 } 3629 } 3630 else 3631 { 3632 // skip over "s:" and "g:" 3633 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':')) 3634 { 3635 if (is_global != NULL && lv.ll_name[0] == 'g') 3636 *is_global = TRUE; 3637 lv.ll_name += 2; 3638 } 3639 len = (int)(end - lv.ll_name); 3640 } 3641 if (len <= 0) 3642 { 3643 if (!skip) 3644 emsg(_(e_function_name)); 3645 goto theend; 3646 } 3647 3648 // In Vim9 script a user function is script-local by default, unless it 3649 // starts with a lower case character: dict.func(). 3650 vim9script = ASCII_ISUPPER(*start) && in_vim9script(); 3651 if (vim9script) 3652 { 3653 char_u *p; 3654 3655 // SomeScript#func() is a global function. 3656 for (p = start; *p != NUL && *p != '('; ++p) 3657 if (*p == AUTOLOAD_CHAR) 3658 vim9script = FALSE; 3659 } 3660 3661 /* 3662 * Copy the function name to allocated memory. 3663 * Accept <SID>name() inside a script, translate into <SNR>123_name(). 3664 * Accept <SNR>123_name() outside a script. 3665 */ 3666 if (skip) 3667 lead = 0; // do nothing 3668 else if (lead > 0 || vim9script) 3669 { 3670 if (!vim9script) 3671 lead = 3; 3672 if (vim9script || (lv.ll_exp_name != NULL 3673 && eval_fname_sid(lv.ll_exp_name)) 3674 || eval_fname_sid(*pp)) 3675 { 3676 // It's script-local, "s:" or "<SID>" 3677 if (current_sctx.sc_sid <= 0) 3678 { 3679 emsg(_(e_usingsid)); 3680 goto theend; 3681 } 3682 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid); 3683 if (vim9script) 3684 extra = 3 + (int)STRLEN(sid_buf); 3685 else 3686 lead += (int)STRLEN(sid_buf); 3687 } 3688 } 3689 else if (!(flags & TFN_INT) && (builtin_function(lv.ll_name, len) 3690 || (in_vim9script() && *lv.ll_name == '_'))) 3691 { 3692 semsg(_("E128: Function name must start with a capital or \"s:\": %s"), 3693 start); 3694 goto theend; 3695 } 3696 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF)) 3697 { 3698 char_u *cp = vim_strchr(lv.ll_name, ':'); 3699 3700 if (cp != NULL && cp < end) 3701 { 3702 semsg(_("E884: Function name cannot contain a colon: %s"), start); 3703 goto theend; 3704 } 3705 } 3706 3707 name = alloc(len + lead + extra + 1); 3708 if (name != NULL) 3709 { 3710 if (!skip && (lead > 0 || vim9script)) 3711 { 3712 name[0] = K_SPECIAL; 3713 name[1] = KS_EXTRA; 3714 name[2] = (int)KE_SNR; 3715 if (vim9script || lead > 3) // If it's "<SID>" 3716 STRCPY(name + 3, sid_buf); 3717 } 3718 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len); 3719 name[lead + extra + len] = NUL; 3720 } 3721 *pp = end; 3722 3723 theend: 3724 clear_lval(&lv); 3725 return name; 3726 } 3727 3728 /* 3729 * Assuming "name" is the result of trans_function_name() and it was prefixed 3730 * to use the script-local name, return the unmodified name (points into 3731 * "name"). Otherwise return NULL. 3732 * This can be used to first search for a script-local function and fall back 3733 * to the global function if not found. 3734 */ 3735 char_u * 3736 untrans_function_name(char_u *name) 3737 { 3738 char_u *p; 3739 3740 if (*name == K_SPECIAL && in_vim9script()) 3741 { 3742 p = vim_strchr(name, '_'); 3743 if (p != NULL) 3744 return p + 1; 3745 } 3746 return NULL; 3747 } 3748 3749 /* 3750 * List functions. When "regmatch" is NULL all of then. 3751 * Otherwise functions matching "regmatch". 3752 */ 3753 void 3754 list_functions(regmatch_T *regmatch) 3755 { 3756 int changed = func_hashtab.ht_changed; 3757 long_u todo = func_hashtab.ht_used; 3758 hashitem_T *hi; 3759 3760 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi) 3761 { 3762 if (!HASHITEM_EMPTY(hi)) 3763 { 3764 ufunc_T *fp = HI2UF(hi); 3765 3766 --todo; 3767 if ((fp->uf_flags & FC_DEAD) == 0 3768 && (regmatch == NULL 3769 ? !message_filtered(fp->uf_name) 3770 && !func_name_refcount(fp->uf_name) 3771 : !isdigit(*fp->uf_name) 3772 && vim_regexec(regmatch, fp->uf_name, 0))) 3773 { 3774 list_func_head(fp, FALSE); 3775 if (changed != func_hashtab.ht_changed) 3776 { 3777 emsg(_("E454: function list was modified")); 3778 return; 3779 } 3780 } 3781 } 3782 } 3783 } 3784 3785 /* 3786 * ":function" also supporting nested ":def". 3787 * When "name_arg" is not NULL this is a nested function, using "name_arg" for 3788 * the function name. 3789 * Returns a pointer to the function or NULL if no function defined. 3790 */ 3791 ufunc_T * 3792 define_function(exarg_T *eap, char_u *name_arg) 3793 { 3794 char_u *line_to_free = NULL; 3795 int j; 3796 int c; 3797 int saved_did_emsg; 3798 char_u *name = name_arg; 3799 int is_global = FALSE; 3800 char_u *p; 3801 char_u *arg; 3802 char_u *whitep; 3803 char_u *line_arg = NULL; 3804 garray_T newargs; 3805 garray_T argtypes; 3806 garray_T default_args; 3807 garray_T newlines; 3808 int varargs = FALSE; 3809 int flags = 0; 3810 char_u *ret_type = NULL; 3811 ufunc_T *fp = NULL; 3812 int overwrite = FALSE; 3813 dictitem_T *v; 3814 funcdict_T fudi; 3815 static int func_nr = 0; // number for nameless function 3816 int paren; 3817 hashitem_T *hi; 3818 linenr_T sourcing_lnum_top; 3819 int vim9script = in_vim9script(); 3820 imported_T *import = NULL; 3821 3822 /* 3823 * ":function" without argument: list functions. 3824 */ 3825 if (ends_excmd2(eap->cmd, eap->arg)) 3826 { 3827 if (!eap->skip) 3828 list_functions(NULL); 3829 eap->nextcmd = check_nextcmd(eap->arg); 3830 return NULL; 3831 } 3832 3833 /* 3834 * ":function /pat": list functions matching pattern. 3835 */ 3836 if (*eap->arg == '/') 3837 { 3838 p = skip_regexp(eap->arg + 1, '/', TRUE); 3839 if (!eap->skip) 3840 { 3841 regmatch_T regmatch; 3842 3843 c = *p; 3844 *p = NUL; 3845 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC); 3846 *p = c; 3847 if (regmatch.regprog != NULL) 3848 { 3849 regmatch.rm_ic = p_ic; 3850 list_functions(®match); 3851 vim_regfree(regmatch.regprog); 3852 } 3853 } 3854 if (*p == '/') 3855 ++p; 3856 eap->nextcmd = check_nextcmd(p); 3857 return NULL; 3858 } 3859 3860 ga_init(&newargs); 3861 ga_init(&argtypes); 3862 ga_init(&default_args); 3863 3864 /* 3865 * Get the function name. There are these situations: 3866 * func normal function name 3867 * "name" == func, "fudi.fd_dict" == NULL 3868 * dict.func new dictionary entry 3869 * "name" == NULL, "fudi.fd_dict" set, 3870 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func 3871 * dict.func existing dict entry with a Funcref 3872 * "name" == func, "fudi.fd_dict" set, 3873 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL 3874 * dict.func existing dict entry that's not a Funcref 3875 * "name" == NULL, "fudi.fd_dict" set, 3876 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL 3877 * s:func script-local function name 3878 * g:func global function name, same as "func" 3879 */ 3880 p = eap->arg; 3881 if (name_arg != NULL) 3882 { 3883 // nested function, argument is (args). 3884 paren = TRUE; 3885 CLEAR_FIELD(fudi); 3886 } 3887 else 3888 { 3889 if (STRNCMP(p, "<lambda>", 8) == 0) 3890 { 3891 p += 8; 3892 (void)getdigits(&p); 3893 name = vim_strnsave(eap->arg, p - eap->arg); 3894 CLEAR_FIELD(fudi); 3895 } 3896 else 3897 name = trans_function_name(&p, &is_global, eap->skip, 3898 TFN_NO_AUTOLOAD, &fudi, NULL, NULL); 3899 paren = (vim_strchr(p, '(') != NULL); 3900 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip) 3901 { 3902 /* 3903 * Return on an invalid expression in braces, unless the expression 3904 * evaluation has been cancelled due to an aborting error, an 3905 * interrupt, or an exception. 3906 */ 3907 if (!aborting()) 3908 { 3909 if (!eap->skip && fudi.fd_newkey != NULL) 3910 semsg(_(e_dictkey), fudi.fd_newkey); 3911 vim_free(fudi.fd_newkey); 3912 return NULL; 3913 } 3914 else 3915 eap->skip = TRUE; 3916 } 3917 } 3918 3919 // An error in a function call during evaluation of an expression in magic 3920 // braces should not cause the function not to be defined. 3921 saved_did_emsg = did_emsg; 3922 did_emsg = FALSE; 3923 3924 /* 3925 * ":function func" with only function name: list function. 3926 */ 3927 if (!paren) 3928 { 3929 if (!ends_excmd(*skipwhite(p))) 3930 { 3931 semsg(_(e_trailing_arg), p); 3932 goto ret_free; 3933 } 3934 eap->nextcmd = check_nextcmd(p); 3935 if (eap->nextcmd != NULL) 3936 *p = NUL; 3937 if (!eap->skip && !got_int) 3938 { 3939 fp = find_func(name, is_global, NULL); 3940 if (fp == NULL && ASCII_ISUPPER(*eap->arg)) 3941 { 3942 char_u *up = untrans_function_name(name); 3943 3944 // With Vim9 script the name was made script-local, if not 3945 // found try again with the original name. 3946 if (up != NULL) 3947 fp = find_func(up, FALSE, NULL); 3948 } 3949 3950 if (fp != NULL) 3951 { 3952 list_func_head(fp, TRUE); 3953 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j) 3954 { 3955 if (FUNCLINE(fp, j) == NULL) 3956 continue; 3957 msg_putchar('\n'); 3958 msg_outnum((long)(j + 1)); 3959 if (j < 9) 3960 msg_putchar(' '); 3961 if (j < 99) 3962 msg_putchar(' '); 3963 msg_prt_line(FUNCLINE(fp, j), FALSE); 3964 out_flush(); // show a line at a time 3965 ui_breakcheck(); 3966 } 3967 if (!got_int) 3968 { 3969 msg_putchar('\n'); 3970 if (fp->uf_def_status != UF_NOT_COMPILED) 3971 msg_puts(" enddef"); 3972 else 3973 msg_puts(" endfunction"); 3974 } 3975 } 3976 else 3977 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg); 3978 } 3979 goto ret_free; 3980 } 3981 3982 /* 3983 * ":function name(arg1, arg2)" Define function. 3984 */ 3985 p = skipwhite(p); 3986 if (*p != '(') 3987 { 3988 if (!eap->skip) 3989 { 3990 semsg(_("E124: Missing '(': %s"), eap->arg); 3991 goto ret_free; 3992 } 3993 // attempt to continue by skipping some text 3994 if (vim_strchr(p, '(') != NULL) 3995 p = vim_strchr(p, '('); 3996 } 3997 3998 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1])) 3999 { 4000 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1); 4001 goto ret_free; 4002 } 4003 4004 // In Vim9 script only global functions can be redefined. 4005 if (vim9script && eap->forceit && !is_global) 4006 { 4007 emsg(_(e_nobang)); 4008 goto ret_free; 4009 } 4010 4011 ga_init2(&newlines, (int)sizeof(char_u *), 10); 4012 4013 if (!eap->skip && name_arg == NULL) 4014 { 4015 // Check the name of the function. Unless it's a dictionary function 4016 // (that we are overwriting). 4017 if (name != NULL) 4018 arg = name; 4019 else 4020 arg = fudi.fd_newkey; 4021 if (arg != NULL && (fudi.fd_di == NULL 4022 || (fudi.fd_di->di_tv.v_type != VAR_FUNC 4023 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL))) 4024 { 4025 if (*arg == K_SPECIAL) 4026 j = 3; 4027 else 4028 j = 0; 4029 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j]) 4030 : eval_isnamec(arg[j]))) 4031 ++j; 4032 if (arg[j] != NUL) 4033 emsg_funcname((char *)e_invarg2, arg); 4034 } 4035 // Disallow using the g: dict. 4036 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE) 4037 emsg(_("E862: Cannot use g: here")); 4038 } 4039 4040 // This may get more lines and make the pointers into the first line 4041 // invalid. 4042 ++p; 4043 if (get_function_args(&p, ')', &newargs, 4044 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE, 4045 NULL, &varargs, &default_args, eap->skip, 4046 eap, &line_to_free) == FAIL) 4047 goto errret_2; 4048 whitep = p; 4049 4050 if (eap->cmdidx == CMD_def) 4051 { 4052 // find the return type: :def Func(): type 4053 if (*p == ':') 4054 { 4055 ret_type = skipwhite(p + 1); 4056 p = skip_type(ret_type, FALSE); 4057 if (p > ret_type) 4058 { 4059 ret_type = vim_strnsave(ret_type, p - ret_type); 4060 whitep = p; 4061 p = skipwhite(p); 4062 } 4063 else 4064 { 4065 semsg(_(e_expected_type_str), ret_type); 4066 ret_type = NULL; 4067 } 4068 } 4069 p = skipwhite(p); 4070 } 4071 else 4072 // find extra arguments "range", "dict", "abort" and "closure" 4073 for (;;) 4074 { 4075 whitep = p; 4076 p = skipwhite(p); 4077 if (STRNCMP(p, "range", 5) == 0) 4078 { 4079 flags |= FC_RANGE; 4080 p += 5; 4081 } 4082 else if (STRNCMP(p, "dict", 4) == 0) 4083 { 4084 flags |= FC_DICT; 4085 p += 4; 4086 } 4087 else if (STRNCMP(p, "abort", 5) == 0) 4088 { 4089 flags |= FC_ABORT; 4090 p += 5; 4091 } 4092 else if (STRNCMP(p, "closure", 7) == 0) 4093 { 4094 flags |= FC_CLOSURE; 4095 p += 7; 4096 if (current_funccal == NULL) 4097 { 4098 emsg_funcname(N_("E932: Closure function should not be at top level: %s"), 4099 name == NULL ? (char_u *)"" : name); 4100 goto erret; 4101 } 4102 } 4103 else 4104 break; 4105 } 4106 4107 // When there is a line break use what follows for the function body. 4108 // Makes 'exe "func Test()\n...\nendfunc"' work. 4109 if (*p == '\n') 4110 line_arg = p + 1; 4111 else if (*p != NUL 4112 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function) 4113 && eap->cmdidx != CMD_def) 4114 && !(VIM_ISWHITE(*whitep) && *p == '#' 4115 && (vim9script || eap->cmdidx == CMD_def)) 4116 && !eap->skip 4117 && !did_emsg) 4118 semsg(_(e_trailing_arg), p); 4119 4120 /* 4121 * Read the body of the function, until "}", ":endfunction" or ":enddef" is 4122 * found. 4123 */ 4124 if (KeyTyped) 4125 { 4126 // Check if the function already exists, don't let the user type the 4127 // whole function before telling him it doesn't work! For a script we 4128 // need to skip the body to be able to find what follows. 4129 if (!eap->skip && !eap->forceit) 4130 { 4131 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL) 4132 emsg(_(e_funcdict)); 4133 else if (name != NULL && find_func(name, is_global, NULL) != NULL) 4134 emsg_funcname(e_funcexts, name); 4135 } 4136 4137 if (!eap->skip && did_emsg) 4138 goto erret; 4139 4140 msg_putchar('\n'); // don't overwrite the function name 4141 cmdline_row = msg_row; 4142 } 4143 4144 // Save the starting line number. 4145 sourcing_lnum_top = SOURCING_LNUM; 4146 4147 // Do not define the function when getting the body fails and when 4148 // skipping. 4149 if (get_function_body(eap, &newlines, line_arg, &line_to_free) == FAIL 4150 || eap->skip) 4151 goto erret; 4152 4153 /* 4154 * If there are no errors, add the function 4155 */ 4156 if (fudi.fd_dict == NULL) 4157 { 4158 hashtab_T *ht; 4159 4160 v = find_var(name, &ht, TRUE); 4161 if (v != NULL && v->di_tv.v_type == VAR_FUNC) 4162 { 4163 emsg_funcname(N_("E707: Function name conflicts with variable: %s"), 4164 name); 4165 goto erret; 4166 } 4167 4168 fp = find_func_even_dead(name, is_global, NULL); 4169 if (vim9script) 4170 { 4171 char_u *uname = untrans_function_name(name); 4172 4173 import = find_imported(uname == NULL ? name : uname, 0, NULL); 4174 } 4175 4176 if (fp != NULL || import != NULL) 4177 { 4178 int dead = fp != NULL && (fp->uf_flags & FC_DEAD); 4179 4180 // Function can be replaced with "function!" and when sourcing the 4181 // same script again, but only once. 4182 // A name that is used by an import can not be overruled. 4183 if (import != NULL 4184 || (!dead && !eap->forceit 4185 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid 4186 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq))) 4187 { 4188 if (vim9script) 4189 emsg_funcname(e_name_already_defined_str, name); 4190 else 4191 emsg_funcname(e_funcexts, name); 4192 goto erret; 4193 } 4194 if (fp->uf_calls > 0) 4195 { 4196 emsg_funcname( 4197 N_("E127: Cannot redefine function %s: It is in use"), 4198 name); 4199 goto erret; 4200 } 4201 if (fp->uf_refcount > 1) 4202 { 4203 // This function is referenced somewhere, don't redefine it but 4204 // create a new one. 4205 --fp->uf_refcount; 4206 fp->uf_flags |= FC_REMOVED; 4207 fp = NULL; 4208 overwrite = TRUE; 4209 } 4210 else 4211 { 4212 char_u *exp_name = fp->uf_name_exp; 4213 4214 // redefine existing function, keep the expanded name 4215 VIM_CLEAR(name); 4216 fp->uf_name_exp = NULL; 4217 func_clear_items(fp); 4218 fp->uf_name_exp = exp_name; 4219 fp->uf_flags &= ~FC_DEAD; 4220 #ifdef FEAT_PROFILE 4221 fp->uf_profiling = FALSE; 4222 fp->uf_prof_initialized = FALSE; 4223 #endif 4224 fp->uf_def_status = UF_NOT_COMPILED; 4225 } 4226 } 4227 } 4228 else 4229 { 4230 char numbuf[20]; 4231 4232 fp = NULL; 4233 if (fudi.fd_newkey == NULL && !eap->forceit) 4234 { 4235 emsg(_(e_funcdict)); 4236 goto erret; 4237 } 4238 if (fudi.fd_di == NULL) 4239 { 4240 // Can't add a function to a locked dictionary 4241 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE)) 4242 goto erret; 4243 } 4244 // Can't change an existing function if it is locked 4245 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE)) 4246 goto erret; 4247 4248 // Give the function a sequential number. Can only be used with a 4249 // Funcref! 4250 vim_free(name); 4251 sprintf(numbuf, "%d", ++func_nr); 4252 name = vim_strsave((char_u *)numbuf); 4253 if (name == NULL) 4254 goto erret; 4255 } 4256 4257 if (fp == NULL) 4258 { 4259 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL) 4260 { 4261 int slen, plen; 4262 char_u *scriptname; 4263 4264 // Check that the autoload name matches the script name. 4265 j = FAIL; 4266 if (SOURCING_NAME != NULL) 4267 { 4268 scriptname = autoload_name(name); 4269 if (scriptname != NULL) 4270 { 4271 p = vim_strchr(scriptname, '/'); 4272 plen = (int)STRLEN(p); 4273 slen = (int)STRLEN(SOURCING_NAME); 4274 if (slen > plen && fnamecmp(p, 4275 SOURCING_NAME + slen - plen) == 0) 4276 j = OK; 4277 vim_free(scriptname); 4278 } 4279 } 4280 if (j == FAIL) 4281 { 4282 linenr_T save_lnum = SOURCING_LNUM; 4283 4284 SOURCING_LNUM = sourcing_lnum_top; 4285 semsg(_("E746: Function name does not match script file name: %s"), name); 4286 SOURCING_LNUM = save_lnum; 4287 goto erret; 4288 } 4289 } 4290 4291 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1); 4292 if (fp == NULL) 4293 goto erret; 4294 4295 if (fudi.fd_dict != NULL) 4296 { 4297 if (fudi.fd_di == NULL) 4298 { 4299 // add new dict entry 4300 fudi.fd_di = dictitem_alloc(fudi.fd_newkey); 4301 if (fudi.fd_di == NULL) 4302 { 4303 vim_free(fp); 4304 fp = NULL; 4305 goto erret; 4306 } 4307 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL) 4308 { 4309 vim_free(fudi.fd_di); 4310 vim_free(fp); 4311 fp = NULL; 4312 goto erret; 4313 } 4314 } 4315 else 4316 // overwrite existing dict entry 4317 clear_tv(&fudi.fd_di->di_tv); 4318 fudi.fd_di->di_tv.v_type = VAR_FUNC; 4319 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name); 4320 4321 // behave like "dict" was used 4322 flags |= FC_DICT; 4323 } 4324 4325 // insert the new function in the function list 4326 set_ufunc_name(fp, name); 4327 if (overwrite) 4328 { 4329 hi = hash_find(&func_hashtab, name); 4330 hi->hi_key = UF2HIKEY(fp); 4331 } 4332 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL) 4333 { 4334 vim_free(fp); 4335 fp = NULL; 4336 goto erret; 4337 } 4338 fp->uf_refcount = 1; 4339 } 4340 fp->uf_args = newargs; 4341 fp->uf_def_args = default_args; 4342 fp->uf_ret_type = &t_any; 4343 fp->uf_func_type = &t_func_any; 4344 4345 if (eap->cmdidx == CMD_def) 4346 { 4347 int lnum_save = SOURCING_LNUM; 4348 cstack_T *cstack = eap->cstack; 4349 4350 fp->uf_def_status = UF_TO_BE_COMPILED; 4351 4352 // error messages are for the first function line 4353 SOURCING_LNUM = sourcing_lnum_top; 4354 4355 // The function may use script variables from the context. 4356 function_using_block_scopes(fp, cstack); 4357 4358 if (parse_argument_types(fp, &argtypes, varargs) == FAIL) 4359 { 4360 SOURCING_LNUM = lnum_save; 4361 goto errret_2; 4362 } 4363 varargs = FALSE; 4364 4365 // parse the return type, if any 4366 if (parse_return_type(fp, ret_type) == FAIL) 4367 { 4368 SOURCING_LNUM = lnum_save; 4369 goto erret; 4370 } 4371 SOURCING_LNUM = lnum_save; 4372 } 4373 else 4374 fp->uf_def_status = UF_NOT_COMPILED; 4375 4376 fp->uf_lines = newlines; 4377 if ((flags & FC_CLOSURE) != 0) 4378 { 4379 if (register_closure(fp) == FAIL) 4380 goto erret; 4381 } 4382 else 4383 fp->uf_scoped = NULL; 4384 4385 #ifdef FEAT_PROFILE 4386 if (prof_def_func()) 4387 func_do_profile(fp); 4388 #endif 4389 fp->uf_varargs = varargs; 4390 if (sandbox) 4391 flags |= FC_SANDBOX; 4392 if (vim9script && !ASCII_ISUPPER(*fp->uf_name)) 4393 flags |= FC_VIM9; 4394 fp->uf_flags = flags; 4395 fp->uf_calls = 0; 4396 fp->uf_cleared = FALSE; 4397 fp->uf_script_ctx = current_sctx; 4398 fp->uf_script_ctx_version = current_sctx.sc_version; 4399 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top; 4400 if (is_export) 4401 { 4402 fp->uf_flags |= FC_EXPORT; 4403 // let ex_export() know the export worked. 4404 is_export = FALSE; 4405 } 4406 4407 if (eap->cmdidx == CMD_def) 4408 set_function_type(fp); 4409 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9) 4410 // :func does not use Vim9 script syntax, even in a Vim9 script file 4411 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX; 4412 4413 goto ret_free; 4414 4415 erret: 4416 ga_clear_strings(&newargs); 4417 ga_clear_strings(&default_args); 4418 if (fp != NULL) 4419 { 4420 ga_init(&fp->uf_args); 4421 ga_init(&fp->uf_def_args); 4422 } 4423 errret_2: 4424 ga_clear_strings(&newlines); 4425 if (fp != NULL) 4426 VIM_CLEAR(fp->uf_arg_types); 4427 ret_free: 4428 ga_clear_strings(&argtypes); 4429 vim_free(line_to_free); 4430 vim_free(fudi.fd_newkey); 4431 if (name != name_arg) 4432 vim_free(name); 4433 vim_free(ret_type); 4434 did_emsg |= saved_did_emsg; 4435 4436 return fp; 4437 } 4438 4439 /* 4440 * ":function" 4441 */ 4442 void 4443 ex_function(exarg_T *eap) 4444 { 4445 (void)define_function(eap, NULL); 4446 } 4447 4448 /* 4449 * :defcompile - compile all :def functions in the current script that need to 4450 * be compiled. Except dead functions. Doesn't do profiling. 4451 */ 4452 void 4453 ex_defcompile(exarg_T *eap UNUSED) 4454 { 4455 long todo = (long)func_hashtab.ht_used; 4456 int changed = func_hashtab.ht_changed; 4457 hashitem_T *hi; 4458 ufunc_T *ufunc; 4459 4460 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi) 4461 { 4462 if (!HASHITEM_EMPTY(hi)) 4463 { 4464 --todo; 4465 ufunc = HI2UF(hi); 4466 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid 4467 && ufunc->uf_def_status == UF_TO_BE_COMPILED 4468 && (ufunc->uf_flags & FC_DEAD) == 0) 4469 { 4470 (void)compile_def_function(ufunc, FALSE, CT_NONE, NULL); 4471 4472 if (func_hashtab.ht_changed != changed) 4473 { 4474 // a function has been added or removed, need to start over 4475 todo = (long)func_hashtab.ht_used; 4476 changed = func_hashtab.ht_changed; 4477 hi = func_hashtab.ht_array; 4478 --hi; 4479 } 4480 } 4481 } 4482 } 4483 } 4484 4485 /* 4486 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case). 4487 * Return 2 if "p" starts with "s:". 4488 * Return 0 otherwise. 4489 */ 4490 int 4491 eval_fname_script(char_u *p) 4492 { 4493 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with 4494 // the standard library function. 4495 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0 4496 || MB_STRNICMP(p + 1, "SNR>", 4) == 0)) 4497 return 5; 4498 if (p[0] == 's' && p[1] == ':') 4499 return 2; 4500 return 0; 4501 } 4502 4503 int 4504 translated_function_exists(char_u *name, int is_global) 4505 { 4506 if (builtin_function(name, -1)) 4507 return has_internal_func(name); 4508 return find_func(name, is_global, NULL) != NULL; 4509 } 4510 4511 /* 4512 * Return TRUE when "ufunc" has old-style "..." varargs 4513 * or named varargs "...name: type". 4514 */ 4515 int 4516 has_varargs(ufunc_T *ufunc) 4517 { 4518 return ufunc->uf_varargs || ufunc->uf_va_name != NULL; 4519 } 4520 4521 /* 4522 * Return TRUE if a function "name" exists. 4523 * If "no_defef" is TRUE, do not dereference a Funcref. 4524 */ 4525 int 4526 function_exists(char_u *name, int no_deref) 4527 { 4528 char_u *nm = name; 4529 char_u *p; 4530 int n = FALSE; 4531 int flag; 4532 int is_global = FALSE; 4533 4534 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD; 4535 if (no_deref) 4536 flag |= TFN_NO_DEREF; 4537 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL); 4538 nm = skipwhite(nm); 4539 4540 // Only accept "funcname", "funcname ", "funcname (..." and 4541 // "funcname(...", not "funcname!...". 4542 if (p != NULL && (*nm == NUL || *nm == '(')) 4543 n = translated_function_exists(p, is_global); 4544 vim_free(p); 4545 return n; 4546 } 4547 4548 #if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO) 4549 char_u * 4550 get_expanded_name(char_u *name, int check) 4551 { 4552 char_u *nm = name; 4553 char_u *p; 4554 int is_global = FALSE; 4555 4556 p = trans_function_name(&nm, &is_global, FALSE, 4557 TFN_INT|TFN_QUIET, NULL, NULL, NULL); 4558 4559 if (p != NULL && *nm == NUL 4560 && (!check || translated_function_exists(p, is_global))) 4561 return p; 4562 4563 vim_free(p); 4564 return NULL; 4565 } 4566 #endif 4567 4568 /* 4569 * Function given to ExpandGeneric() to obtain the list of user defined 4570 * function names. 4571 */ 4572 char_u * 4573 get_user_func_name(expand_T *xp, int idx) 4574 { 4575 static long_u done; 4576 static int changed; 4577 static hashitem_T *hi; 4578 ufunc_T *fp; 4579 4580 if (idx == 0) 4581 { 4582 done = 0; 4583 hi = func_hashtab.ht_array; 4584 changed = func_hashtab.ht_changed; 4585 } 4586 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used) 4587 { 4588 if (done++ > 0) 4589 ++hi; 4590 while (HASHITEM_EMPTY(hi)) 4591 ++hi; 4592 fp = HI2UF(hi); 4593 4594 // don't show dead, dict and lambda functions 4595 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT) 4596 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0) 4597 return (char_u *)""; 4598 4599 if (STRLEN(fp->uf_name) + 4 >= IOSIZE) 4600 return fp->uf_name; // prevents overflow 4601 4602 cat_func_name(IObuff, fp); 4603 if (xp->xp_context != EXPAND_USER_FUNC) 4604 { 4605 STRCAT(IObuff, "("); 4606 if (!has_varargs(fp) && fp->uf_args.ga_len == 0) 4607 STRCAT(IObuff, ")"); 4608 } 4609 return IObuff; 4610 } 4611 return NULL; 4612 } 4613 4614 /* 4615 * ":delfunction {name}" 4616 */ 4617 void 4618 ex_delfunction(exarg_T *eap) 4619 { 4620 ufunc_T *fp = NULL; 4621 char_u *p; 4622 char_u *name; 4623 funcdict_T fudi; 4624 int is_global = FALSE; 4625 4626 p = eap->arg; 4627 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi, 4628 NULL, NULL); 4629 vim_free(fudi.fd_newkey); 4630 if (name == NULL) 4631 { 4632 if (fudi.fd_dict != NULL && !eap->skip) 4633 emsg(_(e_funcref)); 4634 return; 4635 } 4636 if (!ends_excmd(*skipwhite(p))) 4637 { 4638 vim_free(name); 4639 semsg(_(e_trailing_arg), p); 4640 return; 4641 } 4642 eap->nextcmd = check_nextcmd(p); 4643 if (eap->nextcmd != NULL) 4644 *p = NUL; 4645 4646 if (!eap->skip) 4647 fp = find_func(name, is_global, NULL); 4648 vim_free(name); 4649 4650 if (!eap->skip) 4651 { 4652 if (fp == NULL) 4653 { 4654 if (!eap->forceit) 4655 semsg(_(e_nofunc), eap->arg); 4656 return; 4657 } 4658 if (fp->uf_calls > 0) 4659 { 4660 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg); 4661 return; 4662 } 4663 if (fp->uf_flags & FC_VIM9) 4664 { 4665 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg); 4666 return; 4667 } 4668 4669 if (fudi.fd_dict != NULL) 4670 { 4671 // Delete the dict item that refers to the function, it will 4672 // invoke func_unref() and possibly delete the function. 4673 dictitem_remove(fudi.fd_dict, fudi.fd_di); 4674 } 4675 else 4676 { 4677 // A normal function (not a numbered function or lambda) has a 4678 // refcount of 1 for the entry in the hashtable. When deleting 4679 // it and the refcount is more than one, it should be kept. 4680 // A numbered function and lambda should be kept if the refcount is 4681 // one or more. 4682 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1)) 4683 { 4684 // Function is still referenced somewhere. Don't free it but 4685 // do remove it from the hashtable. 4686 if (func_remove(fp)) 4687 fp->uf_refcount--; 4688 } 4689 else 4690 func_clear_free(fp, FALSE); 4691 } 4692 } 4693 } 4694 4695 /* 4696 * Unreference a Function: decrement the reference count and free it when it 4697 * becomes zero. 4698 */ 4699 void 4700 func_unref(char_u *name) 4701 { 4702 ufunc_T *fp = NULL; 4703 4704 if (name == NULL || !func_name_refcount(name)) 4705 return; 4706 fp = find_func(name, FALSE, NULL); 4707 if (fp == NULL && isdigit(*name)) 4708 { 4709 #ifdef EXITFREE 4710 if (!entered_free_all_mem) 4711 #endif 4712 internal_error("func_unref()"); 4713 } 4714 func_ptr_unref(fp); 4715 } 4716 4717 /* 4718 * Unreference a Function: decrement the reference count and free it when it 4719 * becomes zero. 4720 * Also when it becomes one and uf_partial points to the function. 4721 */ 4722 void 4723 func_ptr_unref(ufunc_T *fp) 4724 { 4725 if (fp != NULL && (--fp->uf_refcount <= 0 4726 || (fp->uf_refcount == 1 && fp->uf_partial != NULL 4727 && fp->uf_partial->pt_refcount <= 1 4728 && fp->uf_partial->pt_func == fp))) 4729 { 4730 // Only delete it when it's not being used. Otherwise it's done 4731 // when "uf_calls" becomes zero. 4732 if (fp->uf_calls == 0) 4733 func_clear_free(fp, FALSE); 4734 } 4735 } 4736 4737 /* 4738 * Count a reference to a Function. 4739 */ 4740 void 4741 func_ref(char_u *name) 4742 { 4743 ufunc_T *fp; 4744 4745 if (name == NULL || !func_name_refcount(name)) 4746 return; 4747 fp = find_func(name, FALSE, NULL); 4748 if (fp != NULL) 4749 ++fp->uf_refcount; 4750 else if (isdigit(*name)) 4751 // Only give an error for a numbered function. 4752 // Fail silently, when named or lambda function isn't found. 4753 internal_error("func_ref()"); 4754 } 4755 4756 /* 4757 * Count a reference to a Function. 4758 */ 4759 void 4760 func_ptr_ref(ufunc_T *fp) 4761 { 4762 if (fp != NULL) 4763 ++fp->uf_refcount; 4764 } 4765 4766 /* 4767 * Return TRUE if items in "fc" do not have "copyID". That means they are not 4768 * referenced from anywhere that is in use. 4769 */ 4770 static int 4771 can_free_funccal(funccall_T *fc, int copyID) 4772 { 4773 return (fc->l_varlist.lv_copyID != copyID 4774 && fc->l_vars.dv_copyID != copyID 4775 && fc->l_avars.dv_copyID != copyID 4776 && fc->fc_copyID != copyID); 4777 } 4778 4779 /* 4780 * ":return [expr]" 4781 */ 4782 void 4783 ex_return(exarg_T *eap) 4784 { 4785 char_u *arg = eap->arg; 4786 typval_T rettv; 4787 int returning = FALSE; 4788 evalarg_T evalarg; 4789 4790 if (current_funccal == NULL) 4791 { 4792 emsg(_("E133: :return not inside a function")); 4793 return; 4794 } 4795 4796 CLEAR_FIELD(evalarg); 4797 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE; 4798 4799 if (eap->skip) 4800 ++emsg_skip; 4801 4802 eap->nextcmd = NULL; 4803 if ((*arg != NUL && *arg != '|' && *arg != '\n') 4804 && eval0(arg, &rettv, eap, &evalarg) != FAIL) 4805 { 4806 if (!eap->skip) 4807 returning = do_return(eap, FALSE, TRUE, &rettv); 4808 else 4809 clear_tv(&rettv); 4810 } 4811 // It's safer to return also on error. 4812 else if (!eap->skip) 4813 { 4814 // In return statement, cause_abort should be force_abort. 4815 update_force_abort(); 4816 4817 /* 4818 * Return unless the expression evaluation has been cancelled due to an 4819 * aborting error, an interrupt, or an exception. 4820 */ 4821 if (!aborting()) 4822 returning = do_return(eap, FALSE, TRUE, NULL); 4823 } 4824 4825 // When skipping or the return gets pending, advance to the next command 4826 // in this line (!returning). Otherwise, ignore the rest of the line. 4827 // Following lines will be ignored by get_func_line(). 4828 if (returning) 4829 eap->nextcmd = NULL; 4830 else if (eap->nextcmd == NULL) // no argument 4831 eap->nextcmd = check_nextcmd(arg); 4832 4833 if (eap->skip) 4834 --emsg_skip; 4835 clear_evalarg(&evalarg, eap); 4836 } 4837 4838 /* 4839 * ":1,25call func(arg1, arg2)" function call. 4840 */ 4841 void 4842 ex_call(exarg_T *eap) 4843 { 4844 char_u *arg = eap->arg; 4845 char_u *startarg; 4846 char_u *name; 4847 char_u *tofree; 4848 int len; 4849 typval_T rettv; 4850 linenr_T lnum; 4851 int doesrange; 4852 int failed = FALSE; 4853 funcdict_T fudi; 4854 partial_T *partial = NULL; 4855 evalarg_T evalarg; 4856 type_T *type = NULL; 4857 4858 fill_evalarg_from_eap(&evalarg, eap, eap->skip); 4859 if (eap->skip) 4860 { 4861 // trans_function_name() doesn't work well when skipping, use eval0() 4862 // instead to skip to any following command, e.g. for: 4863 // :if 0 | call dict.foo().bar() | endif 4864 ++emsg_skip; 4865 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL) 4866 clear_tv(&rettv); 4867 --emsg_skip; 4868 clear_evalarg(&evalarg, eap); 4869 return; 4870 } 4871 4872 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT, 4873 &fudi, &partial, in_vim9script() ? &type : NULL); 4874 if (fudi.fd_newkey != NULL) 4875 { 4876 // Still need to give an error message for missing key. 4877 semsg(_(e_dictkey), fudi.fd_newkey); 4878 vim_free(fudi.fd_newkey); 4879 } 4880 if (tofree == NULL) 4881 return; 4882 4883 // Increase refcount on dictionary, it could get deleted when evaluating 4884 // the arguments. 4885 if (fudi.fd_dict != NULL) 4886 ++fudi.fd_dict->dv_refcount; 4887 4888 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its 4889 // contents. For VAR_PARTIAL get its partial, unless we already have one 4890 // from trans_function_name(). 4891 len = (int)STRLEN(tofree); 4892 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial, 4893 in_vim9script() && type == NULL ? &type : NULL, FALSE); 4894 4895 // Skip white space to allow ":call func ()". Not good, but required for 4896 // backward compatibility. 4897 startarg = skipwhite(arg); 4898 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this 4899 4900 if (*startarg != '(') 4901 { 4902 semsg(_(e_missing_paren), eap->arg); 4903 goto end; 4904 } 4905 4906 /* 4907 * When skipping, evaluate the function once, to find the end of the 4908 * arguments. 4909 * When the function takes a range, this is discovered after the first 4910 * call, and the loop is broken. 4911 */ 4912 if (eap->skip) 4913 { 4914 ++emsg_skip; 4915 lnum = eap->line2; // do it once, also with an invalid range 4916 } 4917 else 4918 lnum = eap->line1; 4919 for ( ; lnum <= eap->line2; ++lnum) 4920 { 4921 funcexe_T funcexe; 4922 4923 if (!eap->skip && eap->addr_count > 0) 4924 { 4925 if (lnum > curbuf->b_ml.ml_line_count) 4926 { 4927 // If the function deleted lines or switched to another buffer 4928 // the line number may become invalid. 4929 emsg(_(e_invalid_range)); 4930 break; 4931 } 4932 curwin->w_cursor.lnum = lnum; 4933 curwin->w_cursor.col = 0; 4934 curwin->w_cursor.coladd = 0; 4935 } 4936 arg = startarg; 4937 4938 CLEAR_FIELD(funcexe); 4939 funcexe.firstline = eap->line1; 4940 funcexe.lastline = eap->line2; 4941 funcexe.doesrange = &doesrange; 4942 funcexe.evaluate = !eap->skip; 4943 funcexe.partial = partial; 4944 funcexe.selfdict = fudi.fd_dict; 4945 funcexe.check_type = type; 4946 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL) 4947 { 4948 failed = TRUE; 4949 break; 4950 } 4951 if (has_watchexpr()) 4952 dbg_check_breakpoint(eap); 4953 4954 // Handle a function returning a Funcref, Dictionary or List. 4955 if (handle_subscript(&arg, &rettv, 4956 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL) 4957 { 4958 failed = TRUE; 4959 break; 4960 } 4961 4962 clear_tv(&rettv); 4963 if (doesrange || eap->skip) 4964 break; 4965 4966 // Stop when immediately aborting on error, or when an interrupt 4967 // occurred or an exception was thrown but not caught. 4968 // get_func_tv() returned OK, so that the check for trailing 4969 // characters below is executed. 4970 if (aborting()) 4971 break; 4972 } 4973 if (eap->skip) 4974 --emsg_skip; 4975 clear_evalarg(&evalarg, eap); 4976 4977 // When inside :try we need to check for following "| catch". 4978 if (!failed || eap->cstack->cs_trylevel > 0) 4979 { 4980 // Check for trailing illegal characters and a following command. 4981 arg = skipwhite(arg); 4982 if (!ends_excmd2(eap->arg, arg)) 4983 { 4984 if (!failed) 4985 { 4986 emsg_severe = TRUE; 4987 semsg(_(e_trailing_arg), arg); 4988 } 4989 } 4990 else 4991 eap->nextcmd = check_nextcmd(arg); 4992 } 4993 4994 end: 4995 dict_unref(fudi.fd_dict); 4996 vim_free(tofree); 4997 } 4998 4999 /* 5000 * Return from a function. Possibly makes the return pending. Also called 5001 * for a pending return at the ":endtry" or after returning from an extra 5002 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set 5003 * when called due to a ":return" command. "rettv" may point to a typval_T 5004 * with the return rettv. Returns TRUE when the return can be carried out, 5005 * FALSE when the return gets pending. 5006 */ 5007 int 5008 do_return( 5009 exarg_T *eap, 5010 int reanimate, 5011 int is_cmd, 5012 void *rettv) 5013 { 5014 int idx; 5015 cstack_T *cstack = eap->cstack; 5016 5017 if (reanimate) 5018 // Undo the return. 5019 current_funccal->returned = FALSE; 5020 5021 /* 5022 * Cleanup (and inactivate) conditionals, but stop when a try conditional 5023 * not in its finally clause (which then is to be executed next) is found. 5024 * In this case, make the ":return" pending for execution at the ":endtry". 5025 * Otherwise, return normally. 5026 */ 5027 idx = cleanup_conditionals(eap->cstack, 0, TRUE); 5028 if (idx >= 0) 5029 { 5030 cstack->cs_pending[idx] = CSTP_RETURN; 5031 5032 if (!is_cmd && !reanimate) 5033 // A pending return again gets pending. "rettv" points to an 5034 // allocated variable with the rettv of the original ":return"'s 5035 // argument if present or is NULL else. 5036 cstack->cs_rettv[idx] = rettv; 5037 else 5038 { 5039 // When undoing a return in order to make it pending, get the stored 5040 // return rettv. 5041 if (reanimate) 5042 rettv = current_funccal->rettv; 5043 5044 if (rettv != NULL) 5045 { 5046 // Store the value of the pending return. 5047 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL) 5048 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv; 5049 else 5050 emsg(_(e_out_of_memory)); 5051 } 5052 else 5053 cstack->cs_rettv[idx] = NULL; 5054 5055 if (reanimate) 5056 { 5057 // The pending return value could be overwritten by a ":return" 5058 // without argument in a finally clause; reset the default 5059 // return value. 5060 current_funccal->rettv->v_type = VAR_NUMBER; 5061 current_funccal->rettv->vval.v_number = 0; 5062 } 5063 } 5064 report_make_pending(CSTP_RETURN, rettv); 5065 } 5066 else 5067 { 5068 current_funccal->returned = TRUE; 5069 5070 // If the return is carried out now, store the return value. For 5071 // a return immediately after reanimation, the value is already 5072 // there. 5073 if (!reanimate && rettv != NULL) 5074 { 5075 clear_tv(current_funccal->rettv); 5076 *current_funccal->rettv = *(typval_T *)rettv; 5077 if (!is_cmd) 5078 vim_free(rettv); 5079 } 5080 } 5081 5082 return idx < 0; 5083 } 5084 5085 /* 5086 * Free the variable with a pending return value. 5087 */ 5088 void 5089 discard_pending_return(void *rettv) 5090 { 5091 free_tv((typval_T *)rettv); 5092 } 5093 5094 /* 5095 * Generate a return command for producing the value of "rettv". The result 5096 * is an allocated string. Used by report_pending() for verbose messages. 5097 */ 5098 char_u * 5099 get_return_cmd(void *rettv) 5100 { 5101 char_u *s = NULL; 5102 char_u *tofree = NULL; 5103 char_u numbuf[NUMBUFLEN]; 5104 5105 if (rettv != NULL) 5106 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0); 5107 if (s == NULL) 5108 s = (char_u *)""; 5109 5110 STRCPY(IObuff, ":return "); 5111 STRNCPY(IObuff + 8, s, IOSIZE - 8); 5112 if (STRLEN(s) + 8 >= IOSIZE) 5113 STRCPY(IObuff + IOSIZE - 4, "..."); 5114 vim_free(tofree); 5115 return vim_strsave(IObuff); 5116 } 5117 5118 /* 5119 * Get next function line. 5120 * Called by do_cmdline() to get the next line. 5121 * Returns allocated string, or NULL for end of function. 5122 */ 5123 char_u * 5124 get_func_line( 5125 int c UNUSED, 5126 void *cookie, 5127 int indent UNUSED, 5128 getline_opt_T options UNUSED) 5129 { 5130 funccall_T *fcp = (funccall_T *)cookie; 5131 ufunc_T *fp = fcp->func; 5132 char_u *retval; 5133 garray_T *gap; // growarray with function lines 5134 5135 // If breakpoints have been added/deleted need to check for it. 5136 if (fcp->dbg_tick != debug_tick) 5137 { 5138 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, 5139 SOURCING_LNUM); 5140 fcp->dbg_tick = debug_tick; 5141 } 5142 #ifdef FEAT_PROFILE 5143 if (do_profiling == PROF_YES) 5144 func_line_end(cookie); 5145 #endif 5146 5147 gap = &fp->uf_lines; 5148 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try()) 5149 || fcp->returned) 5150 retval = NULL; 5151 else 5152 { 5153 // Skip NULL lines (continuation lines). 5154 while (fcp->linenr < gap->ga_len 5155 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL) 5156 ++fcp->linenr; 5157 if (fcp->linenr >= gap->ga_len) 5158 retval = NULL; 5159 else 5160 { 5161 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]); 5162 SOURCING_LNUM = fcp->linenr; 5163 #ifdef FEAT_PROFILE 5164 if (do_profiling == PROF_YES) 5165 func_line_start(cookie, SOURCING_LNUM); 5166 #endif 5167 } 5168 } 5169 5170 // Did we encounter a breakpoint? 5171 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM) 5172 { 5173 dbg_breakpoint(fp->uf_name, SOURCING_LNUM); 5174 // Find next breakpoint. 5175 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, 5176 SOURCING_LNUM); 5177 fcp->dbg_tick = debug_tick; 5178 } 5179 5180 return retval; 5181 } 5182 5183 /* 5184 * Return TRUE if the currently active function should be ended, because a 5185 * return was encountered or an error occurred. Used inside a ":while". 5186 */ 5187 int 5188 func_has_ended(void *cookie) 5189 { 5190 funccall_T *fcp = (funccall_T *)cookie; 5191 5192 // Ignore the "abort" flag if the abortion behavior has been changed due to 5193 // an error inside a try conditional. 5194 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try()) 5195 || fcp->returned); 5196 } 5197 5198 /* 5199 * return TRUE if cookie indicates a function which "abort"s on errors. 5200 */ 5201 int 5202 func_has_abort( 5203 void *cookie) 5204 { 5205 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT; 5206 } 5207 5208 5209 /* 5210 * Turn "dict.Func" into a partial for "Func" bound to "dict". 5211 * Don't do this when "Func" is already a partial that was bound 5212 * explicitly (pt_auto is FALSE). 5213 * Changes "rettv" in-place. 5214 * Returns the updated "selfdict_in". 5215 */ 5216 dict_T * 5217 make_partial(dict_T *selfdict_in, typval_T *rettv) 5218 { 5219 char_u *fname; 5220 char_u *tofree = NULL; 5221 ufunc_T *fp; 5222 char_u fname_buf[FLEN_FIXED + 1]; 5223 int error; 5224 dict_T *selfdict = selfdict_in; 5225 5226 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL) 5227 fp = rettv->vval.v_partial->pt_func; 5228 else 5229 { 5230 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string 5231 : rettv->vval.v_partial->pt_name; 5232 // Translate "s:func" to the stored function name. 5233 fname = fname_trans_sid(fname, fname_buf, &tofree, &error); 5234 fp = find_func(fname, FALSE, NULL); 5235 vim_free(tofree); 5236 } 5237 5238 if (fp != NULL && (fp->uf_flags & FC_DICT)) 5239 { 5240 partial_T *pt = ALLOC_CLEAR_ONE(partial_T); 5241 5242 if (pt != NULL) 5243 { 5244 pt->pt_refcount = 1; 5245 pt->pt_dict = selfdict; 5246 pt->pt_auto = TRUE; 5247 selfdict = NULL; 5248 if (rettv->v_type == VAR_FUNC) 5249 { 5250 // Just a function: Take over the function name and use 5251 // selfdict. 5252 pt->pt_name = rettv->vval.v_string; 5253 } 5254 else 5255 { 5256 partial_T *ret_pt = rettv->vval.v_partial; 5257 int i; 5258 5259 // Partial: copy the function name, use selfdict and copy 5260 // args. Can't take over name or args, the partial might 5261 // be referenced elsewhere. 5262 if (ret_pt->pt_name != NULL) 5263 { 5264 pt->pt_name = vim_strsave(ret_pt->pt_name); 5265 func_ref(pt->pt_name); 5266 } 5267 else 5268 { 5269 pt->pt_func = ret_pt->pt_func; 5270 func_ptr_ref(pt->pt_func); 5271 } 5272 if (ret_pt->pt_argc > 0) 5273 { 5274 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc); 5275 if (pt->pt_argv == NULL) 5276 // out of memory: drop the arguments 5277 pt->pt_argc = 0; 5278 else 5279 { 5280 pt->pt_argc = ret_pt->pt_argc; 5281 for (i = 0; i < pt->pt_argc; i++) 5282 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]); 5283 } 5284 } 5285 partial_unref(ret_pt); 5286 } 5287 rettv->v_type = VAR_PARTIAL; 5288 rettv->vval.v_partial = pt; 5289 } 5290 } 5291 return selfdict; 5292 } 5293 5294 /* 5295 * Return the name of the executed function. 5296 */ 5297 char_u * 5298 func_name(void *cookie) 5299 { 5300 return ((funccall_T *)cookie)->func->uf_name; 5301 } 5302 5303 /* 5304 * Return the address holding the next breakpoint line for a funccall cookie. 5305 */ 5306 linenr_T * 5307 func_breakpoint(void *cookie) 5308 { 5309 return &((funccall_T *)cookie)->breakpoint; 5310 } 5311 5312 /* 5313 * Return the address holding the debug tick for a funccall cookie. 5314 */ 5315 int * 5316 func_dbg_tick(void *cookie) 5317 { 5318 return &((funccall_T *)cookie)->dbg_tick; 5319 } 5320 5321 /* 5322 * Return the nesting level for a funccall cookie. 5323 */ 5324 int 5325 func_level(void *cookie) 5326 { 5327 return ((funccall_T *)cookie)->level; 5328 } 5329 5330 /* 5331 * Return TRUE when a function was ended by a ":return" command. 5332 */ 5333 int 5334 current_func_returned(void) 5335 { 5336 return current_funccal->returned; 5337 } 5338 5339 int 5340 free_unref_funccal(int copyID, int testing) 5341 { 5342 int did_free = FALSE; 5343 int did_free_funccal = FALSE; 5344 funccall_T *fc, **pfc; 5345 5346 for (pfc = &previous_funccal; *pfc != NULL; ) 5347 { 5348 if (can_free_funccal(*pfc, copyID)) 5349 { 5350 fc = *pfc; 5351 *pfc = fc->caller; 5352 free_funccal_contents(fc); 5353 did_free = TRUE; 5354 did_free_funccal = TRUE; 5355 } 5356 else 5357 pfc = &(*pfc)->caller; 5358 } 5359 if (did_free_funccal) 5360 // When a funccal was freed some more items might be garbage 5361 // collected, so run again. 5362 (void)garbage_collect(testing); 5363 5364 return did_free; 5365 } 5366 5367 /* 5368 * Get function call environment based on backtrace debug level 5369 */ 5370 static funccall_T * 5371 get_funccal(void) 5372 { 5373 int i; 5374 funccall_T *funccal; 5375 funccall_T *temp_funccal; 5376 5377 funccal = current_funccal; 5378 if (debug_backtrace_level > 0) 5379 { 5380 for (i = 0; i < debug_backtrace_level; i++) 5381 { 5382 temp_funccal = funccal->caller; 5383 if (temp_funccal) 5384 funccal = temp_funccal; 5385 else 5386 // backtrace level overflow. reset to max 5387 debug_backtrace_level = i; 5388 } 5389 } 5390 return funccal; 5391 } 5392 5393 /* 5394 * Return the hashtable used for local variables in the current funccal. 5395 * Return NULL if there is no current funccal. 5396 */ 5397 hashtab_T * 5398 get_funccal_local_ht() 5399 { 5400 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0) 5401 return NULL; 5402 return &get_funccal()->l_vars.dv_hashtab; 5403 } 5404 5405 /* 5406 * Return the l: scope variable. 5407 * Return NULL if there is no current funccal. 5408 */ 5409 dictitem_T * 5410 get_funccal_local_var() 5411 { 5412 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0) 5413 return NULL; 5414 return &get_funccal()->l_vars_var; 5415 } 5416 5417 /* 5418 * Return the hashtable used for argument in the current funccal. 5419 * Return NULL if there is no current funccal. 5420 */ 5421 hashtab_T * 5422 get_funccal_args_ht() 5423 { 5424 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0) 5425 return NULL; 5426 return &get_funccal()->l_avars.dv_hashtab; 5427 } 5428 5429 /* 5430 * Return the a: scope variable. 5431 * Return NULL if there is no current funccal. 5432 */ 5433 dictitem_T * 5434 get_funccal_args_var() 5435 { 5436 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0) 5437 return NULL; 5438 return &get_funccal()->l_avars_var; 5439 } 5440 5441 /* 5442 * List function variables, if there is a function. 5443 */ 5444 void 5445 list_func_vars(int *first) 5446 { 5447 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0) 5448 list_hashtable_vars(¤t_funccal->l_vars.dv_hashtab, 5449 "l:", FALSE, first); 5450 } 5451 5452 /* 5453 * If "ht" is the hashtable for local variables in the current funccal, return 5454 * the dict that contains it. 5455 * Otherwise return NULL. 5456 */ 5457 dict_T * 5458 get_current_funccal_dict(hashtab_T *ht) 5459 { 5460 if (current_funccal != NULL 5461 && ht == ¤t_funccal->l_vars.dv_hashtab) 5462 return ¤t_funccal->l_vars; 5463 return NULL; 5464 } 5465 5466 /* 5467 * Search hashitem in parent scope. 5468 */ 5469 hashitem_T * 5470 find_hi_in_scoped_ht(char_u *name, hashtab_T **pht) 5471 { 5472 funccall_T *old_current_funccal = current_funccal; 5473 hashtab_T *ht; 5474 hashitem_T *hi = NULL; 5475 char_u *varname; 5476 5477 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL) 5478 return NULL; 5479 5480 // Search in parent scope, which can be referenced from a lambda. 5481 current_funccal = current_funccal->func->uf_scoped; 5482 while (current_funccal != NULL) 5483 { 5484 ht = find_var_ht(name, &varname); 5485 if (ht != NULL && *varname != NUL) 5486 { 5487 hi = hash_find(ht, varname); 5488 if (!HASHITEM_EMPTY(hi)) 5489 { 5490 *pht = ht; 5491 break; 5492 } 5493 } 5494 if (current_funccal == current_funccal->func->uf_scoped) 5495 break; 5496 current_funccal = current_funccal->func->uf_scoped; 5497 } 5498 current_funccal = old_current_funccal; 5499 5500 return hi; 5501 } 5502 5503 /* 5504 * Search variable in parent scope. 5505 */ 5506 dictitem_T * 5507 find_var_in_scoped_ht(char_u *name, int no_autoload) 5508 { 5509 dictitem_T *v = NULL; 5510 funccall_T *old_current_funccal = current_funccal; 5511 hashtab_T *ht; 5512 char_u *varname; 5513 5514 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL) 5515 return NULL; 5516 5517 // Search in parent scope which is possible to reference from lambda 5518 current_funccal = current_funccal->func->uf_scoped; 5519 while (current_funccal) 5520 { 5521 ht = find_var_ht(name, &varname); 5522 if (ht != NULL && *varname != NUL) 5523 { 5524 v = find_var_in_ht(ht, *name, varname, no_autoload); 5525 if (v != NULL) 5526 break; 5527 } 5528 if (current_funccal == current_funccal->func->uf_scoped) 5529 break; 5530 current_funccal = current_funccal->func->uf_scoped; 5531 } 5532 current_funccal = old_current_funccal; 5533 5534 return v; 5535 } 5536 5537 /* 5538 * Set "copyID + 1" in previous_funccal and callers. 5539 */ 5540 int 5541 set_ref_in_previous_funccal(int copyID) 5542 { 5543 funccall_T *fc; 5544 5545 for (fc = previous_funccal; fc != NULL; fc = fc->caller) 5546 { 5547 fc->fc_copyID = copyID + 1; 5548 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL) 5549 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL) 5550 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL)) 5551 return TRUE; 5552 } 5553 return FALSE; 5554 } 5555 5556 static int 5557 set_ref_in_funccal(funccall_T *fc, int copyID) 5558 { 5559 if (fc->fc_copyID != copyID) 5560 { 5561 fc->fc_copyID = copyID; 5562 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL) 5563 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL) 5564 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL) 5565 || set_ref_in_func(NULL, fc->func, copyID)) 5566 return TRUE; 5567 } 5568 return FALSE; 5569 } 5570 5571 /* 5572 * Set "copyID" in all local vars and arguments in the call stack. 5573 */ 5574 int 5575 set_ref_in_call_stack(int copyID) 5576 { 5577 funccall_T *fc; 5578 funccal_entry_T *entry; 5579 5580 for (fc = current_funccal; fc != NULL; fc = fc->caller) 5581 if (set_ref_in_funccal(fc, copyID)) 5582 return TRUE; 5583 5584 // Also go through the funccal_stack. 5585 for (entry = funccal_stack; entry != NULL; entry = entry->next) 5586 for (fc = entry->top_funccal; fc != NULL; fc = fc->caller) 5587 if (set_ref_in_funccal(fc, copyID)) 5588 return TRUE; 5589 return FALSE; 5590 } 5591 5592 /* 5593 * Set "copyID" in all functions available by name. 5594 */ 5595 int 5596 set_ref_in_functions(int copyID) 5597 { 5598 int todo; 5599 hashitem_T *hi = NULL; 5600 ufunc_T *fp; 5601 5602 todo = (int)func_hashtab.ht_used; 5603 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi) 5604 { 5605 if (!HASHITEM_EMPTY(hi)) 5606 { 5607 --todo; 5608 fp = HI2UF(hi); 5609 if (!func_name_refcount(fp->uf_name) 5610 && set_ref_in_func(NULL, fp, copyID)) 5611 return TRUE; 5612 } 5613 } 5614 return FALSE; 5615 } 5616 5617 /* 5618 * Set "copyID" in all function arguments. 5619 */ 5620 int 5621 set_ref_in_func_args(int copyID) 5622 { 5623 int i; 5624 5625 for (i = 0; i < funcargs.ga_len; ++i) 5626 if (set_ref_in_item(((typval_T **)funcargs.ga_data)[i], 5627 copyID, NULL, NULL)) 5628 return TRUE; 5629 return FALSE; 5630 } 5631 5632 /* 5633 * Mark all lists and dicts referenced through function "name" with "copyID". 5634 * Returns TRUE if setting references failed somehow. 5635 */ 5636 int 5637 set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID) 5638 { 5639 ufunc_T *fp = fp_in; 5640 funccall_T *fc; 5641 int error = FCERR_NONE; 5642 char_u fname_buf[FLEN_FIXED + 1]; 5643 char_u *tofree = NULL; 5644 char_u *fname; 5645 int abort = FALSE; 5646 5647 if (name == NULL && fp_in == NULL) 5648 return FALSE; 5649 5650 if (fp_in == NULL) 5651 { 5652 fname = fname_trans_sid(name, fname_buf, &tofree, &error); 5653 fp = find_func(fname, FALSE, NULL); 5654 } 5655 if (fp != NULL) 5656 { 5657 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped) 5658 abort = abort || set_ref_in_funccal(fc, copyID); 5659 } 5660 5661 vim_free(tofree); 5662 return abort; 5663 } 5664 5665 #endif // FEAT_EVAL 5666