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