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