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